@opencrvs/toolkit 1.9.12-rc.ba08187 → 1.9.12-rc.bacc78f

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 (104) hide show
  1. package/build.sh +8 -0
  2. package/dist/application-config/index.js +2045 -41
  3. package/dist/cli.d.ts +2 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +3633 -0
  6. package/dist/commons/api/router.d.ts +337 -118
  7. package/dist/commons/application-config/index.d.ts +13 -16
  8. package/dist/commons/conditionals/conditionals.d.ts +8 -8
  9. package/dist/commons/events/ActionDocument.d.ts +196 -196
  10. package/dist/commons/events/ActionInput.d.ts +113 -113
  11. package/dist/commons/events/ActionType.d.ts +3 -3
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +6 -0
  13. package/dist/commons/events/AuditLog.d.ts +345 -163
  14. package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
  15. package/dist/commons/events/CountryConfigQueryInput.d.ts +461 -190
  16. package/dist/commons/events/Draft.d.ts +9 -9
  17. package/dist/commons/events/DynamicFieldValue.d.ts +37 -19
  18. package/dist/commons/events/EventConfig.d.ts +3 -1
  19. package/dist/commons/events/EventDocument.d.ts +80 -80
  20. package/dist/commons/events/EventIndex.d.ts +35 -27
  21. package/dist/commons/events/EventInput.d.ts +1 -1
  22. package/dist/commons/events/EventMetadata.d.ts +19 -19
  23. package/dist/commons/events/FieldConfig.d.ts +287 -71
  24. package/dist/commons/events/FieldType.d.ts +2 -1
  25. package/dist/commons/events/FieldTypeMapping.d.ts +98 -72
  26. package/dist/commons/events/FieldValue.d.ts +54 -26
  27. package/dist/commons/events/PlainDate.d.ts +1 -1
  28. package/dist/commons/events/WorkqueueColumnConfig.d.ts +7 -7
  29. package/dist/commons/events/WorkqueueConfig.d.ts +443 -199
  30. package/dist/commons/events/defineConfig.d.ts +0 -4
  31. package/dist/commons/events/locations.d.ts +4 -4
  32. package/dist/commons/events/scopes.d.ts +4 -3
  33. package/dist/commons/events/state/index.d.ts +2 -2
  34. package/dist/commons/events/state/utils.d.ts +1 -1
  35. package/dist/commons/events/test.utils.d.ts +2 -2
  36. package/dist/commons/events/utils.d.ts +3 -175
  37. package/dist/commons/notification/UserNotifications.d.ts +6 -1
  38. package/dist/conditionals/index.js +74 -359
  39. package/dist/events/index.js +1196 -1260
  40. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts +3 -0
  41. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -0
  42. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +405 -0
  43. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +3 -0
  44. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -0
  45. package/dist/migrations/v2.0/checkout-upstream-files.js +143 -0
  46. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts +2 -0
  47. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -0
  48. package/dist/migrations/v2.0/convert-config-files-to-ts.js +829 -0
  49. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts +3 -0
  50. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -0
  51. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +159 -0
  52. package/dist/migrations/v2.0/create-events-index.d.ts +3 -0
  53. package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -0
  54. package/dist/migrations/v2.0/create-events-index.js +326 -0
  55. package/dist/migrations/v2.0/index.d.ts +7 -0
  56. package/dist/migrations/v2.0/index.d.ts.map +1 -0
  57. package/dist/migrations/v2.0/index.js +3572 -0
  58. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts +3 -0
  59. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -0
  60. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +344 -0
  61. package/dist/migrations/v2.0/migrate-scopes.d.ts +3 -0
  62. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -0
  63. package/dist/migrations/v2.0/migrate-scopes.js +282 -0
  64. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts +3 -0
  65. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -0
  66. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +268 -0
  67. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts +3 -0
  68. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -0
  69. package/dist/migrations/v2.0/migrate-workqueue-configs.js +237 -0
  70. package/dist/migrations/v2.0/remove-delete-actions.d.ts +3 -0
  71. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -0
  72. package/dist/migrations/v2.0/remove-delete-actions.js +157 -0
  73. package/dist/migrations/v2.0/remove-demo-scope.d.ts +3 -0
  74. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -0
  75. package/dist/migrations/v2.0/remove-demo-scope.js +75 -0
  76. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts +3 -0
  77. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -0
  78. package/dist/migrations/v2.0/remove-deprecated-imports.js +97 -0
  79. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts +3 -0
  80. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -0
  81. package/dist/migrations/v2.0/remove-hearth-migrations.js +78 -0
  82. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts +3 -0
  83. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -0
  84. package/dist/migrations/v2.0/remove-pending-certification-flag.js +110 -0
  85. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts +3 -0
  86. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -0
  87. package/dist/migrations/v2.0/remove-review-from-register-action.js +164 -0
  88. package/dist/migrations/v2.0/rename-api-paths.d.ts +3 -0
  89. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -0
  90. package/dist/migrations/v2.0/rename-api-paths.js +188 -0
  91. package/dist/migrations/v2.0/rename-location-parent-id.d.ts +3 -0
  92. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -0
  93. package/dist/migrations/v2.0/rename-location-parent-id.js +181 -0
  94. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts +3 -0
  95. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -0
  96. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +196 -0
  97. package/dist/notification/index.js +1007 -1135
  98. package/dist/scopes/index.d.ts +389 -152
  99. package/dist/scopes/index.js +128 -322
  100. package/opencrvs-toolkit-1.9.12-rc.bacc78f.tgz +0 -0
  101. package/package.json +11 -7
  102. package/tsconfig.json +3 -0
  103. package/tsconfig.tsbuildinfo +1 -1
  104. package/opencrvs-toolkit-1.9.12-rc.ba08187.tgz +0 -0
