@opencrvs/toolkit 2.0.0-rc.d37719f → 2.0.0-rc.d37a6e5
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 +17 -23
- package/dist/cli.js +300 -125
- package/dist/commons/api/router.d.ts +27 -20
- package/dist/commons/conditionals/conditionals.d.ts +3 -3
- package/dist/commons/events/ActionInput.d.ts +36 -0
- package/dist/commons/events/Draft.d.ts +1 -0
- 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 +73 -23
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
- package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
- package/dist/migrations/v2.0/index.d.ts +5 -3
- package/dist/migrations/v2.0/index.d.ts.map +1 -1
- package/dist/migrations/v2.0/index.js +300 -125
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
- package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
- package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-scopes.js +54 -30
- package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
- package/dist/notification/index.js +18 -23
- package/dist/scopes/index.d.ts +6 -1
- package/dist/scopes/index.js +5 -3
- package/opencrvs-toolkit-2.0.0-rc.d37a6e5.tgz +0 -0
- package/package.json +1 -1
- package/opencrvs-toolkit-2.0.0-rc.d37719f.tgz +0 -0
|
@@ -73,5 +73,26 @@ export declare function canAccessOtherUserWithScopes({ scopes, userToAccess, use
|
|
|
73
73
|
* One of the scopes must allow access for the event to be accessible.
|
|
74
74
|
*/
|
|
75
75
|
export declare function userCanAccessEventWithScopes(event: Partial<EventIndexWithAdministrativeHierarchy>, scopes: RecordScopeV2[], user: UserContext | SystemContext, customActionType?: string): boolean;
|
|
76
|
+
export declare function getAdministrativeAreaHierarchy(administrativeAreaId: string | undefined | null, administrativeAreas: Map<UUID, AdministrativeArea>): {
|
|
77
|
+
id: string & z.core.$brand<"UUID">;
|
|
78
|
+
name: string;
|
|
79
|
+
parentId: (string & z.core.$brand<"UUID">) | null;
|
|
80
|
+
validUntil: string | null;
|
|
81
|
+
externalId?: string | null | undefined;
|
|
82
|
+
}[];
|
|
83
|
+
/**
|
|
84
|
+
* Resolves a location or administrative area UUID into a root-first hierarchy of UUIDs.
|
|
85
|
+
*
|
|
86
|
+
* If the ID refers to a `Location` (e.g. CRVS office), the hierarchy includes
|
|
87
|
+
* the administrative area ancestors followed by the location itself.
|
|
88
|
+
* If the ID refers to an `AdministrativeArea`, returns the area's ancestor chain (root-first).
|
|
89
|
+
*
|
|
90
|
+
* Uses `getAdministrativeAreaHierarchy` which returns leaf-first order,
|
|
91
|
+
* so the result is reversed to match the root-first convention used by the server.
|
|
92
|
+
*/
|
|
93
|
+
export declare function getLocationHierarchy(selectedId: UUID, context: {
|
|
94
|
+
administrativeAreas: Map<UUID, AdministrativeArea>;
|
|
95
|
+
locations: Map<UUID, Location>;
|
|
96
|
+
}): UUID[];
|
|
76
97
|
export {};
|
|
77
98
|
//# sourceMappingURL=locations.d.ts.map
|
|
@@ -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
|
]);
|
|
@@ -1409,28 +1414,20 @@ function schemaPriority(schema) {
|
|
|
1409
1414
|
return idx === -1 ? 9999 : idx;
|
|
1410
1415
|
}
|
|
1411
1416
|
function safeUnion(schemas) {
|
|
1417
|
+
const sortedSchemas = [...schemas].sort(
|
|
1418
|
+
(a, b) => schemaPriority(a) - schemaPriority(b)
|
|
1419
|
+
);
|
|
1412
1420
|
return z12.any().superRefine((val, ctx) => {
|
|
1413
|
-
const
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
if (successful.length === 0) {
|
|
1418
|
-
ctx.addIssue({
|
|
1419
|
-
code: "invalid_type",
|
|
1420
|
-
expected: "custom",
|
|
1421
|
-
message: "Value does not match any schema"
|
|
1422
|
-
});
|
|
1423
|
-
return;
|
|
1424
|
-
}
|
|
1425
|
-
successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
|
|
1426
|
-
const best = successful[0];
|
|
1427
|
-
if (!best.safeParse(val).success) {
|
|
1428
|
-
ctx.addIssue({
|
|
1429
|
-
expected: "custom",
|
|
1430
|
-
code: "invalid_type",
|
|
1431
|
-
message: "Value did not match the best schema"
|
|
1432
|
-
});
|
|
1421
|
+
for (const schema of sortedSchemas) {
|
|
1422
|
+
if (schema.safeParse(val).success) {
|
|
1423
|
+
return;
|
|
1424
|
+
}
|
|
1433
1425
|
}
|
|
1426
|
+
ctx.addIssue({
|
|
1427
|
+
code: "invalid_type",
|
|
1428
|
+
expected: "custom",
|
|
1429
|
+
message: "Value does not match any schema"
|
|
1430
|
+
});
|
|
1434
1431
|
}).meta({
|
|
1435
1432
|
description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
|
|
1436
1433
|
});
|
|
@@ -5895,6 +5892,7 @@ var BaseActionInput = z38.object({
|
|
|
5895
5892
|
originalActionId: UUID.optional(),
|
|
5896
5893
|
// should not be part of base action.
|
|
5897
5894
|
keepAssignment: z38.boolean().optional(),
|
|
5895
|
+
waitFor: z38.boolean().optional(),
|
|
5898
5896
|
// For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
|
|
5899
5897
|
// @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
|
|
5900
5898
|
createdAtLocation: UUID.nullish().describe(
|
|
@@ -10001,6 +9999,39 @@ function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
|
|
|
10001
9999
|
(scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
|
|
10002
10000
|
);
|
|
10003
10001
|
}
|
|
10002
|
+
function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
|
|
10003
|
+
const collectedLocations = [];
|
|
10004
|
+
const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
|
|
10005
|
+
let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
|
|
10006
|
+
while (current) {
|
|
10007
|
+
collectedLocations.push(current);
|
|
10008
|
+
if (!current.parentId) {
|
|
10009
|
+
break;
|
|
10010
|
+
}
|
|
10011
|
+
const parentId = current.parentId;
|
|
10012
|
+
current = administrativeAreas.get(parentId);
|
|
10013
|
+
}
|
|
10014
|
+
return collectedLocations;
|
|
10015
|
+
}
|
|
10016
|
+
function getLocationHierarchy(selectedId, context) {
|
|
10017
|
+
const { administrativeAreas, locations } = context;
|
|
10018
|
+
const loc = locations.get(selectedId);
|
|
10019
|
+
if (loc) {
|
|
10020
|
+
if (loc.administrativeAreaId) {
|
|
10021
|
+
const hierarchy2 = getAdministrativeAreaHierarchy(
|
|
10022
|
+
loc.administrativeAreaId,
|
|
10023
|
+
administrativeAreas
|
|
10024
|
+
);
|
|
10025
|
+
return [...hierarchy2.reverse().map((area) => area.id), loc.id];
|
|
10026
|
+
}
|
|
10027
|
+
return [loc.id];
|
|
10028
|
+
}
|
|
10029
|
+
const hierarchy = getAdministrativeAreaHierarchy(
|
|
10030
|
+
selectedId,
|
|
10031
|
+
administrativeAreas
|
|
10032
|
+
);
|
|
10033
|
+
return hierarchy.reverse().map((area) => area.id);
|
|
10034
|
+
}
|
|
10004
10035
|
|
|
10005
10036
|
// ../commons/src/events/scopes.ts
|
|
10006
10037
|
var ACTION_SCOPE_MAP = {
|
|
@@ -10075,6 +10106,25 @@ function isActionInScope({
|
|
|
10075
10106
|
);
|
|
10076
10107
|
return canAccess;
|
|
10077
10108
|
}
|
|
10109
|
+
function getAvailableRolesForUserUpdatePayload({
|
|
10110
|
+
allRoles,
|
|
10111
|
+
userLocation,
|
|
10112
|
+
acceptedScopes,
|
|
10113
|
+
userRequesting
|
|
10114
|
+
}) {
|
|
10115
|
+
const availableRoles = allRoles.filter((role) => {
|
|
10116
|
+
const canAccess = canAccessOtherUserWithScopes({
|
|
10117
|
+
userToAccess: {
|
|
10118
|
+
...userLocation,
|
|
10119
|
+
role
|
|
10120
|
+
},
|
|
10121
|
+
user: userRequesting,
|
|
10122
|
+
scopes: acceptedScopes
|
|
10123
|
+
});
|
|
10124
|
+
return canAccess;
|
|
10125
|
+
});
|
|
10126
|
+
return availableRoles;
|
|
10127
|
+
}
|
|
10078
10128
|
|
|
10079
10129
|
// ../commons/src/events/serializers/user/deserializer.ts
|
|
10080
10130
|
function userDeserializer(serializedUserField, user2) {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export declare const UPSTREAM_URL = "https://github.com/opencrvs/opencrvs-countryconfig.git";
|
|
2
|
-
export declare const UPSTREAM_BRANCH = "
|
|
2
|
+
export declare const UPSTREAM_BRANCH = "release-v2.0.0";
|
|
3
3
|
/**
|
|
4
4
|
* Runs a git command in the country config working directory.
|
|
5
5
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"checkout-upstream-files.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/checkout-upstream-files.ts"],"names":[],"mappings":"AA8CA,eAAO,MAAM,YAAY,2DACiC,CAAA;
|
|
1
|
+
{"version":3,"file":"checkout-upstream-files.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/checkout-upstream-files.ts"],"names":[],"mappings":"AA8CA,eAAO,MAAM,YAAY,2DACiC,CAAA;AAE1D,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAc/C;;;;;;GAMG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,EAAE,EACd,EAAE,MAAc,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GAC5C,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAO9C;AAED,wBAAgB,eAAe,IAAI,IAAI,CAMtC;AAID,iBAAe,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAuDnC;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
|
|
@@ -59,8 +59,7 @@ exports.main = main;
|
|
|
59
59
|
*/
|
|
60
60
|
const child_process_1 = require("child_process");
|
|
61
61
|
exports.UPSTREAM_URL = 'https://github.com/opencrvs/opencrvs-countryconfig.git';
|
|
62
|
-
|
|
63
|
-
exports.UPSTREAM_BRANCH = 'develop';
|
|
62
|
+
exports.UPSTREAM_BRANCH = 'release-v2.0.0';
|
|
64
63
|
// Remote name used only for the duration of this codemod. Prefixed to avoid
|
|
65
64
|
// clashing with remotes the user may have (origin, upstream, etc.).
|
|
66
65
|
const TEMP_REMOTE = 'opencrvs-upgrade-v19-v20-codemod';
|
|
@@ -1,3 +1,11 @@
|
|
|
1
|
-
|
|
1
|
+
interface DeleteInfrastructureOptions {
|
|
2
|
+
/**
|
|
3
|
+
* Top-level entries directly under `infrastructure/` to preserve. Names
|
|
4
|
+
* match against the basename of each entry (file or directory). When
|
|
5
|
+
* empty (the default), the whole `infrastructure/` directory is deleted.
|
|
6
|
+
*/
|
|
7
|
+
keep?: string[];
|
|
8
|
+
}
|
|
9
|
+
declare function main({ keep }?: DeleteInfrastructureOptions): Promise<void>;
|
|
2
10
|
export { main };
|
|
3
11
|
//# sourceMappingURL=delete-infrastructure-directory.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"delete-infrastructure-directory.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/delete-infrastructure-directory.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"delete-infrastructure-directory.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/delete-infrastructure-directory.ts"],"names":[],"mappings":"AAoDA,UAAU,2BAA2B;IACnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,iBAAe,IAAI,CAAC,EAClB,IAAS,EACV,GAAE,2BAAgC,GAAG,OAAO,CAAC,IAAI,CAAC,CA4FlD;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
|
|
@@ -27,20 +27,28 @@ exports.main = main;
|
|
|
27
27
|
* via Docker Swarm. In that case the `infrastructure/` directory shipped
|
|
28
28
|
* with opencrvs-countryconfig is no longer needed and can be removed.
|
|
29
29
|
*
|
|
30
|
+
* Some non-Swarm deployments still need a small subset of
|
|
31
|
+
* `infrastructure/` (e.g. `postgres/` and `metabase/`). Pass `keep` to
|
|
32
|
+
* preserve those top-level subdirectories — everything else under
|
|
33
|
+
* `infrastructure/` is deleted, and the kept subdirectories can then be
|
|
34
|
+
* refreshed from upstream by `merge-infrastructure-directory.ts` with the
|
|
35
|
+
* matching `subdirs` option.
|
|
36
|
+
*
|
|
30
37
|
* Usage:
|
|
31
38
|
* ts-node -r tsconfig-paths/register src/migrations/v2.0/delete-infrastructure-directory.ts
|
|
32
39
|
*
|
|
33
40
|
* What it does:
|
|
34
41
|
* 1. Stages deletion of all tracked files under `infrastructure/` via
|
|
35
|
-
* `git rm -rf --ignore-unmatch --
|
|
36
|
-
*
|
|
42
|
+
* `git rm -rf --ignore-unmatch -- <path>`. This both removes the
|
|
43
|
+
* files from the working tree and records the deletion in the
|
|
37
44
|
* index, so it shows up in the upgrade commit alongside the other
|
|
38
|
-
* codemod changes.
|
|
45
|
+
* codemod changes. When `keep` is provided, deletion is scoped to
|
|
46
|
+
* the top-level entries that are NOT in `keep`.
|
|
39
47
|
* 2. Cleans up any untracked files / empty directory that `git rm` left
|
|
40
|
-
* behind, so the
|
|
48
|
+
* behind, so the deleted paths are fully gone from the working tree.
|
|
41
49
|
*
|
|
42
50
|
* Caveats:
|
|
43
|
-
* - Destructive: any local edits to
|
|
51
|
+
* - Destructive: any local edits to deleted paths are lost. Run on a
|
|
44
52
|
* clean working tree (or after committing your local changes).
|
|
45
53
|
* - If `infrastructure/` doesn't exist, this codemod is a no-op.
|
|
46
54
|
* - Requires git to be installed and the country config working directory
|
|
@@ -51,27 +59,65 @@ const path_1 = require("path");
|
|
|
51
59
|
const checkout_upstream_files_1 = require("./checkout-upstream-files");
|
|
52
60
|
const INFRASTRUCTURE_DIR = 'infrastructure';
|
|
53
61
|
function main() {
|
|
54
|
-
return __awaiter(this,
|
|
62
|
+
return __awaiter(this, arguments, void 0, function* ({ keep = [] } = {}) {
|
|
55
63
|
const fullPath = (0, path_1.join)(process.cwd(), INFRASTRUCTURE_DIR);
|
|
56
64
|
if (!(0, fs_1.existsSync)(fullPath)) {
|
|
57
65
|
console.log(`'${INFRASTRUCTURE_DIR}/' not found in ${process.cwd()} — nothing to delete.`);
|
|
58
66
|
return;
|
|
59
67
|
}
|
|
60
|
-
console.log(`Deleting '${INFRASTRUCTURE_DIR}/'...\n`);
|
|
61
68
|
(0, checkout_upstream_files_1.assertIsGitRepo)();
|
|
62
|
-
//
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
// ─── Whole-directory delete (legacy behavior) ────────────────────────
|
|
70
|
+
if (keep.length === 0) {
|
|
71
|
+
console.log(`Deleting '${INFRASTRUCTURE_DIR}/'...\n`);
|
|
72
|
+
// `git rm -rf --ignore-unmatch` removes tracked files (working tree +
|
|
73
|
+
// index) and is a no-op for paths with no tracked entries, so it's
|
|
74
|
+
// safe to run even when `infrastructure/` exists only as untracked
|
|
75
|
+
// files.
|
|
76
|
+
(0, checkout_upstream_files_1.runGit)(['rm', '-rf', '--ignore-unmatch', '--', `${INFRASTRUCTURE_DIR}/`], {
|
|
77
|
+
silent: true
|
|
78
|
+
});
|
|
79
|
+
console.log(` Staged deletion of tracked files under '${INFRASTRUCTURE_DIR}/'.`);
|
|
80
|
+
// `git rm` leaves untracked files (and any now-empty directory) on
|
|
81
|
+
// disk; remove whatever's left so the path is fully gone.
|
|
82
|
+
if ((0, fs_1.existsSync)(fullPath)) {
|
|
83
|
+
(0, fs_1.rmSync)(fullPath, { recursive: true, force: true });
|
|
84
|
+
console.log(` Removed remaining untracked files under '${INFRASTRUCTURE_DIR}/'.`);
|
|
85
|
+
}
|
|
86
|
+
console.log(`\n Done. Review the staged deletion with: git diff --cached -- '${INFRASTRUCTURE_DIR}/'`);
|
|
87
|
+
return;
|
|
88
|
+
}
|
|
89
|
+
// ─── Selective delete: keep listed top-level entries ─────────────────
|
|
90
|
+
const keepSet = new Set(keep);
|
|
91
|
+
console.log(`Deleting contents of '${INFRASTRUCTURE_DIR}/' except: ${[...keepSet]
|
|
92
|
+
.map((name) => `'${name}'`)
|
|
93
|
+
.join(', ')}\n`);
|
|
94
|
+
const topLevelEntries = (0, fs_1.readdirSync)(fullPath, { withFileTypes: true });
|
|
95
|
+
let deleted = 0;
|
|
96
|
+
for (const entry of topLevelEntries) {
|
|
97
|
+
if (keepSet.has(entry.name)) {
|
|
98
|
+
console.log(` Keeping '${INFRASTRUCTURE_DIR}/${entry.name}'.`);
|
|
99
|
+
continue;
|
|
100
|
+
}
|
|
101
|
+
// Append a trailing slash for directories so git treats it as a tree
|
|
102
|
+
// pathspec (matches the recursive behavior of `git rm -rf`).
|
|
103
|
+
const relPath = `${INFRASTRUCTURE_DIR}/${entry.name}${entry.isDirectory() ? '/' : ''}`;
|
|
104
|
+
(0, checkout_upstream_files_1.runGit)(['rm', '-rf', '--ignore-unmatch', '--', relPath], { silent: true });
|
|
105
|
+
const fullEntryPath = (0, path_1.join)(fullPath, entry.name);
|
|
106
|
+
if ((0, fs_1.existsSync)(fullEntryPath)) {
|
|
107
|
+
(0, fs_1.rmSync)(fullEntryPath, { recursive: true, force: true });
|
|
108
|
+
}
|
|
109
|
+
console.log(` Deleted '${relPath}'.`);
|
|
110
|
+
deleted++;
|
|
111
|
+
}
|
|
112
|
+
// Note any requested keeps that weren't actually present, so the dev
|
|
113
|
+
// notices typos / missing directories.
|
|
114
|
+
const presentNames = new Set(topLevelEntries.map((e) => e.name));
|
|
115
|
+
const missingKeeps = [...keepSet].filter((name) => !presentNames.has(name));
|
|
116
|
+
if (missingKeeps.length > 0) {
|
|
117
|
+
console.warn(` [warn] Requested to keep ${missingKeeps
|
|
118
|
+
.map((n) => `'${n}'`)
|
|
119
|
+
.join(', ')} but they don't exist under '${INFRASTRUCTURE_DIR}/'.`);
|
|
74
120
|
}
|
|
75
|
-
console.log(`\n Done. Review the staged
|
|
121
|
+
console.log(`\n Done. Deleted ${deleted} top-level entr${deleted === 1 ? 'y' : 'ies'}. Review the staged deletions with: git diff --cached -- '${INFRASTRUCTURE_DIR}/'`);
|
|
76
122
|
});
|
|
77
123
|
}
|
|
@@ -3,9 +3,11 @@
|
|
|
3
3
|
* directory.
|
|
4
4
|
*
|
|
5
5
|
* @param dockerSwarm - When true, the local `infrastructure/` directory is
|
|
6
|
-
* merged with upstream changes (Docker Swarm deployments
|
|
7
|
-
* When false (the default),
|
|
8
|
-
*
|
|
6
|
+
* merged with upstream changes in its entirety (Docker Swarm deployments
|
|
7
|
+
* still need it all). When false (the default), everything under
|
|
8
|
+
* `infrastructure/` is deleted EXCEPT the subdirectories listed in
|
|
9
|
+
* `NON_SWARM_INFRA_SUBDIRS`, and those preserved subdirectories are then
|
|
10
|
+
* merged with upstream.
|
|
9
11
|
*/
|
|
10
12
|
export declare function runUpgrade(dockerSwarm: boolean): Promise<void>;
|
|
11
13
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/index.ts"],"names":[],"mappings":"AA6CA;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAAC,WAAW,EAAE,OAAO,iBAgCpD"}
|