@opencrvs/toolkit 2.0.0-rc.ff99998 → 2.1.0-rc.0066f38

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 (108) hide show
  1. package/README.md +15 -0
  2. package/build.sh +5 -4
  3. package/create-countryconfig/package.json +1 -1
  4. package/dist/application-config/index.js +36 -7
  5. package/dist/cli.js +3186 -4921
  6. package/dist/commons/api/router.d.ts +634 -22
  7. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  8. package/dist/commons/events/ActionConfig.d.ts +237 -2
  9. package/dist/commons/events/ActionDocument.d.ts +44 -0
  10. package/dist/commons/events/ActionInput.d.ts +26 -0
  11. package/dist/commons/events/ActionType.d.ts +6 -1
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +18 -0
  13. package/dist/commons/events/AuditLog.d.ts +2 -0
  14. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  15. package/dist/commons/events/Draft.d.ts +2 -0
  16. package/dist/commons/events/EventConfig.d.ts +2 -0
  17. package/dist/commons/events/EventDocument.d.ts +22 -0
  18. package/dist/commons/events/EventIndex.d.ts +25 -0
  19. package/dist/commons/events/EventMetadata.d.ts +26 -0
  20. package/dist/commons/events/FieldConfig.d.ts +16 -0
  21. package/dist/commons/events/FieldType.d.ts +1 -0
  22. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  23. package/dist/commons/events/WorkqueueConfig.d.ts +44 -2
  24. package/dist/commons/events/locations.d.ts +1 -0
  25. package/dist/commons/events/scopes.d.ts +1 -0
  26. package/dist/commons/events/state/index.d.ts +8 -0
  27. package/dist/commons/events/state/utils.d.ts +9 -0
  28. package/dist/commons/events/test.utils.d.ts +9 -1
  29. package/dist/commons/events/utils.d.ts +23 -1
  30. package/dist/conditionals/index.js +12 -5
  31. package/dist/environment/custom-types.d.ts +33 -0
  32. package/dist/environment/custom-types.d.ts.map +1 -0
  33. package/dist/environment/custom-types.js +12 -0
  34. package/dist/environment/derived-variables.d.ts +134 -0
  35. package/dist/environment/derived-variables.d.ts.map +1 -0
  36. package/dist/environment/derived-variables.js +169 -0
  37. package/dist/environment/editor-questions.d.ts +4 -0
  38. package/dist/environment/editor-questions.d.ts.map +1 -0
  39. package/dist/environment/editor-questions.js +67 -0
  40. package/dist/environment/git.d.ts +5 -0
  41. package/dist/environment/git.d.ts.map +1 -0
  42. package/dist/environment/git.js +38 -0
  43. package/dist/environment/github.d.ts +26 -0
  44. package/dist/environment/github.d.ts.map +1 -0
  45. package/dist/environment/github.js +247 -0
  46. package/dist/environment/index.d.ts +5 -0
  47. package/dist/environment/index.d.ts.map +1 -0
  48. package/dist/environment/index.js +71 -0
  49. package/dist/environment/logger.d.ts +15 -0
  50. package/dist/environment/logger.d.ts.map +1 -0
  51. package/dist/environment/logger.js +25 -0
  52. package/dist/environment/manage-users.d.ts +11 -0
  53. package/dist/environment/manage-users.d.ts.map +1 -0
  54. package/dist/environment/manage-users.js +497 -0
  55. package/dist/environment/questions-helper.d.ts +15 -0
  56. package/dist/environment/questions-helper.d.ts.map +1 -0
  57. package/dist/environment/questions-helper.js +70 -0
  58. package/dist/environment/questions.d.ts +199 -0
  59. package/dist/environment/questions.d.ts.map +1 -0
  60. package/dist/environment/questions.js +412 -0
  61. package/dist/environment/setup-environment.d.ts +2 -0
  62. package/dist/environment/setup-environment.d.ts.map +1 -0
  63. package/dist/environment/setup-environment.js +794 -0
  64. package/dist/environment/ssh-keygen.d.ts +5 -0
  65. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  66. package/dist/environment/ssh-keygen.js +21 -0
  67. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  68. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  69. package/dist/environment/swarm-to-k8s.js +173 -0
  70. package/dist/environment/templates.d.ts +27 -0
  71. package/dist/environment/templates.d.ts.map +1 -0
  72. package/dist/environment/templates.js +163 -0
  73. package/dist/environment/update-workflows.d.ts +2 -0
  74. package/dist/environment/update-workflows.d.ts.map +1 -0
  75. package/dist/environment/update-workflows.js +169 -0
  76. package/dist/environment/users.d.ts +2 -0
  77. package/dist/environment/users.d.ts.map +1 -0
  78. package/dist/environment/users.js +112 -0
  79. package/dist/environment/utils.d.ts +18 -0
  80. package/dist/environment/utils.d.ts.map +1 -0
  81. package/dist/environment/utils.js +100 -0
  82. package/dist/events/index.js +379 -89
  83. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  84. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  85. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  86. package/dist/migrations/v2.0/index.js +88 -5139
  87. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  88. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  89. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  90. package/dist/migrations/v2.1/index.d.ts +6 -0
  91. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  92. package/dist/migrations/v2.1/index.js +218 -0
  93. package/dist/notification/index.js +250 -22
  94. package/dist/scopes/index.d.ts +96 -2
  95. package/dist/scopes/index.js +12 -5
  96. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  97. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  98. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  99. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  100. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  101. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  102. package/dist/templates/inventory/inventory.template.yml +100 -0
  103. package/dist/templates/inventory/production.example.yml +77 -0
  104. package/dist/templates/inventory/qa.example.yml +48 -0
  105. package/opencrvs-toolkit-2.1.0-rc.0066f38.tgz +0 -0
  106. package/package.json +15 -1
  107. package/tsconfig.tsbuildinfo +1 -1
  108. package/opencrvs-toolkit-2.0.0-rc.ff99998.tgz +0 -0
