@opencrvs/toolkit 2.1.0-rc.ffe0b7f → 2.2.0-rc.9042a13

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 (250) hide show
  1. package/README.md +2 -12
  2. package/build.sh +23 -5
  3. package/create-countryconfig/index.js +441 -59
  4. package/create-countryconfig/node_modules/.bin/degit +21 -0
  5. package/create-countryconfig/package.json +5 -2
  6. package/dist/application-config/index.js +391 -286
  7. package/dist/authentication/index.d.ts +66 -0
  8. package/dist/authentication/index.d.ts.map +1 -0
  9. package/dist/authentication/index.js +778 -0
  10. package/dist/cli.js +2041 -1311
  11. package/dist/commons/api/router.d.ts +2359 -485
  12. package/dist/commons/application-config/index.d.ts +0 -2
  13. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  14. package/dist/commons/conditionals/validate.d.ts +34 -8
  15. package/dist/commons/events/ActionConfig.d.ts +131 -7
  16. package/dist/commons/events/ActionDocument.d.ts +123 -15
  17. package/dist/commons/events/ActionInput.d.ts +56 -4
  18. package/dist/commons/events/ActionStatus.d.ts +14 -0
  19. package/dist/commons/events/ActionType.d.ts +11 -1
  20. package/dist/commons/events/AdvancedSearchConfig.d.ts +60 -12
  21. package/dist/commons/events/AuditLog.d.ts +152 -0
  22. package/dist/commons/events/CountryConfigQueryInput.d.ts +132 -0
  23. package/dist/commons/events/Draft.d.ts +3 -21
  24. package/dist/commons/events/EventConfig.d.ts +29 -6
  25. package/dist/commons/events/EventDocument.d.ts +560 -4
  26. package/dist/commons/events/EventIndex.d.ts +23 -26
  27. package/dist/commons/events/EventMetadata.d.ts +24 -11
  28. package/dist/commons/events/EventStatus.d.ts +20 -0
  29. package/dist/commons/events/FieldConfig.d.ts +119 -63
  30. package/dist/commons/events/FieldTypeMapping.d.ts +17 -17
  31. package/dist/commons/events/FieldValue.d.ts +3 -2
  32. package/dist/commons/events/Flag.d.ts +42 -0
  33. package/dist/commons/events/FormConfig.d.ts +6 -0
  34. package/dist/commons/events/PageConfig.d.ts +4 -0
  35. package/dist/commons/events/PlainDate.d.ts +8 -0
  36. package/dist/commons/events/SummaryConfig.d.ts +249 -0
  37. package/dist/commons/events/WorkqueueConfig.d.ts +167 -20
  38. package/dist/commons/events/event.d.ts +12 -0
  39. package/dist/commons/events/eventConfigValidation.d.ts +17 -1
  40. package/dist/commons/events/index.d.ts +1 -0
  41. package/dist/commons/events/locationPayloads.d.ts +95 -0
  42. package/dist/commons/events/locations.d.ts +169 -26
  43. package/dist/commons/events/mocks.test.utils.d.ts +30 -0
  44. package/dist/commons/events/scopes.d.ts +23 -1
  45. package/dist/commons/events/state/index.d.ts +10 -2
  46. package/dist/commons/events/state/utils.d.ts +11 -1
  47. package/dist/commons/events/test.utils.d.ts +106 -26
  48. package/dist/commons/events/utils.d.ts +81 -18
  49. package/dist/commons/notification/UserNotifications.d.ts +28 -13
  50. package/dist/commons/notification/dispatch.d.ts +10 -0
  51. package/dist/commons/notification/index.d.ts +1 -0
  52. package/dist/conditionals/index.js +362 -65
  53. package/dist/csv.d.ts +25 -0
  54. package/dist/csv.d.ts.map +1 -0
  55. package/dist/csv.js +120 -0
  56. package/dist/environment/derived-variables.d.ts +18 -0
  57. package/dist/environment/derived-variables.d.ts.map +1 -1
  58. package/dist/environment/derived-variables.js +22 -1
  59. package/dist/environment/index.d.ts.map +1 -1
  60. package/dist/environment/index.js +2 -1
  61. package/dist/environment/logger.d.ts +15 -3
  62. package/dist/environment/logger.d.ts.map +1 -1
  63. package/dist/environment/manage-users.js +1 -1
  64. package/dist/environment/questions.d.ts.map +1 -1
  65. package/dist/environment/questions.js +20 -14
  66. package/dist/environment/setup-environment.d.ts +1 -1
  67. package/dist/environment/setup-environment.d.ts.map +1 -1
  68. package/dist/environment/setup-environment.js +610 -560
  69. package/dist/environment/swarm-to-k8s.js +3 -4
  70. package/dist/environment/templates.d.ts +0 -1
  71. package/dist/environment/templates.d.ts.map +1 -1
  72. package/dist/environment/templates.js +3 -8
  73. package/dist/environment/update-workflows.d.ts.map +1 -1
  74. package/dist/environment/update-workflows.js +4 -0
  75. package/dist/environment/utils.d.ts +0 -12
  76. package/dist/environment/utils.d.ts.map +1 -1
  77. package/dist/environment/utils.js +1 -28
  78. package/dist/events/index.js +7909 -7056
  79. package/dist/migrations/add-translations.d.ts +15 -0
  80. package/dist/migrations/add-translations.d.ts.map +1 -0
  81. package/dist/migrations/add-translations.js +151 -0
  82. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  83. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  84. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  85. package/dist/migrations/{v2.0/rename-api-paths.d.ts → v2.1/enable-telemetry.d.ts} +1 -1
  86. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  87. package/dist/migrations/v2.1/enable-telemetry.js +455 -0
  88. package/dist/migrations/v2.1/index.d.ts.map +1 -1
  89. package/dist/migrations/v2.1/index.js +47 -215
  90. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts +17 -0
  91. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts.map +1 -0
  92. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.js +348 -0
  93. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +2 -0
  94. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +1 -0
  95. package/dist/migrations/v2.1/remove-metabase-package-installs.js +161 -0
  96. package/dist/migrations/{v2.0/migrate-scopes.d.ts → v2.1/remove-sentry.d.ts} +1 -1
  97. package/dist/migrations/v2.1/remove-sentry.d.ts.map +1 -0
  98. package/dist/migrations/v2.1/remove-sentry.js +354 -0
  99. package/dist/migrations/{v2.0/create-events-index.d.ts → v2.1/rename-trigger-paths.d.ts} +1 -1
  100. package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +1 -0
  101. package/dist/migrations/{v2.0/rename-api-paths.js → v2.1/rename-trigger-paths.js} +69 -40
  102. package/dist/migrations/v2.1/template-files.d.ts +8 -0
  103. package/dist/migrations/v2.1/template-files.d.ts.map +1 -0
  104. package/dist/migrations/v2.1/template-files.js +49 -0
  105. package/dist/migrations/v2.1/upgrade-tilt.d.ts +11 -0
  106. package/dist/migrations/v2.1/upgrade-tilt.d.ts.map +1 -0
  107. package/dist/migrations/v2.1/upgrade-tilt.js +139 -0
  108. package/dist/migrations/v2.2/index.d.ts +6 -0
  109. package/dist/migrations/v2.2/index.d.ts.map +1 -0
  110. package/dist/migrations/v2.2/index.js +456 -0
  111. package/dist/migrations/v2.2/read-declaration-through-helper.d.ts +39 -0
  112. package/dist/migrations/v2.2/read-declaration-through-helper.d.ts.map +1 -0
  113. package/dist/migrations/v2.2/read-declaration-through-helper.js +257 -0
  114. package/dist/notification/index.js +2090 -1456
  115. package/dist/scopes/index.d.ts +637 -36
  116. package/dist/scopes/index.js +364 -65
  117. package/dist/telemetry/index.d.ts +45 -0
  118. package/dist/telemetry/index.d.ts.map +1 -0
  119. package/dist/telemetry/index.js +43 -0
  120. package/dist/templates/charts-values/dependencies/values.yaml +8 -0
  121. package/dist/templates/charts-values/opencrvs-services/values.yaml +10 -3
  122. package/dist/templates/charts-values/opentelemetry/values.yaml +102 -0
  123. package/dist/templates/charts-values/traefik/values.yaml +25 -12
  124. package/dist/templates/countryconfig-template/.tiltignore +1 -0
  125. package/dist/templates/countryconfig-template/Dockerfile.assets +7 -0
  126. package/dist/templates/countryconfig-template/Tiltfile +112 -0
  127. package/dist/templates/countryconfig-template/assets/README.md +1 -0
  128. package/dist/templates/countryconfig-template/assets/clear-all-data-dev.sh +61 -0
  129. package/dist/templates/countryconfig-template/assets/deployment/deploy.sh +455 -0
  130. package/dist/templates/countryconfig-template/assets/deployment/reindex.sh +168 -0
  131. package/dist/templates/countryconfig-template/assets/deployment/validate-required-variables-in-compose-files.ts +67 -0
  132. package/dist/templates/countryconfig-template/assets/elasticsearch/reindex.sh +168 -0
  133. package/dist/templates/countryconfig-template/assets/metabase/README.md +34 -0
  134. package/dist/templates/countryconfig-template/assets/metabase/environment-configuration.sql +36 -0
  135. package/dist/templates/countryconfig-template/assets/metabase/initialize-database.sh +46 -0
  136. package/dist/templates/countryconfig-template/assets/metabase/metabase.init.db.sql +27737 -0
  137. package/dist/templates/countryconfig-template/assets/metabase/open-shell.sh +21 -0
  138. package/dist/templates/countryconfig-template/assets/metabase/package.json +13 -0
  139. package/dist/templates/countryconfig-template/assets/metabase/run-dev.sh +108 -0
  140. package/dist/templates/countryconfig-template/assets/metabase/run.sh +120 -0
  141. package/dist/templates/countryconfig-template/assets/metabase/update-database.sh +40 -0
  142. package/dist/templates/countryconfig-template/assets/postgres/setup-analytics.sh +135 -0
  143. package/dist/templates/countryconfig-template/assets/postgres/setup-reference-data.sh +108 -0
  144. package/dist/templates/countryconfig-template/tilt/clear-all-data.ps1 +50 -0
  145. package/dist/templates/countryconfig-template/tilt/clear-all-data.sh +35 -0
  146. package/dist/templates/countryconfig-template/tilt/common.tilt +145 -0
  147. package/dist/templates/countryconfig-template/tilt/examples/dependencies/values.yaml +15 -0
  148. package/dist/templates/countryconfig-template/tilt/examples/opencrvs-services/values.yaml +56 -0
  149. package/dist/templates/countryconfig-template/tilt/examples/traefik/values-minikube.yaml +21 -0
  150. package/dist/templates/countryconfig-template/tilt/examples/traefik/values.yaml +38 -0
  151. package/dist/templates/countryconfig-template/tilt/helm/dependencies/values.yaml +17 -0
  152. package/dist/templates/countryconfig-template/tilt/helm/opencrvs-services/values.yaml +16 -0
  153. package/dist/templates/countryconfig-template/tilt/lib.tilt +95 -0
  154. package/dist/templates/countryconfig-template/tilt/opencrvs.tilt +136 -0
  155. package/dist/templates/inventory/inventory.template.yml +1 -3
  156. package/dist/translations/template.d.ts +11 -0
  157. package/dist/translations/template.d.ts.map +1 -0
  158. package/dist/translations/template.js +100 -0
  159. package/dist/verify/endpoints.d.ts +2 -0
  160. package/dist/verify/endpoints.d.ts.map +1 -0
  161. package/dist/verify/endpoints.js +510 -0
  162. package/opencrvs-toolkit-2.2.0-rc.9042a13.tgz +0 -0
  163. package/package.json +13 -7
  164. package/tsconfig.build.json +11 -0
  165. package/tsconfig.build.tsbuildinfo +1 -0
  166. package/tsconfig.json +3 -0
  167. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts +0 -3
  168. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +0 -1
  169. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +0 -429
  170. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +0 -3
  171. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +0 -1
  172. package/dist/migrations/v2.0/add-resend-invite-notification.js +0 -373
  173. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +0 -22
  174. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +0 -1
  175. package/dist/migrations/v2.0/checkout-upstream-files.js +0 -146
  176. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts +0 -2
  177. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +0 -1
  178. package/dist/migrations/v2.0/convert-config-files-to-ts.js +0 -838
  179. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts +0 -3
  180. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +0 -1
  181. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +0 -158
  182. package/dist/migrations/v2.0/create-events-index.d.ts.map +0 -1
  183. package/dist/migrations/v2.0/create-events-index.js +0 -325
  184. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +0 -11
  185. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +0 -1
  186. package/dist/migrations/v2.0/delete-infrastructure-directory.js +0 -123
  187. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +0 -3
  188. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +0 -1
  189. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +0 -110
  190. package/dist/migrations/v2.0/index.d.ts +0 -13
  191. package/dist/migrations/v2.0/index.d.ts.map +0 -1
  192. package/dist/migrations/v2.0/index.js +0 -103
  193. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts +0 -3
  194. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +0 -1
  195. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +0 -432
  196. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +0 -13
  197. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +0 -1
  198. package/dist/migrations/v2.0/merge-infrastructure-directory.js +0 -222
  199. package/dist/migrations/v2.0/migrate-application-config-url.d.ts +0 -3
  200. package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +0 -1
  201. package/dist/migrations/v2.0/migrate-application-config-url.js +0 -343
  202. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +0 -1
  203. package/dist/migrations/v2.0/migrate-scopes.js +0 -305
  204. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts +0 -3
  205. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +0 -1
  206. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +0 -267
  207. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts +0 -3
  208. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +0 -1
  209. package/dist/migrations/v2.0/migrate-workqueue-configs.js +0 -317
  210. package/dist/migrations/v2.0/remove-delete-actions.d.ts +0 -3
  211. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +0 -1
  212. package/dist/migrations/v2.0/remove-delete-actions.js +0 -156
  213. package/dist/migrations/v2.0/remove-demo-scope.d.ts +0 -3
  214. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +0 -1
  215. package/dist/migrations/v2.0/remove-demo-scope.js +0 -74
  216. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts +0 -3
  217. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +0 -1
  218. package/dist/migrations/v2.0/remove-deprecated-imports.js +0 -96
  219. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +0 -3
  220. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +0 -1
  221. package/dist/migrations/v2.0/remove-fhir-url-helpers.js +0 -163
  222. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts +0 -3
  223. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +0 -1
  224. package/dist/migrations/v2.0/remove-hearth-migrations.js +0 -87
  225. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +0 -3
  226. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +0 -1
  227. package/dist/migrations/v2.0/remove-old-statistics-service.js +0 -356
  228. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts +0 -3
  229. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +0 -1
  230. package/dist/migrations/v2.0/remove-pending-certification-flag.js +0 -109
  231. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts +0 -3
  232. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +0 -1
  233. package/dist/migrations/v2.0/remove-review-from-register-action.js +0 -163
  234. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +0 -3
  235. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +0 -1
  236. package/dist/migrations/v2.0/remove-unused-environment-variables.js +0 -186
  237. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +0 -1
  238. package/dist/migrations/v2.0/rename-location-parent-id.d.ts +0 -3
  239. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +0 -1
  240. package/dist/migrations/v2.0/rename-location-parent-id.js +0 -180
  241. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts +0 -3
  242. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +0 -1
  243. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +0 -195
  244. package/dist/migrations/v2.0/update-package-json.d.ts +0 -3
  245. package/dist/migrations/v2.0/update-package-json.d.ts.map +0 -1
  246. package/dist/migrations/v2.0/update-package-json.js +0 -105
  247. package/dist/templates/inventory/production.example.yml +0 -77
  248. package/dist/templates/inventory/qa.example.yml +0 -48
  249. package/opencrvs-toolkit-2.1.0-rc.ffe0b7f.tgz +0 -0
  250. package/tsconfig.tsbuildinfo +0 -1