@@ -30,29 +30,31 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
30
30
  // src/scopes/index.ts
31
31
  var scopes_exports = {};
32
32
  __export(scopes_exports, {
33
+ EncodedScope: () => EncodedScope2,
33
34
  JurisdictionFilter: () => JurisdictionFilter,
34
35
  RecordScopeTypeV2: () => RecordScopeTypeV2,
35
36
  RecordScopeV2: () => RecordScopeV2,
36
37
  ResolvedRecordScopeV2: () => ResolvedRecordScopeV2,
37
- SCOPES: () => SCOPES,
38
+ Scope: () => Scope2,
38
39
  ScopeOptionKey: () => ScopeOptionKey,
40
+ ScopeType: () => ScopeType2,
39
41
  ScopesWithDeclaredOptions: () => ScopesWithDeclaredOptions,
40
42
  ScopesWithFullOptions: () => ScopesWithFullOptions,
41
43
  ScopesWithPlaceEventOptions: () => ScopesWithPlaceEventOptions,
42
44
  UserFilter: () => UserFilter,
43
45
  canUserCreateEvent: () => canUserCreateEvent,
44
46
  decodeScope: () => decodeScope,
47
+ defineRoles: () => defineRoles,
45
48
  defineScopes: () => defineScopes,
46
49
  encodeScope: () => encodeScope,
47
50
  getAcceptedScopesByType: () => getAcceptedScopesByType,
48
51
  getScopeOptionValue: () => getScopeOptionValue,
52
+ hasAnyScope: () => hasAnyScope,
53
+ hasScope: () => hasScope,
49
54
  isCustomActionScope: () => isCustomActionScope,
50
- migrateV1ScopesToV2: () => migrateV1ScopesToV2,
51
- parseLiteralScope: () => parseLiteralScope,
52
55
  scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
53
56
  scopeUsesFullOptions: () => scopeUsesFullOptions,
54
- scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
55
- v1ScopeToV2Scope: () => v1ScopeToV2Scope
57
+ scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions
56
58
  });
57
59
  module.exports = __toCommonJS(scopes_exports);
58
60
  var z4 = __toESM(require("zod/v4"));
@@ -66,241 +68,33 @@ var import_uuid = require("uuid");
66
68
  var z = __toESM(require("zod/v4"));
67
69
  var UUID = z.uuid().brand("UUID");
68
70
 
69
- // ../commons/src/scopes.deprecated.do-not-use.ts
71
+ // ../commons/src/authentication.ts
72
+ var import_jwt_decode = __toESM(require("jwt-decode"));
70
73
  var z2 = __toESM(require("zod/v4"));