package/README.md CHANGED
@@ -14,6 +14,21 @@ src/
14
14
 
15
15
  ## Getting started
16
16
 
17
+ ### Manage GitHub environments
18
+
19
+ All commands should be executed within infrastructure repository.
20
+
21
+ Run `opencrvs environment init` from the root of a infrastructure
22
+ repository to create new GitHub environment. Command requires valid GitHub token.
23
+
24
+ Other environment operations are available as separate commands:
25
+
26
+ ```sh
27
+ opencrvs environment update-workflows
28
+ opencrvs environment users
29
+ opencrvs environment swarm-to-k8s
30
+ ```
31
+
17
32
  ### Development using yarn link
18
33
 
19
34
  ```
package/build.sh CHANGED
@@ -1,3 +1,5 @@
1
+ #!/bin/bash
2
+
1
3
  # This Source Code Form is subject to the terms of the Mozilla Public
2
4
  # License, v. 2.0. If a copy of the MPL was not distributed with this
3
5
  # file, You can obtain one at https://mozilla.org/MPL/2.0/.
@@ -7,8 +9,6 @@
7
9
  #
8
10
  # Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
9
11
 
10
- #!/bin/bash
11
-
12
12
  set -e
13
13
 
14
14
  rm -rf dist
@@ -51,8 +51,8 @@ mkdir -p ./dist/commons/application-config
51
51
  cp -r ../commons/build/dist/common/application-config.d.ts ./dist/commons/application-config/index.d.ts
52
52
 
53
53
  # Build migration CLI
54
- npx esbuild src/migrations/v2.0/index.ts --bundle --format=cjs --outdir=./dist/migrations/v2.0 --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
55
- chmod +x ./dist/migrations/v2.0/index.js
54
+ npx esbuild src/migrations/v2.1/index.ts --bundle --format=cjs --outdir=./dist/migrations/v2.1 --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
55
+ chmod +x ./dist/migrations/v2.1/index.js
56
56
 
57
57
  if [[ "$OSTYPE" == "darwin"* ]]; then
58
58
  sed -i '' 's|@opencrvs/events/build/types|../commons/api|g' dist/api/index.d.ts
@@ -64,6 +64,7 @@ fi
64
64
 
65
65
  # Build CLI
66
66
  npx esbuild src/cli.ts --bundle --format=cjs --outdir=./dist --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
67
+ cp -R src/environment/templates dist/templates
67
68
  chmod +x ./dist/cli.js
68
69
 
69
70
  echo "Build completed successfully."
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/create-countryconfig",
3
- "version": "1.0.0",
3
+ "version": "2.1.0",
4
4
  "description": "Scaffold a new OpenCRVS country configuration",
5
5
  "bin": {
6
6
  "create-countryconfig": "./index.js"
@@ -206,6 +206,11 @@ var FieldTypesToHideInReview = [
206
206
  FieldType.ALPHA_PRINT_BUTTON,
207
207
  FieldType.ALPHA_HIDDEN
208
208
  ];
209
+ var HiddenFieldTypes = [
210
+ FieldType.HTTP,
211
+ FieldType.QUERY_PARAM_READER,
212
+ FieldType.ALPHA_HIDDEN
213
+ ];
209
214
 
210
215
  // ../commons/src/events/FieldValue.ts
211
216
  var z7 = __toESM(require("zod/v4"));
@@ -324,7 +329,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
324
329
  // ../commons/src/events/FieldValue.ts
325
330
  var TextValue = z7.string();
326
331
  var HiddenFieldValue = z7.string();
327
- var NonEmptyTextValue = TextValue.min(1);
332
+ var NonEmptyTextValue = z7.string().trim().min(1);
328
333
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
329
334
  var AgeValue = z7.object({
330
335
  age: z7.number(),
@@ -515,6 +520,7 @@ var ActionType = {
515
520
  MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE",
516
521
  MARK_AS_NOT_DUPLICATE: "MARK_AS_NOT_DUPLICATE",
517
522
  ARCHIVE: "ARCHIVE",
523
+ UNARCHIVE: "UNARCHIVE",
518
524
  // Record actions
519
525
  PRINT_CERTIFICATE: "PRINT_CERTIFICATE",
520
526
  REQUEST_CORRECTION: "REQUEST_CORRECTION",
@@ -534,6 +540,7 @@ var ConfirmableActions = [
534
540
  ActionType.REGISTER,
535
541
  ActionType.REJECT,
536
542
  ActionType.ARCHIVE,
543
+ ActionType.UNARCHIVE,
537
544
  ActionType.PRINT_CERTIFICATE,
538
545
  ActionType.REQUEST_CORRECTION,
539
546
  ActionType.APPROVE_CORRECTION,
@@ -552,6 +559,7 @@ var ActionTypes = z10.enum([
552
559
  "MARK_AS_DUPLICATE",
553
560
  "MARK_AS_NOT_DUPLICATE",
554
561
  "ARCHIVE",
562
+ "UNARCHIVE",
555
563
  "PRINT_CERTIFICATE",
556
564
  "REQUEST_CORRECTION",
557
565
  "REJECT_CORRECTION",
@@ -592,6 +600,7 @@ var WorkqueueActionType = ActionTypes.extract([
592
600
  ActionType.REJECT,
593
601
  ActionType.MARK_AS_DUPLICATE,
594
602
  ActionType.ARCHIVE,
603
+ ActionType.UNARCHIVE,
595
604
  ActionType.PRINT_CERTIFICATE,
596
605
  ActionType.REQUEST_CORRECTION
597
606
  ]);
@@ -621,6 +630,7 @@ var RecordScopeTypeV2 = z11.enum([
621
630
  "record.edit",
622
631
  "record.reject",
623
632
  "record.archive",
633
+ "record.unarchive",
624
634
  "record.review-duplicates",
625
635
  "record.register",
626
636
  "record.print-certified-copies",
@@ -660,11 +670,13 @@ var scopeOptionsPlaceEvent = z11.object({
660
670
  event: scopeByEvent,
661
671
  placeOfEvent: JurisdictionFilter.optional()
662
672
  }).describe("Options applicable to all record scopes.");
663
- var scopeOptionsDeclared = scopeOptionsPlaceEvent.extend({
673
+ var scopeOptionsDeclaredOrNotified = scopeOptionsPlaceEvent.extend({
674
+ notifiedIn: JurisdictionFilter.optional(),
675
+ notifiedBy: UserFilter.optional(),
664
676
  declaredIn: JurisdictionFilter.optional(),
665
677
  declaredBy: UserFilter.optional()
666
678
  }).describe("Options applicable to actions that may take place after DECLARE");
667
- var AllRecordScopeOptions = scopeOptionsDeclared.extend({
679
+ var AllRecordScopeOptions = scopeOptionsDeclaredOrNotified.extend({
668
680
  registeredIn: JurisdictionFilter.optional(),
669
681
  registeredBy: UserFilter.optional()
670
682
  }).describe(
@@ -702,6 +714,8 @@ var ResolvedScopeOptionsPlaceEvent = z11.object({
702
714
  "Resolved options applicable to all record scopes, with location ID instead of jurisdiction filter."
703
715
  );
704
716
  var ResolvedScopeOptionsDeclared = ResolvedScopeOptionsPlaceEvent.extend({
717
+ notifiedIn: UUID.nullish(),
718
+ notifiedBy: z11.string().optional(),
705
719
  declaredIn: UUID.nullish(),
706
720
  declaredBy: z11.string().optional()
707
721
  }).describe(
@@ -722,6 +736,7 @@ var ScopesWithDeclaredOptions = RecordScopeTypeV2.extract([
722
736
  "record.edit",
723
737
  "record.reject",
724
738
  "record.archive",
739
+ "record.unarchive",
725
740
  "record.review-duplicates",
726
741
  "record.register"
727
742
  ]);
@@ -747,7 +762,7 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
747
762
  }),
748
763
  z11.object({
749
764
  type: ScopesWithDeclaredOptions,
750
- options: scopeOptionsDeclared.optional()
765
+ options: scopeOptionsDeclaredOrNotified.optional()
751
766
  }),
752
767
  z11.object({
753
768
  type: ScopesWithFullOptions,
@@ -836,8 +851,9 @@ var EncodedScope = z11.string().brand("EncodedScope");
836
851
  var DEFAULT_SCOPE_OPTIONS = {
837
852
  placeOfEvent: JurisdictionFilter.enum.all,
838
853
  accessLevel: JurisdictionFilter.enum.all,
839
- registeredIn: JurisdictionFilter.enum.all,
840
- declaredIn: JurisdictionFilter.enum.all
854
+ notifiedIn: JurisdictionFilter.enum.all,
855
+ declaredIn: JurisdictionFilter.enum.all,
856
+ registeredIn: JurisdictionFilter.enum.all
841
857
  };
842
858
 
843
859
  // ../commons/src/authentication.ts
@@ -955,6 +971,11 @@ var ArchiveAction = ActionBase.extend(
955
971
  content: ReasonContent
956
972
  }).shape
957
973
  );
974
+ var UnarchiveAction = ActionBase.extend(
975
+ z13.object({
976
+ type: z13.literal(ActionType.UNARCHIVE)
977
+ }).shape
978
+ );
958
979
  var CreatedAction = ActionBase.extend(
959
980
  z13.object({
960
981
  type: z13.literal(ActionType.CREATE)
@@ -1021,6 +1042,7 @@ var ActionDocument = z13.discriminatedUnion("type", [
1021
1042
  MarkNotDuplicateAction.meta({ id: "MarkNotDuplicateAction" }),
1022
1043
  MarkAsDuplicateAction.meta({ id: "MarkAsDuplicateAction" }),
1023
1044
  ArchiveAction.meta({ id: "ArchiveAction" }),
1045
+ UnarchiveAction.meta({ id: "UnarchiveAction" }),
1024
1046
  NotifiedAction.meta({ id: "NotifiedAction" }),
1025
1047
  RegisterAction.meta({ id: "RegisterAction" }),
1026
1048
  DeclareAction.meta({ id: "DeclareAction" }),
@@ -1126,6 +1148,7 @@ var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1126
1148
  )
1127
1149
  });
1128
1150
  var LegalStatuses = z15.object({
1151
+ [EventStatus.enum.NOTIFIED]: ActionCreationMetadata.nullish(),
1129
1152
  [EventStatus.enum.DECLARED]: ActionCreationMetadata.nullish(),
1130
1153
  [EventStatus.enum.REGISTERED]: RegistrationCreationMetadata.nullish()
1131
1154
  });
@@ -1185,6 +1208,8 @@ var EventMetadataKeys = z15.enum(EventMetadataKeysArray);
1185
1208
  var EventMetadataDateFieldIdInput = z15.enum([
1186
1209
  "createdAt",
1187
1210
  "updatedAt",
1211
+ "legalStatuses.NOTIFIED.createdAt",
1212
+ "legalStatuses.NOTIFIED.acceptedAt",
1188
1213
  "legalStatuses.DECLARED.createdAt",
1189
1214
  "legalStatuses.DECLARED.acceptedAt",
1190
1215
  "legalStatuses.REGISTERED.createdAt",
@@ -1193,6 +1218,8 @@ var EventMetadataDateFieldIdInput = z15.enum([
1193
1218
  var EventMetadataDateFieldId = z15.enum([
1194
1219
  "event.createdAt",
1195
1220
  "event.updatedAt",
1221
+ "event.legalStatuses.NOTIFIED.createdAt",
1222
+ "event.legalStatuses.NOTIFIED.acceptedAt",
1196
1223
  "event.legalStatuses.DECLARED.createdAt",
1197
1224
  "event.legalStatuses.DECLARED.acceptedAt",
1198
1225
  "event.legalStatuses.REGISTERED.createdAt",
@@ -1255,7 +1282,8 @@ var Range = import_v4.z.object({
1255
1282
  });
1256
1283
  var ContainsFlags = import_v4.z.object({
1257
1284
  anyOf: import_v4.z.array(Flag).optional(),
1258
- noneOf: import_v4.z.array(Flag).optional()
1285
+ noneOf: import_v4.z.array(Flag).optional(),
1286
+ allOf: import_v4.z.array(Flag).optional()
1259
1287
  }).meta({
1260
1288
  id: "ContainsFlags"
1261
1289
  });
@@ -1495,6 +1523,7 @@ var NumberField = BaseField.extend({
1495
1523
  configuration: import_v43.default.object({
1496
1524
  min: import_v43.default.number().optional().describe("Minimum value"),
1497
1525
  max: import_v43.default.number().optional().describe("Maximum value"),
1526
+ integer: import_v43.default.boolean().optional().describe("When true, only whole numbers are allowed"),
1498
1527
  prefix: TranslationConfig.optional(),
1499
1528
  postfix: TranslationConfig.optional()
1500
1529
  }).optional()