@opencrvs/toolkit 2.0.0-rc.2e68bac → 2.0.0-rc.2e7e5da
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/create-countryconfig/index.js +73 -0
- package/create-countryconfig/package.json +11 -0
- package/dist/application-config/index.js +5 -3
- package/dist/cli.js +83 -20
- package/dist/commons/api/router.d.ts +20 -20
- 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 +21 -0
- package/dist/commons/events/mocks.test.utils.d.ts +19 -0
- package/dist/commons/events/scopes.d.ts +24 -1
- package/dist/conditionals/index.js +5 -3
- package/dist/events/index.js +60 -3
- package/dist/migrations/v2.0/index.js +83 -20
- 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 +5 -3
- package/dist/scopes/index.d.ts +6 -1
- package/dist/scopes/index.js +5 -3
- package/opencrvs-toolkit-2.0.0-rc.2e7e5da.tgz +0 -0
- package/package.json +1 -1
- package/opencrvs-toolkit-2.0.0-rc.2e68bac.tgz +0 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { AdministrativeArea, Location } from './locations';
|
|
2
|
+
export declare const V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS: AdministrativeArea[];
|
|
3
|
+
export declare const V2_DEFAULT_MOCK_LOCATIONS: Location[];
|
|
4
|
+
export declare const V2_DEFAULT_MOCK_LOCATIONS_MAP: Map<string & import("zod").$brand<"UUID">, {
|
|
5
|
+
id: string & import("zod").$brand<"UUID">;
|
|
6
|
+
name: string;
|
|
7
|
+
administrativeAreaId: (string & import("zod").$brand<"UUID">) | null;
|
|
8
|
+
validUntil: string | null;
|
|
9
|
+
locationType: string | null;
|
|
10
|
+
externalId?: string | null | undefined;
|
|
11
|
+
}>;
|
|
12
|
+
export declare const V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP: Map<string & import("zod").$brand<"UUID">, {
|
|
13
|
+
id: string & import("zod").$brand<"UUID">;
|
|
14
|
+
name: string;
|
|
15
|
+
parentId: (string & import("zod").$brand<"UUID">) | null;
|
|
16
|
+
validUntil: string | null;
|
|
17
|
+
externalId?: string | null | undefined;
|
|
18
|
+
}>;
|
|
19
|
+
//# sourceMappingURL=mocks.test.utils.d.ts.map
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { DisplayableAction } from './ActionType';
|
|
2
|
-
import { EncodedScope } from '../scopes';
|
|
2
|
+
import { EncodedScope, UserScopeV2 } from '../scopes';
|
|
3
3
|
import { EventIndexWithAdministrativeHierarchy } from './locations';
|
|
4
4
|
import { UserContext } from '../users/User';
|
|
5
5
|
import { EventIndex } from './EventIndex';
|
|
6
|
+
import { UUID } from 'src/uuid';
|
|
6
7
|
export declare const ACTION_SCOPE_MAP: {
|
|
7
8
|
READ: "record.read"[];
|
|
8
9
|
CREATE: "record.create"[];
|
|
@@ -53,4 +54,26 @@ export declare function isActionInScope({ scopes, action, event, currentUser }:
|
|
|
53
54
|
event: EventIndexWithAdministrativeHierarchy;
|
|
54
55
|
currentUser: UserContext;
|
|
55
56
|
}): boolean;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
*
|
|
60
|
+
* @param allRoles - All possible roles in the system
|
|
61
|
+
* @param userLocation - The location and role information of the user whose role options are being determined
|
|
62
|
+
* @param acceptedScopes - The scopes of the user requesting the role update, used to determine which roles they can assign.
|
|
63
|
+
* @param userRequesting - The user context of the user requesting the role update, used to check location-based access to the target user's location.
|
|
64
|
+
*
|
|
65
|
+
* @returns An array of roles that the requesting user is allowed to assign to the target user based on their scopes and location
|
|
66
|
+
*
|
|
67
|
+
* 1) Used to determine which roles should be available in the dropdown when a user is editing another user's role in the user management interface.
|
|
68
|
+
* 2) Used to check if payload includes valid role.
|
|
69
|
+
*/
|
|
70
|
+
export declare function getAvailableRolesForUserUpdatePayload({ allRoles, userLocation, acceptedScopes, userRequesting }: {
|
|
71
|
+
allRoles: string[];
|
|
72
|
+
userRequesting: UserContext;
|
|
73
|
+
acceptedScopes: UserScopeV2[];
|
|
74
|
+
userLocation: {
|
|
75
|
+
administrativeHierarchy: UUID[];
|
|
76
|
+
primaryOfficeId: UUID;
|
|
77
|
+
};
|
|
78
|
+
}): string[];
|
|
56
79
|
//# sourceMappingURL=scopes.d.ts.map
|
|
@@ -298,12 +298,14 @@ var SystemScopeType = z6.enum([
|
|
|
298
298
|
"organisation.read-locations",
|
|
299
299
|
"user.read",
|
|
300
300
|
"user.create",
|
|
301
|
-
"user.edit"
|
|
301
|
+
"user.edit",
|
|
302
|
+
"user.search"
|
|
302
303
|
]);
|
|
303
304
|
var UserScopeType = SystemScopeType.extract([
|
|
304
305
|
"user.read",
|
|
305
306
|
"user.create",
|
|
306
|
-
"user.edit"
|
|
307
|
+
"user.edit",
|
|
308
|
+
"user.search"
|
|
307
309
|
]);
|
|
308
310
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
309
311
|
var UserScopeV2 = z6.discriminatedUnion("type", [
|
|
@@ -312,7 +314,7 @@ var UserScopeV2 = z6.discriminatedUnion("type", [
|
|
|
312
314
|
options: AllUserScopeOptions.optional()
|
|
313
315
|
}),
|
|
314
316
|
z6.object({
|
|
315
|
-
type: UserScopeType.extract(["user.read"]),
|
|
317
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
316
318
|
options: AccessLevelOptions.optional()
|
|
317
319
|
})
|
|
318
320
|
]);
|
package/dist/events/index.js
CHANGED
|
@@ -302,12 +302,14 @@ __export(events_exports, {
|
|
|
302
302
|
getActionConfig: () => getActionConfig,
|
|
303
303
|
getActionReview: () => getActionReview,
|
|
304
304
|
getActionReviewFields: () => getActionReviewFields,
|
|
305
|
+
getAdministrativeAreaHierarchy: () => getAdministrativeAreaHierarchy,
|
|
305
306
|
getAllUniqueFields: () => getAllUniqueFields,
|
|
306
307
|
getAnnotationFromDrafts: () => getAnnotationFromDrafts,
|
|
307
308
|
getAssignedUserFromActions: () => getAssignedUserFromActions,
|
|
308
309
|
getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
|
|
309
310
|
getAssignmentStatus: () => getAssignmentStatus,
|
|
310
311
|
getAvailableActionsForEvent: () => getAvailableActionsForEvent,
|
|
312
|
+
getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
|
|
311
313
|
getCompleteActionAnnotation: () => getCompleteActionAnnotation,
|
|
312
314
|
getCompleteActionDeclaration: () => getCompleteActionDeclaration,
|
|
313
315
|
getCurrentEventState: () => getCurrentEventState,
|
|
@@ -318,6 +320,7 @@ __export(events_exports, {
|
|
|
318
320
|
getDeclarationPages: () => getDeclarationPages,
|
|
319
321
|
getEventConfigById: () => getEventConfigById,
|
|
320
322
|
getFilePathsFromEvent: () => getFilePathsFromEvent,
|
|
323
|
+
getLocationHierarchy: () => getLocationHierarchy,
|
|
321
324
|
getMixedPath: () => getMixedPath,
|
|
322
325
|
getPendingAction: () => getPendingAction,
|
|
323
326
|
getPrintCertificatePages: () => getPrintCertificatePages,
|
|
@@ -607,12 +610,14 @@ var SystemScopeType = z2.enum([
|
|
|
607
610
|
"organisation.read-locations",
|
|
608
611
|
"user.read",
|
|
609
612
|
"user.create",
|
|
610
|
-
"user.edit"
|
|
613
|
+
"user.edit",
|
|
614
|
+
"user.search"
|
|
611
615
|
]);
|
|
612
616
|
var UserScopeType = SystemScopeType.extract([
|
|
613
617
|
"user.read",
|
|
614
618
|
"user.create",
|
|
615
|
-
"user.edit"
|
|
619
|
+
"user.edit",
|
|
620
|
+
"user.search"
|
|
616
621
|
]);
|
|
617
622
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
618
623
|
var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
@@ -621,7 +626,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
|
621
626
|
options: AllUserScopeOptions.optional()
|
|
622
627
|
}),
|
|
623
628
|
z2.object({
|
|
624
|
-
type: UserScopeType.extract(["user.read"]),
|
|
629
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
625
630
|
options: AccessLevelOptions.optional()
|
|
626
631
|
})
|
|
627
632
|
]);
|
|
@@ -10001,6 +10006,39 @@ function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
|
|
|
10001
10006
|
(scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
|
|
10002
10007
|
);
|
|
10003
10008
|
}
|
|
10009
|
+
function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
|
|
10010
|
+
const collectedLocations = [];
|
|
10011
|
+
const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
|
|
10012
|
+
let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
|
|
10013
|
+
while (current) {
|
|
10014
|
+
collectedLocations.push(current);
|
|
10015
|
+
if (!current.parentId) {
|
|
10016
|
+
break;
|
|
10017
|
+
}
|
|
10018
|
+
const parentId = current.parentId;
|
|
10019
|
+
current = administrativeAreas.get(parentId);
|
|
10020
|
+
}
|
|
10021
|
+
return collectedLocations;
|
|
10022
|
+
}
|
|
10023
|
+
function getLocationHierarchy(selectedId, context) {
|
|
10024
|
+
const { administrativeAreas, locations } = context;
|
|
10025
|
+
const loc = locations.get(selectedId);
|
|
10026
|
+
if (loc) {
|
|
10027
|
+
if (loc.administrativeAreaId) {
|
|
10028
|
+
const hierarchy2 = getAdministrativeAreaHierarchy(
|
|
10029
|
+
loc.administrativeAreaId,
|
|
10030
|
+
administrativeAreas
|
|
10031
|
+
);
|
|
10032
|
+
return [...hierarchy2.reverse().map((area) => area.id), loc.id];
|
|
10033
|
+
}
|
|
10034
|
+
return [loc.id];
|
|
10035
|
+
}
|
|
10036
|
+
const hierarchy = getAdministrativeAreaHierarchy(
|
|
10037
|
+
selectedId,
|
|
10038
|
+
administrativeAreas
|
|
10039
|
+
);
|
|
10040
|
+
return hierarchy.reverse().map((area) => area.id);
|
|
10041
|
+
}
|
|
10004
10042
|
|
|
10005
10043
|
// ../commons/src/events/scopes.ts
|
|
10006
10044
|
var ACTION_SCOPE_MAP = {
|
|
@@ -10075,6 +10113,25 @@ function isActionInScope({
|
|
|
10075
10113
|
);
|
|
10076
10114
|
return canAccess;
|
|
10077
10115
|
}
|
|
10116
|
+
function getAvailableRolesForUserUpdatePayload({
|
|
10117
|
+
allRoles,
|
|
10118
|
+
userLocation,
|
|
10119
|
+
acceptedScopes,
|
|
10120
|
+
userRequesting
|
|
10121
|
+
}) {
|
|
10122
|
+
const availableRoles = allRoles.filter((role) => {
|
|
10123
|
+
const canAccess = canAccessOtherUserWithScopes({
|
|
10124
|
+
userToAccess: {
|
|
10125
|
+
...userLocation,
|
|
10126
|
+
role
|
|
10127
|
+
},
|
|
10128
|
+
user: userRequesting,
|
|
10129
|
+
scopes: acceptedScopes
|
|
10130
|
+
});
|
|
10131
|
+
return canAccess;
|
|
10132
|
+
});
|
|
10133
|
+
return availableRoles;
|
|
10134
|
+
}
|
|
10078
10135
|
|
|
10079
10136
|
// ../commons/src/events/serializers/user/deserializer.ts
|
|
10080
10137
|
function userDeserializer(serializedUserField, user2) {
|
|
@@ -190,6 +190,8 @@ function ensureImports(sourceFile) {
|
|
|
190
190
|
var DEFINE_CONFIG_NAME2 = "defineConfig";
|
|
191
191
|
var ACTIONS_PROPERTY_NAME2 = "actions";
|
|
192
192
|
var TYPE_PROPERTY_NAME2 = "type";
|
|
193
|
+
var ID_PROPERTY_NAME = "id";
|
|
194
|
+
var FLAGS_PROPERTY_NAME = "flags";
|
|
193
195
|
var CUSTOM_ACTION_TYPE_PROPERTY_NAME = "customActionType";
|
|
194
196
|
var AUDIT_HISTORY_LABEL_PROPERTY_NAME = "auditHistoryLabel";
|
|
195
197
|
var DEDUPLICATION_PROPERTY_NAME = "deduplication";
|
|
@@ -199,9 +201,12 @@ var FORM_PROPERTY_NAME = "form";
|
|
|
199
201
|
var ACTION_TYPE_ENUM_NAME = "ActionType";
|
|
200
202
|
var VALIDATE_MEMBER_NAME = "VALIDATE";
|
|
201
203
|
var CUSTOM_MEMBER_NAME = "CUSTOM";
|
|
204
|
+
var REGISTER_MEMBER_NAME2 = "REGISTER";
|
|
202
205
|
var VALIDATE_STRING_LITERAL = "VALIDATE";
|
|
203
206
|
var CUSTOM_STRING_LITERAL = "CUSTOM";
|
|
207
|
+
var REGISTER_STRING_LITERAL2 = "REGISTER";
|
|
204
208
|
var VALIDATE_DECLARATION_VALUE = "VALIDATE_DECLARATION";
|
|
209
|
+
var VALIDATED_FLAG_VALUE = "validated";
|
|
205
210
|
function isValidateType(typeInitializer) {
|
|
206
211
|
if (typeInitializer.getKind() === import_ts_morph2.SyntaxKind.PropertyAccessExpression) {
|
|
207
212
|
const propAccess = typeInitializer.asKindOrThrow(
|
|
@@ -325,6 +330,50 @@ function transformValidateActionToCustom(obj, eventType) {
|
|
|
325
330
|
}
|
|
326
331
|
return true;
|
|
327
332
|
}
|
|
333
|
+
function isRegisterAction(action) {
|
|
334
|
+
const typeProperty = action.getProperty(TYPE_PROPERTY_NAME2);
|
|
335
|
+
if (!typeProperty || !import_ts_morph2.Node.isPropertyAssignment(typeProperty)) return false;
|
|
336
|
+
const typeInit = typeProperty.getInitializer();
|
|
337
|
+
if (!typeInit) return false;
|
|
338
|
+
if (import_ts_morph2.Node.isPropertyAccessExpression(typeInit)) {
|
|
339
|
+
const enumExpr = typeInit.getExpression();
|
|
340
|
+
return import_ts_morph2.Node.isIdentifier(enumExpr) && enumExpr.getText() === ACTION_TYPE_ENUM_NAME && typeInit.getName() === REGISTER_MEMBER_NAME2;
|
|
341
|
+
}
|
|
342
|
+
if (import_ts_morph2.Node.isStringLiteral(typeInit)) {
|
|
343
|
+
return typeInit.getLiteralValue() === REGISTER_STRING_LITERAL2;
|
|
344
|
+
}
|
|
345
|
+
return false;
|
|
346
|
+
}
|
|
347
|
+
function arrayHasElementWithId(array3, id) {
|
|
348
|
+
for (const el of array3.getElements()) {
|
|
349
|
+
if (!import_ts_morph2.Node.isObjectLiteralExpression(el)) continue;
|
|
350
|
+
const idProp = el.getProperty(ID_PROPERTY_NAME);
|
|
351
|
+
if (!idProp || !import_ts_morph2.Node.isPropertyAssignment(idProp)) continue;
|
|
352
|
+
const idInit = idProp.getInitializer();
|
|
353
|
+
if (idInit && import_ts_morph2.Node.isStringLiteral(idInit) && idInit.getLiteralValue() === id) {
|
|
354
|
+
return true;
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
return false;
|
|
358
|
+
}
|
|
359
|
+
function ensureRegisterRemovesValidatedFlag(action) {
|
|
360
|
+
const entry = `{ id: '${VALIDATED_FLAG_VALUE}', operation: 'remove' }`;
|
|
361
|
+
const flagsProp = action.getProperty(FLAGS_PROPERTY_NAME);
|
|
362
|
+
if (flagsProp && import_ts_morph2.Node.isPropertyAssignment(flagsProp)) {
|
|
363
|
+
const flagsInit = flagsProp.getInitializer();
|
|
364
|
+
if (flagsInit && import_ts_morph2.Node.isArrayLiteralExpression(flagsInit)) {
|
|
365
|
+
if (arrayHasElementWithId(flagsInit, VALIDATED_FLAG_VALUE)) return false;
|
|
366
|
+
flagsInit.addElement(entry);
|
|
367
|
+
return true;
|
|
368
|
+
}
|
|
369
|
+
return false;
|
|
370
|
+
}
|
|
371
|
+
action.addPropertyAssignment({
|
|
372
|
+
name: FLAGS_PROPERTY_NAME,
|
|
373
|
+
initializer: `[${entry}]`
|
|
374
|
+
});
|
|
375
|
+
return true;
|
|
376
|
+
}
|
|
328
377
|
function processFile2(filePath, project) {
|
|
329
378
|
const sourceFile = project.getSourceFile(filePath);
|
|
330
379
|
if (!sourceFile) return 0;
|
|
@@ -390,6 +439,18 @@ function processFile2(filePath, project) {
|
|
|
390
439
|
` [${import_path2.default.relative(process.cwd(), filePath)}] Added top-level 'flags' array to defineConfig`
|
|
391
440
|
);
|
|
392
441
|
}
|
|
442
|
+
if (configHadValidateAction) {
|
|
443
|
+
for (const element of actionsInitializer.getElements()) {
|
|
444
|
+
if (!import_ts_morph2.Node.isObjectLiteralExpression(element)) continue;
|
|
445
|
+
if (!isRegisterAction(element)) continue;
|
|
446
|
+
if (ensureRegisterRemovesValidatedFlag(element)) {
|
|
447
|
+
transformedCount++;
|
|
448
|
+
console.log(
|
|
449
|
+
` [${import_path2.default.relative(process.cwd(), filePath)}] Added '${VALIDATED_FLAG_VALUE}' remove-flag to REGISTER action`
|
|
450
|
+
);
|
|
451
|
+
}
|
|
452
|
+
}
|
|
453
|
+
}
|
|
393
454
|
if (fileNeedsImports) {
|
|
394
455
|
ensureImports(sourceFile);
|
|
395
456
|
}
|
|
@@ -436,7 +497,7 @@ Saving ${modifiedFiles.length} modified file(s)...`);
|
|
|
436
497
|
}
|
|
437
498
|
console.log(
|
|
438
499
|
`
|
|
439
|
-
Done.
|
|
500
|
+
Done. Applied ${totalTransformed} change(s): VALIDATE \u2192 CUSTOM (${VALIDATE_DECLARATION_VALUE}) and '${VALIDATED_FLAG_VALUE}' remove-flag on matching REGISTER actions.`
|
|
440
501
|
);
|
|
441
502
|
}
|
|
442
503
|
|
|
@@ -679,14 +740,14 @@ var QUERY_PROPERTY_NAME = "query";
|
|
|
679
740
|
var TYPE_PROPERTY_NAME5 = "type";
|
|
680
741
|
var CLAUSES_PROPERTY_NAME = "clauses";
|
|
681
742
|
var STATUS_PROPERTY_NAME = "status";
|
|
682
|
-
var
|
|
743
|
+
var FLAGS_PROPERTY_NAME2 = "flags";
|
|
683
744
|
var TERMS_PROPERTY_NAME = "terms";
|
|
684
745
|
var TERM_PROPERTY_NAME = "term";
|
|
685
746
|
var ANY_OF_PROPERTY_NAME = "anyOf";
|
|
686
747
|
var VALIDATED_STATUS_VALUE = "VALIDATED";
|
|
687
|
-
var
|
|
748
|
+
var VALIDATED_FLAG_VALUE2 = "validated";
|
|
688
749
|
function addValidatedFlag(clause) {
|
|
689
|
-
const flagsProperty = clause.getProperty(
|
|
750
|
+
const flagsProperty = clause.getProperty(FLAGS_PROPERTY_NAME2);
|
|
690
751
|
if (flagsProperty && import_ts_morph5.Node.isPropertyAssignment(flagsProperty)) {
|
|
691
752
|
const flagsInit = flagsProperty.getInitializer();
|
|
692
753
|
if (flagsInit && import_ts_morph5.Node.isObjectLiteralExpression(flagsInit)) {
|
|
@@ -694,19 +755,19 @@ function addValidatedFlag(clause) {
|
|
|
694
755
|
if (anyOfProperty && import_ts_morph5.Node.isPropertyAssignment(anyOfProperty)) {
|
|
695
756
|
const anyOfInit = anyOfProperty.getInitializer();
|
|
696
757
|
if (anyOfInit && import_ts_morph5.Node.isArrayLiteralExpression(anyOfInit)) {
|
|
697
|
-
anyOfInit.addElement(`'${
|
|
758
|
+
anyOfInit.addElement(`'${VALIDATED_FLAG_VALUE2}'`);
|
|
698
759
|
}
|
|
699
760
|
} else {
|
|
700
761
|
flagsInit.addPropertyAssignment({
|
|
701
762
|
name: ANY_OF_PROPERTY_NAME,
|
|
702
|
-
initializer: `['${
|
|
763
|
+
initializer: `['${VALIDATED_FLAG_VALUE2}']`
|
|
703
764
|
});
|
|
704
765
|
}
|
|
705
766
|
}
|
|
706
767
|
} else {
|
|
707
768
|
clause.addPropertyAssignment({
|
|
708
|
-
name:
|
|
709
|
-
initializer: `{ ${ANY_OF_PROPERTY_NAME}: ['${
|
|
769
|
+
name: FLAGS_PROPERTY_NAME2,
|
|
770
|
+
initializer: `{ ${ANY_OF_PROPERTY_NAME}: ['${VALIDATED_FLAG_VALUE2}'] }`
|
|
710
771
|
});
|
|
711
772
|
}
|
|
712
773
|
}
|
|
@@ -872,10 +933,10 @@ var DEFINE_CONFIG_NAME4 = "defineConfig";
|
|
|
872
933
|
var DEFINE_WORKQUEUES_NAME2 = "defineWorkqueues";
|
|
873
934
|
var ACTIONS_PROPERTY_NAME4 = "actions";
|
|
874
935
|
var ACTION_PROPERTY_NAME = "action";
|
|
875
|
-
var
|
|
936
|
+
var FLAGS_PROPERTY_NAME3 = "flags";
|
|
876
937
|
var QUERY_PROPERTY_NAME2 = "query";
|
|
877
938
|
var TYPE_PROPERTY_NAME6 = "type";
|
|
878
|
-
var
|
|
939
|
+
var ID_PROPERTY_NAME2 = "id";
|
|
879
940
|
var CLAUSES_PROPERTY_NAME2 = "clauses";
|
|
880
941
|
var ANY_OF_PROPERTY_NAME2 = "anyOf";
|
|
881
942
|
var FLAG_ID = "pending-first-certificate-issuance";
|
|
@@ -906,7 +967,7 @@ function isActionOfType(obj, typeName) {
|
|
|
906
967
|
return false;
|
|
907
968
|
}
|
|
908
969
|
function getEventType(configArg) {
|
|
909
|
-
for (const propName of [TYPE_PROPERTY_NAME6,
|
|
970
|
+
for (const propName of [TYPE_PROPERTY_NAME6, ID_PROPERTY_NAME2]) {
|
|
910
971
|
const prop = configArg.getProperty(propName);
|
|
911
972
|
if (!prop || !import_ts_morph6.Node.isPropertyAssignment(prop)) continue;
|
|
912
973
|
const initializer = prop.getInitializer();
|
|
@@ -934,7 +995,7 @@ function hasElementWithId(array3, id) {
|
|
|
934
995
|
}
|
|
935
996
|
function ensureTopLevelFlagDefinition(configArg, eventType) {
|
|
936
997
|
const initializer = flagDefinitionInitializer(eventType);
|
|
937
|
-
const flagsProp = configArg.getProperty(
|
|
998
|
+
const flagsProp = configArg.getProperty(FLAGS_PROPERTY_NAME3);
|
|
938
999
|
if (flagsProp && import_ts_morph6.Node.isPropertyAssignment(flagsProp)) {
|
|
939
1000
|
const flagsInit = flagsProp.getInitializer();
|
|
940
1001
|
if (flagsInit && import_ts_morph6.Node.isArrayLiteralExpression(flagsInit)) {
|
|
@@ -945,7 +1006,7 @@ function ensureTopLevelFlagDefinition(configArg, eventType) {
|
|
|
945
1006
|
return false;
|
|
946
1007
|
}
|
|
947
1008
|
configArg.addPropertyAssignment({
|
|
948
|
-
name:
|
|
1009
|
+
name: FLAGS_PROPERTY_NAME3,
|
|
949
1010
|
initializer: `[
|
|
950
1011
|
${initializer}
|
|
951
1012
|
]`
|
|
@@ -953,7 +1014,7 @@ function ensureTopLevelFlagDefinition(configArg, eventType) {
|
|
|
953
1014
|
return true;
|
|
954
1015
|
}
|
|
955
1016
|
function ensureActionOperationFlag(action, operation) {
|
|
956
|
-
const flagsProp = action.getProperty(
|
|
1017
|
+
const flagsProp = action.getProperty(FLAGS_PROPERTY_NAME3);
|
|
957
1018
|
const entry = `{ id: '${FLAG_ID}', operation: '${operation}' }`;
|
|
958
1019
|
if (flagsProp && import_ts_morph6.Node.isPropertyAssignment(flagsProp)) {
|
|
959
1020
|
const flagsInit = flagsProp.getInitializer();
|
|
@@ -965,7 +1026,7 @@ function ensureActionOperationFlag(action, operation) {
|
|
|
965
1026
|
return false;
|
|
966
1027
|
}
|
|
967
1028
|
action.addPropertyAssignment({
|
|
968
|
-
name:
|
|
1029
|
+
name: FLAGS_PROPERTY_NAME3,
|
|
969
1030
|
initializer: `[${entry}]`
|
|
970
1031
|
});
|
|
971
1032
|
return true;
|
|
@@ -1027,7 +1088,7 @@ function hasPrintCertificateAction(workqueue) {
|
|
|
1027
1088
|
return false;
|
|
1028
1089
|
}
|
|
1029
1090
|
function addFlagToQueryClause(clause) {
|
|
1030
|
-
const flagsProp = clause.getProperty(
|
|
1091
|
+
const flagsProp = clause.getProperty(FLAGS_PROPERTY_NAME3);
|
|
1031
1092
|
if (flagsProp && import_ts_morph6.Node.isPropertyAssignment(flagsProp)) {
|
|
1032
1093
|
const flagsInit = flagsProp.getInitializer();
|
|
1033
1094
|
if (flagsInit && import_ts_morph6.Node.isObjectLiteralExpression(flagsInit)) {
|
|
@@ -1052,7 +1113,7 @@ function addFlagToQueryClause(clause) {
|
|
|
1052
1113
|
}
|
|
1053
1114
|
} else {
|
|
1054
1115
|
clause.addPropertyAssignment({
|
|
1055
|
-
name:
|
|
1116
|
+
name: FLAGS_PROPERTY_NAME3,
|
|
1056
1117
|
initializer: `{ ${ANY_OF_PROPERTY_NAME2}: ['${FLAG_ID}'] }`
|
|
1057
1118
|
});
|
|
1058
1119
|
return true;
|
|
@@ -2247,12 +2308,14 @@ var SystemScopeType = z3.enum([
|
|
|
2247
2308
|
"organisation.read-locations",
|
|
2248
2309
|
"user.read",
|
|
2249
2310
|
"user.create",
|
|
2250
|
-
"user.edit"
|
|
2311
|
+
"user.edit",
|
|
2312
|
+
"user.search"
|
|
2251
2313
|
]);
|
|
2252
2314
|
var UserScopeType = SystemScopeType.extract([
|
|
2253
2315
|
"user.read",
|
|
2254
2316
|
"user.create",
|
|
2255
|
-
"user.edit"
|
|
2317
|
+
"user.edit",
|
|
2318
|
+
"user.search"
|
|
2256
2319
|
]);
|
|
2257
2320
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
2258
2321
|
var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
@@ -2261,7 +2324,7 @@ var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
|
2261
2324
|
options: AllUserScopeOptions.optional()
|
|
2262
2325
|
}),
|
|
2263
2326
|
z3.object({
|
|
2264
|
-
type: UserScopeType.extract(["user.read"]),
|
|
2327
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
2265
2328
|
options: AccessLevelOptions.optional()
|
|
2266
2329
|
})
|
|
2267
2330
|
]);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"make-built-in-validate-actions-custom.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/make-built-in-validate-actions-custom.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"make-built-in-validate-actions-custom.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/make-built-in-validate-actions-custom.ts"],"names":[],"mappings":"AAodA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
|
|
@@ -41,6 +41,10 @@ exports.main = main;
|
|
|
41
41
|
* - Removes the `deduplication` property from those objects
|
|
42
42
|
* - Replaces `review: { fields: <value> }` with `form: <value>`, or
|
|
43
43
|
* `review: <expr>` with `form: <expr>.fields` when the value is not an inline object
|
|
44
|
+
* - Adds the top-level `validated` flag definition and `{ id: 'validated',
|
|
45
|
+
* operation: 'add' }` to the (now custom) validate action
|
|
46
|
+
* - Adds `{ id: 'validated', operation: 'remove' }` to every `REGISTER` action
|
|
47
|
+
* in the same config, closing the flag's lifecycle when registration happens
|
|
44
48
|
* - Saves the modified files in-place
|
|
45
49
|
*/
|
|
46
50
|
const ts_morph_1 = require("ts-morph");
|
|
@@ -74,6 +78,8 @@ function ensureImports(sourceFile) {
|
|
|
74
78
|
const DEFINE_CONFIG_NAME = 'defineConfig';
|
|
75
79
|
const ACTIONS_PROPERTY_NAME = 'actions';
|
|
76
80
|
const TYPE_PROPERTY_NAME = 'type';
|
|
81
|
+
const ID_PROPERTY_NAME = 'id';
|
|
82
|
+
const FLAGS_PROPERTY_NAME = 'flags';
|
|
77
83
|
const CUSTOM_ACTION_TYPE_PROPERTY_NAME = 'customActionType';
|
|
78
84
|
const AUDIT_HISTORY_LABEL_PROPERTY_NAME = 'auditHistoryLabel';
|
|
79
85
|
const DEDUPLICATION_PROPERTY_NAME = 'deduplication';
|
|
@@ -83,9 +89,12 @@ const FORM_PROPERTY_NAME = 'form';
|
|
|
83
89
|
const ACTION_TYPE_ENUM_NAME = 'ActionType';
|
|
84
90
|
const VALIDATE_MEMBER_NAME = 'VALIDATE';
|
|
85
91
|
const CUSTOM_MEMBER_NAME = 'CUSTOM';
|
|
92
|
+
const REGISTER_MEMBER_NAME = 'REGISTER';
|
|
86
93
|
const VALIDATE_STRING_LITERAL = 'VALIDATE';
|
|
87
94
|
const CUSTOM_STRING_LITERAL = 'CUSTOM';
|
|
95
|
+
const REGISTER_STRING_LITERAL = 'REGISTER';
|
|
88
96
|
const VALIDATE_DECLARATION_VALUE = 'VALIDATE_DECLARATION';
|
|
97
|
+
const VALIDATED_FLAG_VALUE = 'validated';
|
|
89
98
|
function isValidateType(typeInitializer) {
|
|
90
99
|
// Matches: ActionType.VALIDATE
|
|
91
100
|
if (typeInitializer.getKind() === ts_morph_1.SyntaxKind.PropertyAccessExpression) {
|
|
@@ -230,6 +239,72 @@ function transformValidateActionToCustom(obj, eventType) {
|
|
|
230
239
|
}
|
|
231
240
|
return true;
|
|
232
241
|
}
|
|
242
|
+
function isRegisterAction(action) {
|
|
243
|
+
const typeProperty = action.getProperty(TYPE_PROPERTY_NAME);
|
|
244
|
+
if (!typeProperty || !ts_morph_1.Node.isPropertyAssignment(typeProperty))
|
|
245
|
+
return false;
|
|
246
|
+
const typeInit = typeProperty.getInitializer();
|
|
247
|
+
if (!typeInit)
|
|
248
|
+
return false;
|
|
249
|
+
// Matches: ActionType.REGISTER
|
|
250
|
+
if (ts_morph_1.Node.isPropertyAccessExpression(typeInit)) {
|
|
251
|
+
const enumExpr = typeInit.getExpression();
|
|
252
|
+
return (ts_morph_1.Node.isIdentifier(enumExpr) &&
|
|
253
|
+
enumExpr.getText() === ACTION_TYPE_ENUM_NAME &&
|
|
254
|
+
typeInit.getName() === REGISTER_MEMBER_NAME);
|
|
255
|
+
}
|
|
256
|
+
// Matches: "REGISTER"
|
|
257
|
+
if (ts_morph_1.Node.isStringLiteral(typeInit)) {
|
|
258
|
+
return typeInit.getLiteralValue() === REGISTER_STRING_LITERAL;
|
|
259
|
+
}
|
|
260
|
+
return false;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Returns true if an array literal contains an object literal with `id: <id>`.
|
|
264
|
+
*/
|
|
265
|
+
function arrayHasElementWithId(array, id) {
|
|
266
|
+
for (const el of array.getElements()) {
|
|
267
|
+
if (!ts_morph_1.Node.isObjectLiteralExpression(el))
|
|
268
|
+
continue;
|
|
269
|
+
const idProp = el.getProperty(ID_PROPERTY_NAME);
|
|
270
|
+
if (!idProp || !ts_morph_1.Node.isPropertyAssignment(idProp))
|
|
271
|
+
continue;
|
|
272
|
+
const idInit = idProp.getInitializer();
|
|
273
|
+
if (idInit &&
|
|
274
|
+
ts_morph_1.Node.isStringLiteral(idInit) &&
|
|
275
|
+
idInit.getLiteralValue() === id) {
|
|
276
|
+
return true;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
return false;
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* Adds `{ id: 'validated', operation: 'remove' }` to a REGISTER action's
|
|
283
|
+
* `flags` array. Skips if any `validated` flag entry is already present —
|
|
284
|
+
* this keeps the codemod idempotent and avoids stomping on an intentional
|
|
285
|
+
* `add` op a maintainer may have authored manually.
|
|
286
|
+
*
|
|
287
|
+
* Returns true if a change was made.
|
|
288
|
+
*/
|
|
289
|
+
function ensureRegisterRemovesValidatedFlag(action) {
|
|
290
|
+
const entry = `{ id: '${VALIDATED_FLAG_VALUE}', operation: 'remove' }`;
|
|
291
|
+
const flagsProp = action.getProperty(FLAGS_PROPERTY_NAME);
|
|
292
|
+
if (flagsProp && ts_morph_1.Node.isPropertyAssignment(flagsProp)) {
|
|
293
|
+
const flagsInit = flagsProp.getInitializer();
|
|
294
|
+
if (flagsInit && ts_morph_1.Node.isArrayLiteralExpression(flagsInit)) {
|
|
295
|
+
if (arrayHasElementWithId(flagsInit, VALIDATED_FLAG_VALUE))
|
|
296
|
+
return false;
|
|
297
|
+
flagsInit.addElement(entry);
|
|
298
|
+
return true;
|
|
299
|
+
}
|
|
300
|
+
return false;
|
|
301
|
+
}
|
|
302
|
+
action.addPropertyAssignment({
|
|
303
|
+
name: FLAGS_PROPERTY_NAME,
|
|
304
|
+
initializer: `[${entry}]`
|
|
305
|
+
});
|
|
306
|
+
return true;
|
|
307
|
+
}
|
|
233
308
|
function processFile(filePath, project) {
|
|
234
309
|
const sourceFile = project.getSourceFile(filePath);
|
|
235
310
|
if (!sourceFile)
|
|
@@ -297,6 +372,20 @@ function processFile(filePath, project) {
|
|
|
297
372
|
});
|
|
298
373
|
console.log(` [${path_1.default.relative(process.cwd(), filePath)}] Added top-level 'flags' array to defineConfig`);
|
|
299
374
|
}
|
|
375
|
+
// Close the `validated` flag's lifecycle: when the validate action adds the
|
|
376
|
+
// flag, the matching REGISTER action(s) must remove it on registration.
|
|
377
|
+
if (configHadValidateAction) {
|
|
378
|
+
for (const element of actionsInitializer.getElements()) {
|
|
379
|
+
if (!ts_morph_1.Node.isObjectLiteralExpression(element))
|
|
380
|
+
continue;
|
|
381
|
+
if (!isRegisterAction(element))
|
|
382
|
+
continue;
|
|
383
|
+
if (ensureRegisterRemovesValidatedFlag(element)) {
|
|
384
|
+
transformedCount++;
|
|
385
|
+
console.log(` [${path_1.default.relative(process.cwd(), filePath)}] Added '${VALIDATED_FLAG_VALUE}' remove-flag to REGISTER action`);
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
}
|
|
300
389
|
if (fileNeedsImports) {
|
|
301
390
|
ensureImports(sourceFile);
|
|
302
391
|
}
|
|
@@ -338,6 +427,6 @@ function main() {
|
|
|
338
427
|
yield sourceFile.save();
|
|
339
428
|
console.log(` Saved: ${path_1.default.relative(process.cwd(), filePath)}`);
|
|
340
429
|
}
|
|
341
|
-
console.log(`\nDone.
|
|
430
|
+
console.log(`\nDone. Applied ${totalTransformed} change(s): VALIDATE → CUSTOM (${VALIDATE_DECLARATION_VALUE}) and '${VALIDATED_FLAG_VALUE}' remove-flag on matching REGISTER actions.`);
|
|
342
431
|
});
|
|
343
432
|
}
|
|
@@ -226,12 +226,14 @@ var SystemScopeType = z2.enum([
|
|
|
226
226
|
"organisation.read-locations",
|
|
227
227
|
"user.read",
|
|
228
228
|
"user.create",
|
|
229
|
-
"user.edit"
|
|
229
|
+
"user.edit",
|
|
230
|
+
"user.search"
|
|
230
231
|
]);
|
|
231
232
|
var UserScopeType = SystemScopeType.extract([
|
|
232
233
|
"user.read",
|
|
233
234
|
"user.create",
|
|
234
|
-
"user.edit"
|
|
235
|
+
"user.edit",
|
|
236
|
+
"user.search"
|
|
235
237
|
]);
|
|
236
238
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
237
239
|
var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
@@ -240,7 +242,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
|
240
242
|
options: AllUserScopeOptions.optional()
|
|
241
243
|
}),
|
|
242
244
|
z2.object({
|
|
243
|
-
type: UserScopeType.extract(["user.read"]),
|
|
245
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
244
246
|
options: AccessLevelOptions.optional()
|
|
245
247
|
})
|
|
246
248
|
]);
|
package/dist/scopes/index.d.ts
CHANGED
|
@@ -227,12 +227,14 @@ declare const SystemScopeType: z.ZodEnum<{
|
|
|
227
227
|
"user.read": "user.read";
|
|
228
228
|
"user.create": "user.create";
|
|
229
229
|
"user.edit": "user.edit";
|
|
230
|
+
"user.search": "user.search";
|
|
230
231
|
}>;
|
|
231
232
|
export type SystemScopeType = z.infer<typeof SystemScopeType>;
|
|
232
233
|
declare const UserScopeType: z.ZodEnum<{
|
|
233
234
|
"user.read": "user.read";
|
|
234
235
|
"user.create": "user.create";
|
|
235
236
|
"user.edit": "user.edit";
|
|
237
|
+
"user.search": "user.search";
|
|
236
238
|
}>;
|
|
237
239
|
export type UserScopeType = z.infer<typeof UserScopeType>;
|
|
238
240
|
declare const ScopesWithRoleOption: z.ZodEnum<{
|
|
@@ -256,6 +258,7 @@ export declare const UserScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
256
258
|
}, z.core.$strip>, z.ZodObject<{
|
|
257
259
|
type: z.ZodEnum<{
|
|
258
260
|
"user.read": "user.read";
|
|
261
|
+
"user.search": "user.search";
|
|
259
262
|
}>;
|
|
260
263
|
options: z.ZodOptional<z.ZodObject<{
|
|
261
264
|
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
@@ -493,6 +496,7 @@ export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
493
496
|
}, z.core.$strip>, z.ZodObject<{
|
|
494
497
|
type: z.ZodEnum<{
|
|
495
498
|
"user.read": "user.read";
|
|
499
|
+
"user.search": "user.search";
|
|
496
500
|
}>;
|
|
497
501
|
options: z.ZodOptional<z.ZodObject<{
|
|
498
502
|
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
@@ -556,6 +560,7 @@ export declare const ScopeType: z.ZodEnum<{
|
|
|
556
560
|
"user.read": "user.read";
|
|
557
561
|
"user.create": "user.create";
|
|
558
562
|
"user.edit": "user.edit";
|
|
563
|
+
"user.search": "user.search";
|
|
559
564
|
workqueue: "workqueue";
|
|
560
565
|
"dashboard.view": "dashboard.view";
|
|
561
566
|
}>;
|
|
@@ -635,7 +640,7 @@ export declare const decodeScope: (query: EncodedScope) => {
|
|
|
635
640
|
role?: string[] | undefined;
|
|
636
641
|
} | undefined;
|
|
637
642
|
} | {
|
|
638
|
-
type: "user.read";
|
|
643
|
+
type: "user.read" | "user.search";
|
|
639
644
|
options?: {
|
|
640
645
|
accessLevel?: "administrativeArea" | "location" | "all" | undefined;
|
|
641
646
|
} | undefined;
|
package/dist/scopes/index.js
CHANGED
|
@@ -257,12 +257,14 @@ var SystemScopeType = z3.enum([
|
|
|
257
257
|
"organisation.read-locations",
|
|
258
258
|
"user.read",
|
|
259
259
|
"user.create",
|
|
260
|
-
"user.edit"
|
|
260
|
+
"user.edit",
|
|
261
|
+
"user.search"
|
|
261
262
|
]);
|
|
262
263
|
var UserScopeType = SystemScopeType.extract([
|
|
263
264
|
"user.read",
|
|
264
265
|
"user.create",
|
|
265
|
-
"user.edit"
|
|
266
|
+
"user.edit",
|
|
267
|
+
"user.search"
|
|
266
268
|
]);
|
|
267
269
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
268
270
|
var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
@@ -271,7 +273,7 @@ var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
|
271
273
|
options: AllUserScopeOptions.optional()
|
|
272
274
|
}),
|
|
273
275
|
z3.object({
|
|
274
|
-
type: UserScopeType.extract(["user.read"]),
|
|
276
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
275
277
|
options: AccessLevelOptions.optional()
|
|
276
278
|
})
|
|
277
279
|
]);
|