@@ -1,5 +1,6 @@
1
1
  import { UUID } from '../uuid';
2
2
  import * as z from 'zod/v4';
3
+ import { PlainDate } from './PlainDate';
3
4
  import { EventIndex } from './EventIndex';
4
5
  import { ActionCreationMetadata, RegistrationCreationMetadata } from './EventMetadata';
5
6
  import { RecordScopeV2, UserScopeV2 } from '../scopes';
@@ -16,10 +17,16 @@ export declare const LocationStatus: z.ZodEnum<{
16
17
  inactive: "inactive";
17
18
  }>;
18
19
  export type LocationStatus = z.infer<typeof LocationStatus>;
20
+ /** Thrown when a user's assigned office is inactive and must not be allowed to authenticate. */
21
+ export declare class InactiveOfficeError extends Error {
22
+ constructor(message?: string);
23
+ }
19
24
  /**
20
- * A single element of the append-only `versions` history of a location or
21
- * administrative area. Versions are sorted ascending by `effectiveFrom`
22
- * ('0001-01-01' is used as the beginning-of-time sentinel).
25
+ * A single element of the `versions` history of a location or administrative
26
+ * area. Versions are sorted ascending by `effectiveFrom` ('0001-01-01' is used
27
+ * as the beginning-of-time sentinel). Updates only ever append, but a
28
+ * not-yet-effective version can be withdrawn and seeding replaces a history
29
+ * wholesale, so the array is not append-only.
23
30
  */
