@opencrvs/toolkit 2.0.0-rc.153df7b → 2.0.0-rc.1d9a00b
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.
- package/dist/application-config/index.js +39 -11
- package/dist/cli.js +530 -85
- package/dist/commons/api/router.d.ts +55 -54
- package/dist/commons/application-config/index.d.ts +16 -4
- package/dist/commons/conditionals/conditionals.d.ts +3 -3
- package/dist/commons/events/FieldConfig.d.ts +5 -0
- package/dist/commons/events/locations.d.ts +17 -1
- package/dist/conditionals/index.js +35 -7
- package/dist/events/index.js +73 -7
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
- package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
- package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
- package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
- package/dist/migrations/v2.0/index.d.ts.map +1 -1
- package/dist/migrations/v2.0/index.js +528 -83
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
- package/dist/notification/index.js +35 -7
- package/dist/scopes/index.d.ts +82 -10
- package/dist/scopes/index.js +41 -8
- package/opencrvs-toolkit-2.0.0-rc.1d9a00b.tgz +0 -0
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.153df7b.tgz +0 -0
package/dist/events/index.js
CHANGED
|
@@ -243,6 +243,8 @@ __export(events_exports, {
|
|
|
243
243
|
areConditionsMet: () => areConditionsMet,
|
|
244
244
|
buildFormState: () => buildFormState,
|
|
245
245
|
canAccessEventWithScope: () => canAccessEventWithScope,
|
|
246
|
+
canAccessOtherUserWithScopes: () => canAccessOtherUserWithScopes,
|
|
247
|
+
canAccessUserWithScope: () => canAccessUserWithScope,
|
|
246
248
|
compositeFieldTypes: () => compositeFieldTypes,
|
|
247
249
|
createEmptyDraft: () => createEmptyDraft,
|
|
248
250
|
createFieldConditionals: () => createFieldConditionals,
|
|
@@ -489,6 +491,10 @@ var scopeByEvent = z2.preprocess(
|
|
|
489
491
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
490
492
|
z2.array(z2.string()).optional()
|
|
491
493
|
).describe("Event type, e.g. birth, death");
|
|
494
|
+
var userRole = z2.preprocess(
|
|
495
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
496
|
+
z2.array(z2.string()).optional()
|
|
497
|
+
).describe("User role, e.g. admin, field agent");
|
|
492
498
|
var scopeOptionsPlaceEvent = z2.object({
|
|
493
499
|
event: scopeByEvent,
|
|
494
500
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -512,6 +518,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
512
518
|
var AccessLevelOptions = z2.object({
|
|
513
519
|
accessLevel: JurisdictionFilter.optional()
|
|
514
520
|
});
|
|
521
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
522
|
+
role: userRole.optional()
|
|
523
|
+
});
|
|
515
524
|
var WorkqueueOrDashboardOptions = z2.object({
|
|
516
525
|
ids: z2.preprocess(
|
|
517
526
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -521,6 +530,7 @@ var WorkqueueOrDashboardOptions = z2.object({
|
|
|
521
530
|
var AllScopeOptions = z2.object({
|
|
522
531
|
...AllRecordScopeOptions.shape,
|
|
523
532
|
...AccessLevelOptions.shape,
|
|
533
|
+
...AllUserScopeOptions.shape,
|
|
524
534
|
...WorkqueueOrDashboardOptions.shape
|
|
525
535
|
});
|
|
526
536
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -593,6 +603,31 @@ var RecordScopeV2 = z2.discriminatedUnion("type", [
|
|
|
593
603
|
]).describe(
|
|
594
604
|
"Scopes used to check user's permission to perform actions on a record."
|
|
595
605
|
);
|
|
606
|
+
var SystemScopeType = z2.enum([
|
|
607
|
+
"organisation.read-locations",
|
|
608
|
+
"user.read",
|
|
609
|
+
"user.create",
|
|
610
|
+
"user.edit"
|
|
611
|
+
]);
|
|
612
|
+
var UserScopeType = SystemScopeType.extract([
|
|
613
|
+
"user.read",
|
|
614
|
+
"user.create",
|
|
615
|
+
"user.edit"
|
|
616
|
+
]);
|
|
617
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
618
|
+
var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
619
|
+
z2.object({
|
|
620
|
+
type: ScopesWithRoleOption,
|
|
621
|
+
options: AllUserScopeOptions.optional()
|
|
622
|
+
}),
|
|
623
|
+
z2.object({
|
|
624
|
+
type: UserScopeType.extract(["user.read"]),
|
|
625
|
+
options: AccessLevelOptions.optional()
|
|
626
|
+
})
|
|
627
|
+
]);
|
|
628
|
+
function scopeUsesRoleOptions(scope) {
|
|
629
|
+
return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
|
|
630
|
+
}
|
|
596
631
|
function scopeUsesDeclaredOptions(scope) {
|
|
597
632
|
return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
|
|
598
633
|
}
|
|
@@ -625,16 +660,14 @@ var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
|
|
|
625
660
|
}).optional()
|
|
626
661
|
})
|
|
627
662
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
628
|
-
var SystemScopeType = z2.enum([
|
|
629
|
-
"organisation.read-locations",
|
|
630
|
-
"user.read",
|
|
631
|
-
"user.create",
|
|
632
|
-
"user.edit"
|
|
633
|
-
]);
|
|
634
663
|
var Scope = z2.discriminatedUnion("type", [
|
|
635
664
|
z2.object({ type: PlainScopeType }),
|
|
636
665
|
...RecordScopeV2.options,
|
|
637
|
-
|
|
666
|
+
...UserScopeV2.options,
|
|
667
|
+
z2.object({
|
|
668
|
+
type: z2.literal("organisation.read-locations"),
|
|
669
|
+
options: AccessLevelOptions.optional()
|
|
670
|
+
}),
|
|
638
671
|
z2.object({
|
|
639
672
|
type: z2.literal("workqueue"),
|
|
640
673
|
options: WorkqueueOrDashboardOptions
|
|
@@ -9930,6 +9963,39 @@ function canAccessEventWithScope(event2, scope, user2, customActionType) {
|
|
|
9930
9963
|
}
|
|
9931
9964
|
return true;
|
|
9932
9965
|
}
|
|
9966
|
+
function canAccessUserWithScope({
|
|
9967
|
+
userToAccess,
|
|
9968
|
+
scope,
|
|
9969
|
+
user: user2
|
|
9970
|
+
}) {
|
|
9971
|
+
const opts = scope.options;
|
|
9972
|
+
const hasSameOffice = user2.primaryOfficeId === userToAccess.primaryOfficeId;
|
|
9973
|
+
if (opts?.accessLevel === JurisdictionFilter.enum.location && !hasSameOffice) {
|
|
9974
|
+
return false;
|
|
9975
|
+
}
|
|
9976
|
+
const hasAdministrativeAreaInHierarchy = userToAccess.administrativeHierarchy.some(
|
|
9977
|
+
(id) => user2.administrativeAreaId === id
|
|
9978
|
+
) || user2.administrativeAreaId === null;
|
|
9979
|
+
if (opts?.accessLevel === JurisdictionFilter.enum.administrativeArea && !hasAdministrativeAreaInHierarchy) {
|
|
9980
|
+
return false;
|
|
9981
|
+
}
|
|
9982
|
+
if (scopeUsesRoleOptions(scope)) {
|
|
9983
|
+
const { options } = scope;
|
|
9984
|
+
if (options?.role && !options.role.includes(userToAccess.role)) {
|
|
9985
|
+
return false;
|
|
9986
|
+
}
|
|
9987
|
+
}
|
|
9988
|
+
return true;
|
|
9989
|
+
}
|
|
9990
|
+
function canAccessOtherUserWithScopes({
|
|
9991
|
+
scopes,
|
|
9992
|
+
userToAccess,
|
|
9993
|
+
user: user2
|
|
9994
|
+
}) {
|
|
9995
|
+
return scopes.some(
|
|
9996
|
+
(scope) => canAccessUserWithScope({ userToAccess, scope, user: user2 })
|
|
9997
|
+
);
|
|
9998
|
+
}
|
|
9933
9999
|
function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
|
|
9934
10000
|
return scopes.some(
|
|
9935
10001
|
(scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"add-birth-certificate-issuance-flag.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/add-birth-certificate-issuance-flag.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"add-birth-certificate-issuance-flag.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/add-birth-certificate-issuance-flag.ts"],"names":[],"mappings":"AAycA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
|
|
@@ -24,15 +24,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
25
|
exports.main = main;
|
|
26
26
|
/**
|
|
27
|
-
* Codemod: Add `pending-first-certificate-issuance` flag to
|
|
27
|
+
* Codemod: Add `pending-first-certificate-issuance` flag to event configs and workqueues.
|
|
28
28
|
*
|
|
29
29
|
* Usage:
|
|
30
30
|
* ts-node -r tsconfig-paths/register src/migrations/v2.0/add-birth-certificate-issuance-flag.ts
|
|
31
31
|
*
|
|
32
32
|
* What it does:
|
|
33
|
-
* defineConfig (
|
|
33
|
+
* defineConfig (every event type — birth, death, marriage, custom, etc.):
|
|
34
34
|
* - Ensures the top-level `flags` array contains the `pending-first-certificate-issuance`
|
|
35
|
-
* flag definition
|
|
35
|
+
* flag definition. The flag's i18n `label.id` is event-specific, e.g.
|
|
36
|
+
* `event.birth.flag.pending-first-certificate-issuance`,
|
|
37
|
+
* `event.death.flag.pending-first-certificate-issuance`.
|
|
36
38
|
* - Ensures every `REGISTER` action has
|
|
37
39
|
* `flags: [{ id: 'pending-first-certificate-issuance', operation: 'add' }]`
|
|
38
40
|
* - Ensures every `PRINT_CERTIFICATE` action has
|
|
@@ -55,20 +57,27 @@ const ACTION_PROPERTY_NAME = 'action';
|
|
|
55
57
|
const FLAGS_PROPERTY_NAME = 'flags';
|
|
56
58
|
const QUERY_PROPERTY_NAME = 'query';
|
|
57
59
|
const TYPE_PROPERTY_NAME = 'type';
|
|
60
|
+
const ID_PROPERTY_NAME = 'id';
|
|
58
61
|
const CLAUSES_PROPERTY_NAME = 'clauses';
|
|
59
62
|
const ANY_OF_PROPERTY_NAME = 'anyOf';
|
|
60
63
|
const FLAG_ID = 'pending-first-certificate-issuance';
|
|
61
64
|
const REGISTER_TYPE = 'REGISTER';
|
|
62
65
|
const PRINT_CERTIFICATE_TYPE = 'PRINT_CERTIFICATE';
|
|
63
|
-
|
|
66
|
+
/**
|
|
67
|
+
* Builds the flag-definition object literal for a given event type so the i18n
|
|
68
|
+
* `label.id` is namespaced per event (e.g. `event.death.flag.…`).
|
|
69
|
+
*/
|
|
70
|
+
function flagDefinitionInitializer(eventType) {
|
|
71
|
+
return `{
|
|
64
72
|
id: '${FLAG_ID}',
|
|
65
73
|
label: {
|
|
66
|
-
id: 'event.
|
|
74
|
+
id: 'event.${eventType}.flag.${FLAG_ID}',
|
|
67
75
|
defaultMessage: 'Pending first certificate issuance',
|
|
68
76
|
description: 'Flag label for first certificate issuance'
|
|
69
77
|
},
|
|
70
78
|
requiresAction: true
|
|
71
79
|
}`;
|
|
80
|
+
}
|
|
72
81
|
// ─── Generic helpers ──────────────────────────────────────────────────────────
|
|
73
82
|
/**
|
|
74
83
|
* Returns true if the object's `type` property matches the given type name.
|
|
@@ -90,23 +99,36 @@ function isActionOfType(obj, typeName) {
|
|
|
90
99
|
return false;
|
|
91
100
|
}
|
|
92
101
|
/**
|
|
93
|
-
*
|
|
94
|
-
*
|
|
102
|
+
* Extracts the event type from a `defineConfig` root config object, using the
|
|
103
|
+
* (lower-cased) value of either the `type` or `id` property. Property name has
|
|
104
|
+
* shifted across core/country-config versions, so both are tried.
|
|
105
|
+
*
|
|
106
|
+
* Handles all known shapes:
|
|
107
|
+
* - `type: 'birth'` / `id: 'birth'`
|
|
108
|
+
* - `type: EventType.BIRTH` / `id: Event.Birth`
|
|
109
|
+
*
|
|
110
|
+
* For `PropertyAccessExpression` (enum access), the *member name* is returned
|
|
111
|
+
* lower-cased — this works for the conventional `EventType.BIRTH = 'birth'` and
|
|
112
|
+
* `Event.Birth = 'birth'` mappings used in core and country configs.
|
|
113
|
+
*
|
|
114
|
+
* Returns null when no event type can be determined.
|
|
95
115
|
*/
|
|
96
|
-
function
|
|
97
|
-
const
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
116
|
+
function getEventType(configArg) {
|
|
117
|
+
for (const propName of [TYPE_PROPERTY_NAME, ID_PROPERTY_NAME]) {
|
|
118
|
+
const prop = configArg.getProperty(propName);
|
|
119
|
+
if (!prop || !ts_morph_1.Node.isPropertyAssignment(prop))
|
|
120
|
+
continue;
|
|
121
|
+
const initializer = prop.getInitializer();
|
|
122
|
+
if (!initializer)
|
|
123
|
+
continue;
|
|
124
|
+
if (ts_morph_1.Node.isStringLiteral(initializer)) {
|
|
125
|
+
return initializer.getLiteralValue().toLowerCase();
|
|
126
|
+
}
|
|
127
|
+
if (ts_morph_1.Node.isPropertyAccessExpression(initializer)) {
|
|
128
|
+
return initializer.getName().toLowerCase();
|
|
129
|
+
}
|
|
108
130
|
}
|
|
109
|
-
return
|
|
131
|
+
return null;
|
|
110
132
|
}
|
|
111
133
|
/**
|
|
112
134
|
* Returns true if an array literal contains an object literal with `id: <id>`.
|
|
@@ -129,17 +151,19 @@ function hasElementWithId(array, id) {
|
|
|
129
151
|
}
|
|
130
152
|
// ─── defineConfig helpers ─────────────────────────────────────────────────────
|
|
131
153
|
/**
|
|
132
|
-
* Ensures the top-level `flags` array in a
|
|
133
|
-
* `pending-first-certificate-issuance` flag definition.
|
|
154
|
+
* Ensures the top-level `flags` array in a `defineConfig` contains the
|
|
155
|
+
* `pending-first-certificate-issuance` flag definition. The flag's i18n
|
|
156
|
+
* `label.id` is namespaced per event type (e.g. `event.death.flag.…`).
|
|
134
157
|
*/
|
|
135
|
-
function ensureTopLevelFlagDefinition(configArg) {
|
|
158
|
+
function ensureTopLevelFlagDefinition(configArg, eventType) {
|
|
159
|
+
const initializer = flagDefinitionInitializer(eventType);
|
|
136
160
|
const flagsProp = configArg.getProperty(FLAGS_PROPERTY_NAME);
|
|
137
161
|
if (flagsProp && ts_morph_1.Node.isPropertyAssignment(flagsProp)) {
|
|
138
162
|
const flagsInit = flagsProp.getInitializer();
|
|
139
163
|
if (flagsInit && ts_morph_1.Node.isArrayLiteralExpression(flagsInit)) {
|
|
140
164
|
if (hasElementWithId(flagsInit, FLAG_ID))
|
|
141
165
|
return false;
|
|
142
|
-
flagsInit.addElement(
|
|
166
|
+
flagsInit.addElement(initializer);
|
|
143
167
|
return true;
|
|
144
168
|
}
|
|
145
169
|
return false;
|
|
@@ -147,7 +171,7 @@ function ensureTopLevelFlagDefinition(configArg) {
|
|
|
147
171
|
// No `flags` property at all — create it
|
|
148
172
|
configArg.addPropertyAssignment({
|
|
149
173
|
name: FLAGS_PROPERTY_NAME,
|
|
150
|
-
initializer: `[\n ${
|
|
174
|
+
initializer: `[\n ${initializer}\n]`
|
|
151
175
|
});
|
|
152
176
|
return true;
|
|
153
177
|
}
|
|
@@ -174,15 +198,15 @@ function ensureActionOperationFlag(action, operation) {
|
|
|
174
198
|
return true;
|
|
175
199
|
}
|
|
176
200
|
/**
|
|
177
|
-
* Processes a
|
|
201
|
+
* Processes a `defineConfig` object: ensures top-level flag definition,
|
|
178
202
|
* REGISTER action flags, and PRINT_CERTIFICATE action flags.
|
|
179
203
|
* Returns the number of changes made.
|
|
180
204
|
*/
|
|
181
|
-
function
|
|
205
|
+
function processConfig(configArg, eventType, relPath) {
|
|
182
206
|
let changes = 0;
|
|
183
|
-
if (ensureTopLevelFlagDefinition(configArg)) {
|
|
207
|
+
if (ensureTopLevelFlagDefinition(configArg, eventType)) {
|
|
184
208
|
changes++;
|
|
185
|
-
console.log(` [${relPath}] Added '${FLAG_ID}' to top-level flags`);
|
|
209
|
+
console.log(` [${relPath}] (${eventType}) Added '${FLAG_ID}' to top-level flags`);
|
|
186
210
|
}
|
|
187
211
|
const actionsProp = configArg.getProperty(ACTIONS_PROPERTY_NAME);
|
|
188
212
|
if (!actionsProp || !ts_morph_1.Node.isPropertyAssignment(actionsProp))
|
|
@@ -197,13 +221,13 @@ function processBirthConfig(configArg, relPath) {
|
|
|
197
221
|
if (isActionOfType(element, REGISTER_TYPE)) {
|
|
198
222
|
if (ensureActionOperationFlag(element, 'add')) {
|
|
199
223
|
changes++;
|
|
200
|
-
console.log(` [${relPath}] Added '${FLAG_ID}' add-flag to REGISTER action`);
|
|
224
|
+
console.log(` [${relPath}] (${eventType}) Added '${FLAG_ID}' add-flag to REGISTER action`);
|
|
201
225
|
}
|
|
202
226
|
}
|
|
203
227
|
if (isActionOfType(element, PRINT_CERTIFICATE_TYPE)) {
|
|
204
228
|
if (ensureActionOperationFlag(element, 'remove')) {
|
|
205
229
|
changes++;
|
|
206
|
-
console.log(` [${relPath}] Added '${FLAG_ID}' remove-flag to PRINT_CERTIFICATE action`);
|
|
230
|
+
console.log(` [${relPath}] (${eventType}) Added '${FLAG_ID}' remove-flag to PRINT_CERTIFICATE action`);
|
|
207
231
|
}
|
|
208
232
|
}
|
|
209
233
|
}
|
|
@@ -332,9 +356,10 @@ function processFile(filePath, project) {
|
|
|
332
356
|
const configArg = args[0];
|
|
333
357
|
if (!ts_morph_1.Node.isObjectLiteralExpression(configArg))
|
|
334
358
|
continue;
|
|
335
|
-
|
|
359
|
+
const eventType = getEventType(configArg);
|
|
360
|
+
if (!eventType)
|
|
336
361
|
continue;
|
|
337
|
-
totalChanges +=
|
|
362
|
+
totalChanges += processConfig(configArg, eventType, relPath);
|
|
338
363
|
}
|
|
339
364
|
// ── defineWorkqueues ──────────────────────────────────────────────────────
|
|
340
365
|
if (calleeName === DEFINE_WORKQUEUES_NAME) {
|
|
@@ -369,7 +394,7 @@ function processFile(filePath, project) {
|
|
|
369
394
|
function main() {
|
|
370
395
|
return __awaiter(this, void 0, void 0, function* () {
|
|
371
396
|
const srcDir = path_1.default.join(process.cwd(), 'src');
|
|
372
|
-
console.log(`Scanning for
|
|
397
|
+
console.log(`Scanning for defineConfig and PRINT_CERTIFICATE workqueues in: ${srcDir}\n`);
|
|
373
398
|
const project = new ts_morph_1.Project({
|
|
374
399
|
tsConfigFilePath: path_1.default.resolve(srcDir, '../tsconfig.json'),
|
|
375
400
|
skipAddingFilesFromTsConfig: false
|
|
@@ -390,7 +415,7 @@ function main() {
|
|
|
390
415
|
}
|
|
391
416
|
}
|
|
392
417
|
if (modifiedFiles.length === 0) {
|
|
393
|
-
console.log('No
|
|
418
|
+
console.log('No event configs or PRINT_CERTIFICATE workqueues found. Nothing to do.');
|
|
394
419
|
return;
|
|
395
420
|
}
|
|
396
421
|
console.log(`\nSaving ${modifiedFiles.length} modified file(s)...`);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"add-resend-invite-notification.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/add-resend-invite-notification.ts"],"names":[],"mappings":"AA8ZA,iBAAe,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAuCnC;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
|