71
- var rawConfigurableScopeRegex = /^([a-zA-Z][a-zA-Z0-9.-]*(?:\.[a-zA-Z0-9.-]+)*)\[((?:\w+=[\w.-]+(?:\|[\w.-]+)*)(?:,[\w]+=[\w.-]+(?:\|[\w.-]+)*)*)\]$/;
72
- var rawConfigurableScope = z2.string().regex(rawConfigurableScopeRegex);
73
- var SearchScope = z2.object({
74
- type: z2.literal("search"),
75
- options: z2.object({
76
- event: z2.array(z2.string()).length(1),
77
- access: z2.array(z2.enum(["my-jurisdiction", "all"])).length(1)
78
- })
79
- });
80
- var CreateUserScope = z2.object({
81
- type: z2.literal("user.create"),
82
- options: z2.object({
83
- role: z2.array(z2.string())
84
- })
85
- });
86
- var EditUserScope = z2.object({
87
- type: z2.literal("user.edit"),
88
- options: z2.object({
89
- role: z2.array(z2.string())
90
- })
91
- });
92
- var WorkqueueScope = z2.object({
93
- type: z2.literal("workqueue"),
94
- options: z2.object({
95
- id: z2.array(z2.string())
96
- })
97
- });
98
- var PrintCertifiedCopiesScope = z2.object({
99
- type: z2.literal("record.registered.print-certified-copies"),
100
- options: z2.object({
101
- event: z2.array(z2.string()).describe("Event type, e.g. birth, death"),
102
- templates: z2.array(z2.string()).optional().describe(
103
- "Template IDs for certified copies. If not provided, all templates will be used."
104
- )
105
- })
106
- });
107
- var LegacyRecordScope = z2.object({
108
- type: z2.enum([
109
- "record.create",
110
- "record.read",
111
- "record.declare",
112
- "record.notify",
113
- "record.declared.edit",
114
- "record.declared.validate",
115
- "record.declared.reject",
116
- "record.declared.archive",
117
- "record.declared.review-duplicates",
118
- "record.register",
119
- "record.registered.request-correction",
120
- "record.registered.correct",
121
- "record.unassign-others"
122
- ]),
123
- options: z2.object({
124
- event: z2.array(z2.string()).describe("Event type, e.g. birth, death")
125
- })
126
- }).describe(
127
- "Scopes used to check user's permission to perform actions on a record."
128
- );
129
- var ConfigurableRawScopes = z2.discriminatedUnion("type", [
130
- SearchScope,
131
- LegacyRecordScope,
132
- PrintCertifiedCopiesScope,
133
- CreateUserScope,
134
- EditUserScope,
135
- WorkqueueScope
136
- ]);
137
- function getScopeOptions(rawOptions) {
138
- return rawOptions.split(",").reduce((acc, option) => {
139
- const [key, value] = option.split("=");
140
- acc[key] = value.split("|");
141
- return acc;
142
- }, {});
74
+ var TokenUserType = z2.enum(["user", "system"]);
75
+ function setBearerForToken(token) {
76
+ const bearer = "Bearer";
77
+ return token.startsWith(bearer) ? token : `${bearer} ${token}`;
143
78
  }
144
- function parseConfigurableScope(scope) {
145
- const maybeConfigurableScope = rawConfigurableScope.safeParse(scope);
146
- if (!maybeConfigurableScope.success) {
147
- return;
148
- }
149
- const rawScope = maybeConfigurableScope.data;
150
- const [, type, rawOptions] = rawScope.match(rawConfigurableScopeRegex) ?? [];
151
- const options = getScopeOptions(rawOptions);
152
- const parsedScope = {
153
- type,
154
- options
155
- };
156
- const result = ConfigurableRawScopes.safeParse(parsedScope);
157
- return result.success ? result.data : void 0;
79
+ function getScopes(token) {
80
+ const authHeader = { Authorization: setBearerForToken(token) };
81
+ const tokenPayload = getTokenPayload(authHeader.Authorization.split(" ")[1]);
82
+ return tokenPayload.scope || [];
158
83
  }
84
+ var getTokenPayload = (token) => {
85
+ let decoded;
86
+ try {
87
+ decoded = (0, import_jwt_decode.default)(token);
88
+ } catch (err) {
89
+ throw new Error(
90
+ `getTokenPayload: Error occurred during token decode : ${err}`
91
+ );
92
+ }
93
+ return decoded;
94
+ };
95
+ var TokenWithBearer = z2.string().regex(/^Bearer\s/);
159
96
 
160
97
  // ../commons/src/scopes.ts
161
- var SCOPES = {
162
- // TODO v1.8 legacy scopes
163
- BYPASSRATELIMIT: "bypassratelimit",
164
- REGISTER: "register",
165
- DEMO: "demo",
166
- CONFIG: "config",
167
- // systems / integrations
168
- WEBHOOK: "webhook",
169
- NATIONALID: "nationalId",
170
- NOTIFICATION_API: "notification-api",
171
- RECORDSEARCH: "recordsearch",
172
- RECORD_IMPORT: "record.import",
173
- RECORD_EXPORT: "record.export",
174
- RECORD_REINDEX: "record.reindex",
175
- INTEGRATION_CREATE: "integration.create",
176
- // declare
177
- RECORD_DECLARE_BIRTH: "record.declare-birth",
178
- RECORD_DECLARE_BIRTH_MY_JURISDICTION: "record.declare-birth:my-jurisdiction",
179
- RECORD_DECLARE_DEATH: "record.declare-death",
180
- RECORD_DECLARE_DEATH_MY_JURISDICTION: "record.declare-death:my-jurisdiction",
181
- RECORD_DECLARE_MARRIAGE: "record.declare-marriage",
182
- RECORD_DECLARE_MARRIAGE_MY_JURISDICTION: "record.declare-marriage:my-jurisdiction",
183
- RECORD_SUBMIT_INCOMPLETE: "record.declaration-submit-incomplete",
184
- // @todo: should this record be removed from events v2?
185
- RECORD_SUBMIT_FOR_REVIEW: "record.declaration-submit-for-review",
186
- RECORD_UNASSIGN_OTHERS: "record.unassign-others",
187
- // validate
188
- RECORD_SUBMIT_FOR_APPROVAL: "record.declaration-submit-for-approval",
189
- RECORD_SUBMIT_FOR_UPDATES: "record.declaration-submit-for-updates",
190
- RECORD_DECLARATION_EDIT: "record.declaration-edit",
191
- RECORD_REVIEW_DUPLICATES: "record.review-duplicates",
192
- RECORD_DECLARATION_ARCHIVE: "record.declaration-archive",
193
- RECORD_DECLARATION_REINSTATE: "record.declaration-reinstate",
194
- // register
195
- RECORD_REGISTER: "record.register",
196
- /**
197
- * This scope is used to **print and **issue certified copies of a record
198
- * after it has been registered. Previously Registrars had this permission.
199
- */
200
- RECORD_PRINT_ISSUE_CERTIFIED_COPIES: "record.registration-print&issue-certified-copies",
201
- // correct
202
- RECORD_REGISTRATION_REQUEST_CORRECTION: "record.registration-request-correction",
203
- RECORD_REGISTRATION_CORRECT: "record.registration-correct",
204
- RECORD_CONFIRM_REGISTRATION: "record.confirm-registration",
205
- RECORD_REJECT_REGISTRATION: "record.reject-registration",
206
- // search
207
- SEARCH_BIRTH_MY_JURISDICTION: "search.birth:my-jurisdiction",
208
- SEARCH_BIRTH: "search.birth",
209
- SEARCH_DEATH_MY_JURISDICTION: "search.death:my-jurisdiction",
210
- SEARCH_DEATH: "search.death",
211
- SEARCH_MARRIAGE_MY_JURISDICTION: "search.marriage:my-jurisdiction",
212
- SEARCH_MARRIAGE: "search.marriage",
213
- // audit v1.8
214
- RECORD_READ: "record.read",
215
- // profile
216
- PROFILE_ELECTRONIC_SIGNATURE: "profile.electronic-signature",
217
- // performance
218
- PERFORMANCE_READ: "performance.read",
219
- PERFORMANCE_READ_DASHBOARDS: "performance.read-dashboards",
220
- PERFORMANCE_EXPORT_VITAL_STATISTICS: "performance.vital-statistics-export",
221
- // organisation
222
- ORGANISATION_READ_LOCATIONS: "organisation.read-locations:all",
223
- ORGANISATION_READ_LOCATIONS_MY_OFFICE: "organisation.read-locations:my-office",
224
- ORGANISATION_READ_LOCATIONS_MY_JURISDICTION: "organisation.read-locations:my-jurisdiction",
225
- // user
226
- USER_READ: "user.read:all",
227
- USER_READ_MY_OFFICE: "user.read:my-office",
228
- USER_READ_MY_JURISDICTION: "user.read:my-jurisdiction",
229
- USER_READ_ONLY_MY_AUDIT: "user.read:only-my-audit",
230
- //v1.8
231
- USER_CREATE: "user.create:all",
232
- USER_CREATE_MY_JURISDICTION: "user.create:my-jurisdiction",
233
- USER_UPDATE: "user.update:all",
234
- USER_UPDATE_MY_JURISDICTION: "user.update:my-jurisdiction",
235
- // config
236
- CONFIG_UPDATE_ALL: "config.update:all",
237
- // data seeding
238
- USER_DATA_SEEDING: "user.data-seeding",
239
- // attachment
240
- ATTACHMENT_UPLOAD: "attachment.upload"
241
- };
242
- var LegacyScopes = z3.union([
243
- z3.literal(SCOPES.BYPASSRATELIMIT),
244
- z3.literal(SCOPES.REGISTER),
245
- z3.literal(SCOPES.DEMO),
246
- z3.literal(SCOPES.CONFIG)
247
- ]);
248
- var IntegrationScopes = z3.union([
249
- z3.literal(SCOPES.WEBHOOK),
250
- z3.literal(SCOPES.NATIONALID),
251
- z3.literal(SCOPES.NOTIFICATION_API),
252
- z3.literal(SCOPES.RECORDSEARCH),
253
- z3.literal(SCOPES.INTEGRATION_CREATE)
254
- ]);
255
- var InternalOperationsScopes = z3.union([
256
- z3.literal(SCOPES.RECORD_REINDEX),
257
- z3.literal(SCOPES.RECORD_IMPORT)
258
- ]);
259
- var PerformanceScopes = z3.union([
260
- z3.literal(SCOPES.PERFORMANCE_READ),
261
- z3.literal(SCOPES.PERFORMANCE_READ_DASHBOARDS),
262
- z3.literal(SCOPES.PERFORMANCE_EXPORT_VITAL_STATISTICS)
263
- ]);
264
- var OrganisationScopes = z3.union([
265
- z3.literal(SCOPES.ORGANISATION_READ_LOCATIONS),
266
- z3.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_OFFICE),
267
- z3.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_JURISDICTION)
268
- ]);
269
- var UserScopes = z3.union([
270
- z3.literal(SCOPES.USER_READ),
271
- z3.literal(SCOPES.USER_READ_MY_OFFICE),
272
- z3.literal(SCOPES.USER_READ_MY_JURISDICTION),
273
- z3.literal(SCOPES.USER_READ_ONLY_MY_AUDIT),
274
- z3.literal(SCOPES.USER_CREATE),
275
- z3.literal(SCOPES.USER_CREATE_MY_JURISDICTION),
276
- z3.literal(SCOPES.USER_UPDATE),
277
- z3.literal(SCOPES.USER_UPDATE_MY_JURISDICTION)
278
- ]);
279
- var ConfigScope = z3.literal(SCOPES.CONFIG_UPDATE_ALL);
280
- var DataSeedingScope = z3.literal(SCOPES.USER_DATA_SEEDING);
281
- var AttachmentScope = z3.literal(SCOPES.ATTACHMENT_UPLOAD);
282
- var LiteralScopes = z3.union([
283
- LegacyScopes,
284
- IntegrationScopes,
285
- z3.literal(SCOPES.PROFILE_ELECTRONIC_SIGNATURE),
286
- z3.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
287
- PerformanceScopes,
288
- OrganisationScopes,
289
- UserScopes,
290
- ConfigScope,
291
- DataSeedingScope,
292
- InternalOperationsScopes,
293
- AttachmentScope
294
- ]);
295
- function parseLiteralScope(scope) {
296
- const maybeLiteralScope = LiteralScopes.safeParse(scope);
297
- if (maybeLiteralScope.success) {
298
- return {
299
- type: maybeLiteralScope.data
300
- };
301
- }
302
- return;
303
- }
304
98
  var JurisdictionFilter = z3.enum(["administrativeArea", "location", "all"]).describe(
305
99
  "Filters based on user jurisdiction relative to their office location in hierarchy."
306
100
  );