24
31
  export declare const LocationVersion: z.ZodObject<{
25
32
  versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
@@ -76,8 +83,79 @@ export declare const Location: z.ZodObject<{
76
83
  }, z.core.$strip>;
77
84
  export type Location = z.infer<typeof Location>;
78
85
  /**
79
- * Input payload for the locations `set` mutation. Carries only the seedable
80
- * identity and hierarchy fields — version history is managed by the server.
86
+ * TEMPORARY — client-side view of {@link AdministrativeArea} with the
87
+ * server-flattened `name`, `status` and `externalId` removed, leaving exactly
88
+ * identity + versions. Every name/status read is thereby forced through the
89
+ * anchored resolution utilities ({@link resolveVersion}, {@link resolvePath})
90
+ * at compile time. Delete this type when the contract migration removes the
91
+ * flat fields from the server schema, at which point the wire type itself
92
+ * becomes identity + versions.
93
+ */
94
+ export declare const ClientAdministrativeArea: z.ZodObject<{
95
+ id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
96
+ parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
97
+ versions: z.ZodArray<z.ZodObject<{
98
+ versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
99
+ effectiveFrom: z.ZodISODate;
100
+ name: z.ZodString;
101
+ externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
102
+ status: z.ZodEnum<{
103
+ active: "active";
104
+ inactive: "inactive";
105
+ }>;
106
+ }, z.core.$strip>>;
107
+ }, z.core.$strip>;
108
+ export type ClientAdministrativeArea = z.infer<typeof ClientAdministrativeArea>;
109
+ /**
110
+ * TEMPORARY — client-side view of {@link Location} with the server-flattened
111
+ * `name`, `status` and `externalId` removed, leaving exactly identity +
112
+ * versions. See {@link ClientAdministrativeArea} for the full rationale and
113
+ * deletion condition.
114
+ */
115
+ export declare const ClientLocation: z.ZodObject<{
116
+ id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
117
+ administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
118
+ locationType: z.ZodNullable<z.ZodString>;
119
+ versions: z.ZodArray<z.ZodObject<{
120
+ versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
121
+ effectiveFrom: z.ZodISODate;
122
+ name: z.ZodString;
123
+ externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
124
+ status: z.ZodEnum<{
125
+ active: "active";
126
+ inactive: "inactive";
127
+ }>;
128
+ }, z.core.$strip>>;
129
+ }, z.core.$strip>;
130
+ export type ClientLocation = z.infer<typeof ClientLocation>;
131
+ /**
132
+ * Strips the server-flattened fields from a location as it enters the
133
+ * client's cached maps. The wire format keeps the flat fields for
134
+ * compatibility; the cache must not, or devices would keep rendering names
135
+ * flattened before a future-dated version takes effect.
136
+ */
137
+ export declare function toClientLocation(location: Location): ClientLocation;
138
+ /** See {@link toClientLocation}. */
139
+ export declare function toClientAdministrativeArea(area: AdministrativeArea): ClientAdministrativeArea;
140
+ export declare const SeededLocationVersions: z.ZodArray<z.ZodObject<{
141
+ versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
142
+ effectiveFrom: z.ZodISODate;
143
+ name: z.ZodString;
144
+ externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
145
+ status: z.ZodEnum<{
146
+ active: "active";
147
+ inactive: "inactive";
148
+ }>;
149
+ }, z.core.$strip>>;
150
+ export type SeededLocationVersions = z.infer<typeof SeededLocationVersions>;
151
+ /**
152
+ * Input payload for the locations `set` mutation. Carries the seedable
153
+ * identity and hierarchy fields, plus an optional pre-built history.
154
+ *
155
+ * Last-write-wins on history: a repeated seed of the same row replaces its
156
+ * stored `versions`, so a caller that means to keep one has to send it every
157
+ * time. Seeding is only reachable while system initialisation is incomplete,
158
+ * so this replaces what an earlier seed attempt wrote, never a live history.
81
159
  */
82
160
  export declare const SetLocationPayload: z.ZodObject<{
83
161
  id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
@@ -85,18 +163,38 @@ export declare const SetLocationPayload: z.ZodObject<{
85
163
  externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
86
164
  administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
87
165
  locationType: z.ZodNullable<z.ZodString>;
166
+ versions: z.ZodOptional<z.ZodArray<z.ZodObject<{
167
+ versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
168
+ effectiveFrom: z.ZodISODate;
169
+ name: z.ZodString;
170
+ externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
171
+ status: z.ZodEnum<{
172
+ active: "active";
173
+ inactive: "inactive";
174
+ }>;
175
+ }, z.core.$strip>>>;
88
176
  }, z.core.$strip>;
89
177
  export type SetLocationPayload = z.infer<typeof SetLocationPayload>;
90
178
  /**
91
- * Input payload for the administrative areas `set` mutation. Carries only the
92
- * seedable identity and hierarchy fields — version history is managed by the
93
- * server.
179
+ * Input payload for the administrative areas `set` mutation. Twin of
180
+ * {@link SetLocationPayload}, including the optional pre-built `versions`
181
+ * history and the same semantics for omitting it.
94
182
  */
95
183
  export declare const SetAdministrativeAreaPayload: z.ZodObject<{
96
184
  id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
97
185
  name: z.ZodString;
98
186
  externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
99
187
  parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
188
+ versions: z.ZodOptional<z.ZodArray<z.ZodObject<{
189
+ versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
190
+ effectiveFrom: z.ZodISODate;
191
+ name: z.ZodString;
192
+ externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
193
+ status: z.ZodEnum<{
194
+ active: "active";
195
+ inactive: "inactive";
196
+ }>;
197
+ }, z.core.$strip>>>;
100
198
  }, z.core.$strip>;
101
199
  export type SetAdministrativeAreaPayload = z.infer<typeof SetAdministrativeAreaPayload>;
102
200
  /**
@@ -111,6 +209,24 @@ export type SetAdministrativeAreaPayload = z.infer<typeof SetAdministrativeAreaP
111
209
  export declare function resolveVersion<T extends {
112
210
  effectiveFrom: string;
113
211
  }>(versions: T[], anchor: string): T;
212
+ /**
213
+ * Whether the entity is selectable at `anchor`: it must already have a
214
+ * version effective by then, and the version that resolves at `anchor` must
215
+ * be active. `resolveVersion` alone is not enough for this — when `anchor`
216
+ * precedes every version it falls back to the earliest one, which would
217
+ * otherwise make a location created after `anchor` look selectable.
218
+ */
219
+ export declare function isSelectableAtAnchor<T extends {
220
+ effectiveFrom: string;
221
+ status: string;
222
+ }>(versions: T[], anchor: string): boolean;
223
+ /**
224
+ * Whether the entity holds the given externalId with active status at the
225
+ * anchor date or at any point after it. Used for point-in-time uniqueness of
226
+ * external codes: a new holder starting at `anchor` collides when an existing
227
+ * holder is (or is scheduled to be) active with the code from then on.
228
+ */
229
+ export declare function hasActiveExternalIdOnOrAfter(versions: LocationVersion[], externalId: string, anchor: string): boolean;
114
230
  type WrapArrayPreserveNullish<V> = V extends readonly any[] ? V : NonNullable<V>[] | Extract<V, null | undefined>;
115
231
  /**
116
232
  * For type T, convert fields K to arrays. If field is string, convert to string[].
@@ -135,7 +251,7 @@ export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventInde
135
251
  * Return false early to break out of checks as soon as possible - if any option is not satisfied, the scope does not allow access to the event, so no need to check further options.
136
252
  *
137
253
  */
138
- export declare function canAccessEventWithScope(event: Partial<EventIndexWithAdministrativeHierarchy>, scope: RecordScopeV2, user: UserContext | SystemContext, customActionType?: string): boolean;
254
+ export declare function canAccessEventWithScope(event: EventIndexWithAdministrativeHierarchy, scope: RecordScopeV2, user: UserContext | SystemContext, customActionType?: string): boolean;
139
255
  export type UserWithResolvedHierarchy = {
140
256
  role: string;
141
257
  administrativeHierarchy: UUID[];
@@ -156,21 +272,11 @@ export declare function canAccessOtherUserWithScopes({ scopes, userToAccess, use
156
272
  *
157
273
  * One of the scopes must allow access for the event to be accessible.
158
274
  */
159
- export declare function userCanAccessEventWithScopes(event: Partial<EventIndexWithAdministrativeHierarchy>, scopes: RecordScopeV2[], user: UserContext | SystemContext, customActionType?: string): boolean;
160
- export declare function getAdministrativeAreaHierarchy(administrativeAreaId: string | undefined | null, administrativeAreas: Map<UUID, AdministrativeArea>): {
161
- id: string & z.$brand<"UUID">;
162
- name: string;
163
- externalId?: string | null | undefined;
164
- parentId: (string & z.$brand<"UUID">) | null;
165
- status: "active" | "inactive";
166
- versions: {
167
- versionId: string & z.$brand<"UUID">;
168
- effectiveFrom: string;
169
- name: string;
170
- externalId?: string | null | undefined;
171
- status: "active" | "inactive";
172
- }[];
173
- }[];
275
+ export declare function userCanAccessEventWithScopes(event: EventIndexWithAdministrativeHierarchy, scopes: RecordScopeV2[], user: UserContext | SystemContext, customActionType?: string): boolean;
276
+ export declare function getAdministrativeAreaHierarchy<A extends {
277
+ id: UUID;
278
+ parentId: UUID | null;
279
+ }>(administrativeAreaId: string | undefined | null, administrativeAreas: Map<UUID, A>): A[];
174
280
  /**
175
281
  * Resolves a location or administrative area UUID into a root-first hierarchy of UUIDs.
176
282
  *
@@ -182,8 +288,45 @@ export declare function getAdministrativeAreaHierarchy(administrativeAreaId: str
182
288
  * so the result is reversed to match the root-first convention used by the server.
183
289
  */
184
290
  export declare function getLocationHierarchy(selectedId: UUID, context: {
185
- administrativeAreas: Map<UUID, AdministrativeArea>;
186
- locations: Map<UUID, Location>;
291
+ administrativeAreas: Map<UUID, {
292
+ id: UUID;
293
+ parentId: UUID | null;
294
+ }>;
295
+ locations: Map<UUID, {
296
+ id: UUID;
297
+ administrativeAreaId: UUID | null;
298
+ }>;
187
299
  }): UUID[];
300
+ /**
301
+ * A node of an anchored hierarchy path: the identity id plus the name and
302
+ * status in effect at the anchor date.
303
+ */
304
+ export type ResolvedPathNode = {
305
+ id: UUID;
306
+ name: string;
307
+ status: LocationStatus;
308
+ };
309
+ /**
310
+ * Resolves a location or administrative area id into its root-first
311
+ * hierarchy path — leaf included — with every node's name and status
312
+ * resolved at the anchor date.
313
+ *
314
+ * The parent chain is identity-level and fixed for life, so the chain is
315
+ * constant and only each node's name/status varies with the anchor. Status is
316
+ * returned for callers that filter on it; an inactive node still resolves to
317
+ * its name. Returns an empty array for an unknown id.
318
+ */
319
+ export declare function resolvePath(locationId: UUID, anchor: PlainDate, context: {
320
+ administrativeAreas: Map<UUID, {
321
+ id: UUID;
322
+ parentId: UUID | null;
323
+ versions: LocationVersion[];
324
+ }>;
325
+ locations: Map<UUID, {
326
+ id: UUID;
327
+ administrativeAreaId: UUID | null;
328
+ versions: LocationVersion[];
329
+ }>;
330
+ }): ResolvedPathNode[];
188
331
  export {};
189
332
  //# sourceMappingURL=locations.d.ts.map
@@ -30,4 +30,34 @@ export declare const V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP: Map<string & impo
30
30
  status: "active" | "inactive";
31
31
  }[];
32
32
  }>;
33
+ /**
34
+ * Stripped view of {@link V2_DEFAULT_MOCK_LOCATIONS_MAP} matching what the
35
+ * client's cached location map actually holds at runtime (identity +
36
+ * versions only). Use this — not the wire-format map above — wherever a test
37
+ * stands in for `useLocations().getLocations.useSuspenseQuery()`.
38
+ */
39
+ export declare const V2_DEFAULT_MOCK_CLIENT_LOCATIONS_MAP: Map<string & import("zod").$brand<"UUID">, {
40
+ id: string & import("zod").$brand<"UUID">;
41
+ administrativeAreaId: (string & import("zod").$brand<"UUID">) | null;
42
+ locationType: string | null;
43
+ versions: {
44
+ versionId: string & import("zod").$brand<"UUID">;
45
+ effectiveFrom: string;
46
+ name: string;
47
+ externalId?: string | null | undefined;
48
+ status: "active" | "inactive";
49
+ }[];
50
+ }>;
51
+ /** See {@link V2_DEFAULT_MOCK_CLIENT_LOCATIONS_MAP}. */
52
+ export declare const V2_DEFAULT_MOCK_CLIENT_ADMINISTRATIVE_AREAS_MAP: Map<string & import("zod").$brand<"UUID">, {
53
+ id: string & import("zod").$brand<"UUID">;
54
+ parentId: (string & import("zod").$brand<"UUID">) | null;
55
+ versions: {
56
+ versionId: string & import("zod").$brand<"UUID">;
57
+ effectiveFrom: string;
58
+ name: string;
59
+ externalId?: string | null | undefined;
60
+ status: "active" | "inactive";
61
+ }[];
62
+ }>;
33
63
  //# sourceMappingURL=mocks.test.utils.d.ts.map
@@ -1,5 +1,5 @@
1
1
  import { DisplayableAction } from './ActionType';
2
- import { EncodedScope, UserScopeV2 } from '../scopes';
2
+ import { EncodedScope, RecordScopeTypeV2, ScopeType, UserScopeV2 } from '../scopes';
3
3
  import { EventIndexWithAdministrativeHierarchy } from './locations';
4
4
  import { UserContext } from '../users/User';
5
5
  import { EventIndex } from './EventIndex';
@@ -17,6 +17,8 @@ export declare const ACTION_SCOPE_MAP: {
17
17
  REVIEW_CORRECTION_REQUEST: "record.correct"[];
18
18
  REJECT_CORRECTION: "record.correct"[];
19
19
  APPROVE_CORRECTION: "record.correct"[];
20
+ REVOKE_REGISTRATION: "record.revoke-registration"[];
21
+ REINSTATE_REGISTRATION: "record.reinstate-registration"[];
20
22
  MARK_AS_DUPLICATE: "record.review-duplicates"[];
21
23
  MARK_AS_NOT_DUPLICATE: "record.review-duplicates"[];
22
24
  ARCHIVE: "record.archive"[];
@@ -27,6 +29,26 @@ export declare const ACTION_SCOPE_MAP: {
27
29
  DUPLICATE_DETECTED: never[];
28
30
  CUSTOM: never[];
29
31
  };
32
+ /**
33
+ * The scopes of every action that can write to a record. Each of them can
34
+ * trigger a sweep of the record's prefix, so each of them has to be able to
35
+ * delete. `record.read` is absent: reading a record is not grounds for erasing
36
+ * it.
37
+ */
38
+ export declare const RECORD_WRITE_SCOPES: RecordScopeTypeV2[];
39
+ /**
40
+ * Scopes that authorize deleting objects held by the documents service.
41
+ *
42
+ * Documents records no link between an object and the record it belongs to, so
43
+ * it cannot check that the caller owns a prefix. It checks instead that the
44
+ * caller holds a scope that lets them change a record or edit a user, and the
45
+ * service that forwarded the request has already checked that this particular
46
+ * record or user is theirs to act on.
47
+ *
48
+ * Listed rather than derived, so that adding an action to `ACTION_SCOPE_MAP`
49
+ * cannot silently grant deletion. `scopes.test.ts` fails when the two drift.
50
+ */
51
+ export declare const DOCUMENT_DELETE_SCOPES: ScopeType[];
30
52
  export declare function hasAnyOfScopes(a: string[], b: string[]): boolean;
31
53
  export declare const AssignmentStatus: {
32
54
  readonly ASSIGNED_TO_SELF: 'ASSIGNED_TO_SELF';
@@ -7,7 +7,7 @@ import { Draft } from '../Draft';
7
7
  import { EventConfig } from '../EventConfig';
8
8
  import { UUID } from '../../uuid';
9
9
  import { DocumentPath } from '../../documents';
10
- export declare function getStatusFromActions(actions: Array<Action>): "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
10
+ export declare function getStatusFromActions(actions: Array<Action>): "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED" | "REVOKED";
11
11
  export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
12
12
  type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
13
13
  [K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
@@ -63,7 +63,7 @@ export declare function applyDeclarationToEventIndex(eventIndex: EventIndex, dec
63
63
  export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Draft, eventConfiguration: EventConfig): {
64
64
  id: string & import("zod").$brand<"UUID">;
65
65
  type: string;
66
- status: "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
66
+ status: "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED" | "REVOKED";
67
67
  legalStatuses: {
68
68
  NOTIFIED?: {
69
69
  createdAt: string;
@@ -90,6 +90,14 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
90
90
  createdByRole?: string | undefined;
91
91
  registrationNumber: string;
92
92
  } | null | undefined;
93
+ REVOKED?: {
94
+ createdAt: string;
95
+ createdBy: string;
96
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
97
+ createdByUserType?: "system" | "user" | null | undefined;
98
+ acceptedAt: string;
99
+ createdByRole?: string | undefined;
100
+ } | null | undefined;
93
101
  };
94
102
  createdAt: string;
95
103
  dateOfEvent?: string | null | undefined;
@@ -1,4 +1,5 @@
1
1
  import { Action } from '../ActionDocument';
2
+ import { EventStatus } from '../EventMetadata';
2
3
  /**
3
4
  * Returns the creation metadata of the last update action (Requested or Accepted).
4
5
  * Requested actions are included so that async flows (202) correctly reflect the
@@ -29,7 +30,7 @@ export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
29
30
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
30
31
  * @see EventIndex for the description of the returned object.
31
32
  */
32
- export declare function getLegalStatuses(actions: Action[]): {
33
+ export declare function getLegalStatuses(actions: Action[], status: EventStatus): {
33
34
  NOTIFIED: {
34
35
  createdAt: string;
35
36
  createdBy: string;
@@ -57,5 +58,14 @@ export declare function getLegalStatuses(actions: Action[]): {
57
58
  createdByRole: string | undefined;
58
59
  registrationNumber: string | null | undefined;
59
60
  } | null;
61
+ REVOKED: {
62
+ createdAt: string;
63
+ createdBy: string;
64
+ createdByUserType: "system" | "user";
65
+ createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
66
+ acceptedAt: string;
67
+ createdByRole: string | undefined;
68
+ registrationNumber: string | null | undefined;
69
+ } | null;
60
70
  };
61
71
  //# sourceMappingURL=utils.d.ts.map