@@ -322,6 +116,25 @@ var RecordScopeTypeV2 = z3.enum([
322
116
  "record.unassign-others",
323
117
  "record.custom-action"
324
118
  ]);
119
+ var PlainScopeType = z3.enum([
120
+ // Misc. system scopes
121
+ "bypassratelimit",
122
+ "record.reindex",
123
+ "user.data-seeding",
124
+ "integration.create",
125
+ "record.import",
126
+ "config.update-all",
127
+ "attachment.upload",
128
+ "profile.electronic-signature",
129
+ "user.read-only-my-audit",
130
+ // Performance dashboard
131
+ "performance.read",
132
+ "performance.read-dashboards",
133
+ "performance.vital-statistics-export",
134
+ // Scopes used exclusively by countryconfig integration token
135
+ "record.confirm-registration",
136
+ "record.reject-registration"
137
+ ]);
325
138
  var scopeByEvent = z3.preprocess(
326
139
  (val) => val === void 0 ? void 0 : [val].flat(),
327
140
  z3.array(z3.string()).optional()
@@ -334,19 +147,33 @@ var scopeOptionsDeclared = scopeOptionsPlaceEvent.extend({
334
147
  declaredIn: JurisdictionFilter.optional(),
335
148
  declaredBy: UserFilter.optional()
336
149
  }).describe("Options applicable to actions that may take place after DECLARE");
337
- var ScopeOptionsFull = scopeOptionsDeclared.extend({
150
+ var AllRecordScopeOptions = scopeOptionsDeclared.extend({
338
151
  registeredIn: JurisdictionFilter.optional(),
339
152
  registeredBy: UserFilter.optional()
340
153
  }).describe(
341
154
  "Options applicable to actions that may take place after REGISTER, with full filtering capabilities."
342
155
  );
343
- var CustomActionScopeOptions = ScopeOptionsFull.extend({
156
+ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
344
157
  customActionTypes: z3.preprocess(
345
158
  (val) => val === void 0 ? void 0 : [val].flat(),
346
159
  z3.array(z3.string()).optional()
347
160
  ).describe("Allowed custom action types")
348
161
  });
349
- var ScopeOptionKey = ScopeOptionsFull.keyof();
162
+ var AccessLevelOptions = z3.object({
163
+ accessLevel: JurisdictionFilter.optional()
164
+ });
165
+ var WorkqueueOrDashboardOptions = z3.object({
166
+ ids: z3.preprocess(
167
+ (val) => val === void 0 ? void 0 : [val].flat(),
168
+ z3.array(z3.string())
169
+ ).describe("Must contain a list of workqueue or dashboard ids.")
170
+ });
171
+ var AllScopeOptions = z3.object({
172
+ ...AllRecordScopeOptions.shape,
173
+ ...AccessLevelOptions.shape,
174
+ ...WorkqueueOrDashboardOptions.shape
175
+ });
176
+ var ScopeOptionKey = AllScopeOptions.keyof();
350
177
  var ResolvedScopeOptionsPlaceEvent = z3.object({
351
178
  event: scopeByEvent,
352
179
  placeOfEvent: UUID.nullish()
@@ -384,7 +211,7 @@ var ScopesWithFullOptions = RecordScopeTypeV2.extract([
384
211
  "record.correct",
385
212
  "record.unassign-others"
386
213
  ]);
387
- var ScopeOptionsPrintCertifiedCopies = ScopeOptionsFull.extend({
214
+ var ScopeOptionsPrintCertifiedCopies = AllRecordScopeOptions.extend({
388
215
  templates: z3.preprocess(
389
216
  (val) => val === void 0 ? void 0 : [val].flat(),
390
217
  z3.array(z3.string()).optional()
@@ -403,7 +230,7 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
403
230
  }),
404
231
  z3.object({
405
232
  type: ScopesWithFullOptions,
406
- options: ScopeOptionsFull.optional()
233
+ options: AllRecordScopeOptions.optional()
407
234
  }),
408
235
  z3.object({
409
236
  type: z3.literal("record.custom-action"),
@@ -448,14 +275,41 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
448
275
  }).optional()
449
276
  })
450
277
  ]).describe("Resolved scope with location/user IDs instead of filters.");
278
+ var SystemScopeType = z3.enum([
279
+ "organisation.read-locations",
280
+ "user.read",
281
+ "user.create",
282
+ "user.edit"
283
+ ]);
284
+ var Scope2 = z3.discriminatedUnion("type", [
285
+ z3.object({ type: PlainScopeType }),
286
+ ...RecordScopeV2.options,
287
+ z3.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
288
+ z3.object({
289
+ type: z3.literal("workqueue"),
290
+ options: WorkqueueOrDashboardOptions
291
+ }),
292
+ z3.object({
293
+ type: z3.literal("dashboard.view"),
294
+ options: WorkqueueOrDashboardOptions
295
+ })
296
+ ]);
297
+ var ScopeType2 = z3.enum([
298
+ ...SystemScopeType.options,
299
+ ...RecordScopeTypeV2.options,
300
+ ...PlainScopeType.options,
301
+ "workqueue",
302
+ "dashboard.view"
303
+ ]);
451
304
  var flattenScope = (scope) => ({
452
305
  type: scope.type,
453
- ...scope.options
306
+ ..."options" in scope ? scope.options : {}
454
307
  });
455
308
  var unflattenScope = (input) => {
456
309
  const { type, ...options } = input;
457
310
  return { type, options };
458
311
  };
312
+ var EncodedScope2 = z3.string().brand("EncodedScope");
459
313
  var encodeScope = (scope) => {
460
314
  const flattened = flattenScope(scope);
461
315
  return qs.stringify(flattened, {
@@ -472,79 +326,18 @@ var decodeScope = (query) => {
472
326
  allowDots: true
473
327
  });
474
328
  const unflattenedScope = unflattenScope(scope);
475
- return RecordScopeV2.safeParse(unflattenedScope)?.data;
329
+ return Scope2.safeParse(unflattenedScope)?.data;
476
330
  };
477
331
  var DEFAULT_SCOPE_OPTIONS = {
478
- placeOfEvent: JurisdictionFilter.enum.all
332
+ placeOfEvent: JurisdictionFilter.enum.all,
333
+ accessLevel: JurisdictionFilter.enum.all
479
334
  };
480
335
  function getScopeOptionValue(scope, option) {
481
- const options = scope.options;
336
+ const options = "options" in scope ? scope.options : void 0;
482
337
  const value = options?.[option];
483
338
  const defaultValue = option in DEFAULT_SCOPE_OPTIONS ? DEFAULT_SCOPE_OPTIONS[option] : void 0;
484
339
  return value ?? defaultValue;
485
340
  }
486
- var v1ToV2ConfigScopeTypeMap = {
487
- search: "record.search",
488
- workqueue: "workqueue",
489
- "user.create": "user.create",
490
- "user.edit": "user.edit",
491
- "record.create": "record.create",
492
- "record.read": "record.read",
493
- "record.declare": "record.declare",
494
- "record.notify": "record.notify",
495
- "record.register": "record.register",
496
- "record.unassign-others": "record.unassign-others",
497
- "record.declared.reject": "record.reject",
498
- "record.declared.archive": "record.archive",
499
- "record.declared.review-duplicates": "record.review-duplicates",
500
- "record.registered.print-certified-copies": "record.print-certified-copies",
501
- "record.registered.request-correction": "record.request-correction",
502
- "record.registered.correct": "record.correct",
503
- "record.declared.edit": "record.edit",
504
- "record.declared.validate": "record.custom-action"
505
- };
506
- var v1ScopeToV2Scope = (v1Scope) => {
507
- const configurableV1Scope = parseConfigurableScope(v1Scope);
508
- const literalV1Scope = parseLiteralScope(v1Scope);
509
- if (!configurableV1Scope && !literalV1Scope) {
510
- throw new Error(`Invalid V1 scope: ${v1Scope}`);
511
- }
512
- if (literalV1Scope) {
513
- return literalV1Scope.type;
514
- }
515
- if (configurableV1Scope) {
516
- const type = v1ToV2ConfigScopeTypeMap[configurableV1Scope.type];
517
- if (type === void 0) {
518
- throw new Error(`Unsupported V1 scope type: ${configurableV1Scope.type}`);
519
- }
520
- if (configurableV1Scope.type === "search") {
521
- return encodeScope({
522
- type,
523
- options: {
524
- event: configurableV1Scope.options.event || [],
525
- placeOfEvent: configurableV1Scope.options.access[0] === "my-jurisdiction" ? "administrativeArea" : "all"
526
- }
527
- });
528
- }
529
- if (configurableV1Scope.type === "record.declared.validate") {
530
- return encodeScope({
531
- type: "record.custom-action",
532
- options: {
533
- event: configurableV1Scope.options.event,
534
- customActionTypes: ["VALIDATE_DECLARATION"]
535
- }
536
- });
537
- }
538
- if (!configurableV1Scope.type.startsWith("record.")) {
539
- return v1Scope;
540
- }
541
- return encodeScope({
542
- type,
543
- options: configurableV1Scope.options
544
- });
545
- }
546
- throw new Error(`Unsupported V1 scope type: ${v1Scope}`);
547
- };
548
341
  function getAcceptedScopesByType({
549
342
  acceptedScopes,
550
343
  scopes
@@ -556,27 +349,40 @@ function getAcceptedScopesByType({
556
349
  ) ? parsedScope : null;
557
350
  }).filter((scope) => scope !== null);
558
351
  }
559
- function isEventTypeAllowed(scope, eventType) {
560
- if (scope.options?.event === void 0) {
561
- return true;
352
+ function hasAnyScope(tokenOrScopes, scopes) {
353
+ const userScopes = Array.isArray(tokenOrScopes) ? tokenOrScopes : getScopes(tokenOrScopes);
354
+ const foundScopes = getAcceptedScopesByType({
355
+ acceptedScopes: scopes,
356
+ scopes: userScopes
357
+ });
358
+ return foundScopes.length > 0;
359
+ }
360
+ function hasScope(tokenOrScopes, scope) {
361
+ if (Array.isArray(tokenOrScopes)) {
362
+ return getAcceptedScopesByType({
363
+ acceptedScopes: [scope],
364
+ scopes: tokenOrScopes
365
+ }).length > 0;
562
366
  }
563
- return scope.options?.event?.includes(eventType);
367
+ return hasAnyScope(tokenOrScopes, [scope]);
564
368
  }
565
- function canUserCreateEvent(acceptedScopes, eventType) {
566
- return acceptedScopes.some((scope) => isEventTypeAllowed(scope, eventType));
369
+ function canUserCreateEvent(userScopes, eventType) {
370
+ const scopes = getAcceptedScopesByType({
371
+ acceptedScopes: ["record.create"],
372
+ scopes: userScopes
373
+ });
374
+ return scopes.some((scope) => {
375
+ if (!("options" in scope) || !scope.options || !("event" in scope.options)) {
376
+ return true;
377
+ }
378
+ return scope.options?.event?.includes(eventType);
379
+ });
567
380
  }
568
381
  function defineScopes(scopes) {
569
- return scopes.map((scope) => RecordScopeV2.parse(scope)).map(encodeScope);
382
+ return scopes.map((scope) => Scope2.parse(scope)).map(encodeScope);
570
383
  }
571
- function migrateV1ScopesToV2(scopes) {
572
- return scopes.map((scope) => {
573
- try {
574
- return v1ScopeToV2Scope(scope);
575
- } catch (error) {
576
- console.warn(`Could not migrate scope: ${scope}. Error: ${error}`);
577
- return null;
578
- }
579
- }).filter((scope) => !!scope);
384
+ function defineRoles(roles) {
385
+ return roles;
580
386
  }
581
387
 
582
388
  // src/scopes/index.ts
package/package.json CHANGED
@@ -1,8 +1,11 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "1.9.12-rc.ba08187",
3
+ "version": "1.9.12-rc.bacc78f",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
+ "bin": {
7
+ "opencrvs": "./dist/cli.js"
8
+ },
6
9
  "exports": {
7
10
  "./lib": "./dist/lib.js",
8
11
  "./api": "./dist/api/index.js",
@@ -19,7 +22,7 @@
19
22
  },
20
23
  "dependencies": {
21
24
  "@trpc/client": "11.4.3",
22
- "@trpc/server": "11.4.3",
25
+ "@trpc/server": "^11.8.0",
23
26
  "ajv": "^8.17.1",
24
27
  "ajv-formats": "^3.0.1",
25
28
  "date-fns": "^2.28.0",
@@ -28,16 +31,17 @@
28
31
  "object-hash": "^3.0.0",
29
32
  "qs": "6.14.0",
30
33
  "superjson": "1.9.0-0",
34
+ "ts-morph": "^27.0.2",
31
35
  "uuid": "^9.0.0",
32
- "zod": "^4.1.12",
33
- "zod-openapi": "^5.4.3"
36
+ "zod": "^4.2.1",
37
+ "zod-openapi": "^5.4.6"
34
38
  },
35
39
  "devDependencies": {
40
+ "@opencrvs/events": "^1.9.0",
41
+ "@types/object-hash": "^3.0.6",
36
42
  "@types/uuid": "^9.0.3",
37
43
  "esbuild": "^0.24.0",
38
- "typescript": "^5.6.3",
39
- "@opencrvs/events": "^1.9.0",
40
- "@types/object-hash": "^3.0.6"
44
+ "typescript": "^5.6.3"
41
45
  },
42
46
  "moduleNameMapper": {
43
47
  "@opencrvs/commons/events": "@opencrvs/commons/build/dist/common/events/index.js",
package/tsconfig.json CHANGED
@@ -20,6 +20,9 @@
20
20
  "@opencrvs/commons/events/deduplication": [
21
21
  "../commons/src/events/deduplication.ts"
22
22
  ],
23
+ "@opencrvs/commons/scopes.deprecated.do-not-use": [
24
+ "../commons/src/scopes.deprecated.do-not-use.ts"
25
+ ],
23
26
  "@opencrvs/commons/notification": [
24
27
  "../commons/src/notification/index.ts"
25
28
  ],
@@ -1 +1 @@
1
- {"root":["./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}
1
+ {"root":["./src/cli.ts","./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/migrations/v2.0/add-birth-certificate-issuance-flag.ts","./src/migrations/v2.0/checkout-upstream-files.ts","./src/migrations/v2.0/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.ts","./src/migrations/v2.0/create-events-index.ts","./src/migrations/v2.0/index.ts","./src/migrations/v2.0/make-built-in-validate-actions-custom.ts","./src/migrations/v2.0/migrate-scopes.ts","./src/migrations/v2.0/migrate-validated-workqueue-status-to-flag.ts","./src/migrations/v2.0/migrate-workqueue-configs.ts","./src/migrations/v2.0/remove-delete-actions.ts","./src/migrations/v2.0/remove-demo-scope.ts","./src/migrations/v2.0/remove-deprecated-imports.ts","./src/migrations/v2.0/remove-hearth-migrations.ts","./src/migrations/v2.0/remove-pending-certification-flag.ts","./src/migrations/v2.0/remove-review-from-register-action.ts","./src/migrations/v2.0/rename-api-paths.ts","./src/migrations/v2.0/rename-location-parent-id.ts","./src/migrations/v2.0/simplify-analytics-precalculations.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}