@opencrvs/toolkit 2.2.0-rc.3af310b → 2.2.0-rc.5bf5dfc
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/build.sh +7 -2
- package/dist/application-config/index.js +9 -9
- package/dist/authentication/index.d.ts +2 -1
- package/dist/authentication/index.js +20 -12
- package/dist/cli.js +633 -333
- package/dist/commons/api/router.d.ts +249 -249
- package/dist/commons/application-config/index.d.ts +2 -2
- package/dist/commons/conditionals/conditionals.d.ts +4 -4
- package/dist/commons/conditionals/index.d.ts +1 -0
- package/dist/commons/conditionals/validate.d.ts +6 -1
- package/dist/commons/events/ActionConfig.d.ts +2 -2
- package/dist/commons/events/ActionDocument.d.ts +1 -0
- package/dist/commons/events/ActionInput.d.ts +4 -4
- package/dist/commons/events/ActionStatus.d.ts +2 -2
- package/dist/commons/events/ActionType.d.ts +2 -0
- package/dist/commons/events/AdvancedSearchConfig.d.ts +3 -0
- package/dist/commons/events/CompositeFieldValue.d.ts +5 -1
- package/dist/commons/events/Draft.d.ts +34 -1
- package/dist/commons/events/EventConfig.d.ts +1 -10
- package/dist/commons/events/EventIndex.d.ts +2 -2
- package/dist/commons/events/FieldConfig.d.ts +1 -1
- package/dist/commons/events/FieldTypeMapping.d.ts +17 -17
- package/dist/commons/events/Flag.d.ts +1 -1
- package/dist/commons/events/PlainDate.d.ts +1 -0
- package/dist/commons/events/eventConfigValidation.d.ts +1 -1
- package/dist/commons/events/field.d.ts +5 -0
- package/dist/commons/events/index.d.ts +3 -0
- package/dist/commons/events/locations.d.ts +1 -1
- package/dist/commons/events/scopes.d.ts +2 -1
- package/dist/commons/events/test.utils.d.ts +5 -6
- package/dist/commons/events/toNotificationForm.d.ts +17 -0
- package/dist/commons/events/utils.d.ts +26 -5
- package/dist/commons/users/Role.d.ts +23 -0
- package/dist/commons/users/User.d.ts +263 -0
- package/dist/commons/users/authentication.d.ts +67 -0
- package/dist/commons/users/index.d.ts +5 -0
- package/dist/commons/users/roleValidations.d.ts +15 -0
- package/dist/commons/users/scopes.d.ts +1402 -0
- package/dist/commons/users/userReferences.d.ts +176 -0
- package/dist/conditionals/index.js +5 -5
- package/dist/environment/custom-types.d.ts +1 -0
- package/dist/environment/custom-types.d.ts.map +1 -1
- package/dist/environment/derived-variables.d.ts +6 -4
- package/dist/environment/derived-variables.d.ts.map +1 -1
- package/dist/environment/derived-variables.js +6 -4
- package/dist/environment/questions.d.ts +42 -9
- package/dist/environment/questions.d.ts.map +1 -1
- package/dist/environment/questions.js +70 -47
- package/dist/environment/registry.d.ts +15 -0
- package/dist/environment/registry.d.ts.map +1 -0
- package/dist/environment/registry.js +112 -0
- package/dist/environment/setup-environment.d.ts.map +1 -1
- package/dist/environment/setup-environment.js +85 -29
- package/dist/events/index.js +214 -152
- package/dist/migrations/add-notify-config.d.ts +40 -0
- package/dist/migrations/add-notify-config.d.ts.map +1 -0
- package/dist/migrations/add-notify-config.js +249 -0
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +345 -143
- package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -1
- package/dist/migrations/move-declaration-to-declare-action.js +27 -144
- package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -1
- package/dist/migrations/read-declaration-through-helper.js +3 -61
- package/dist/migrations/utils.d.ts +61 -0
- package/dist/migrations/utils.d.ts.map +1 -0
- package/dist/migrations/utils.js +218 -0
- package/dist/notification/index.js +282 -90
- package/dist/roles/index.d.ts +2 -0
- package/dist/roles/index.d.ts.map +1 -0
- package/dist/roles/index.js +719 -0
- package/dist/scopes/index.d.ts +54 -61
- package/dist/scopes/index.js +15 -11
- package/dist/templates/charts-values/opencrvs-services/values.yaml +3 -4
- package/opencrvs-toolkit-2.2.0-rc.5bf5dfc.tgz +0 -0
- package/package.json +5 -3
- package/tsconfig.build.tsbuildinfo +1 -1
- package/tsconfig.json +3 -5
- package/dist/commons/events/notificationFormFallback.d.ts +0 -10
- package/dist/environment/dockerhub.d.ts +0 -15
- package/dist/environment/dockerhub.d.ts.map +0 -1
- package/dist/environment/dockerhub.js +0 -104
- package/opencrvs-toolkit-2.2.0-rc.3af310b.tgz +0 -0
package/build.sh
CHANGED
|
@@ -25,6 +25,8 @@ mkdir -p ./dist/commons/events
|
|
|
25
25
|
cp -r ../commons/build/dist/common/events/*.d.ts ./dist/commons/events
|
|
26
26
|
mkdir -p ./dist/commons/events/state
|
|
27
27
|
cp -r ../commons/build/dist/common/events/state/*.d.ts ./dist/commons/events/state
|
|
28
|
+
mkdir -p ./dist/commons/users
|
|
29
|
+
cp -r ../commons/build/dist/common/users/*.d.ts ./dist/commons/users
|
|
28
30
|
|
|
29
31
|
# Build common conditionals
|
|
30
32
|
npx esbuild src/conditionals/index.ts --bundle --format=cjs --outdir=./dist/conditionals --allow-overwrite --packages=external
|
|
@@ -33,11 +35,14 @@ cp -r ../commons/build/dist/common/conditionals/*.d.ts ./dist/commons/conditiona
|
|
|
33
35
|
|
|
34
36
|
# Build common scopes
|
|
35
37
|
npx esbuild src/scopes/index.ts --bundle --format=cjs --outdir=./dist/scopes --allow-overwrite --packages=external
|
|
36
|
-
cp -r ../commons/build/dist/common/scopes.d.ts ./dist/scopes/index.d.ts
|
|
38
|
+
cp -r ../commons/build/dist/common/users/scopes.d.ts ./dist/scopes/index.d.ts
|
|
39
|
+
|
|
40
|
+
# Build common roles (.d.ts points at dist/commons/users, copied with the events types)
|
|
41
|
+
npx esbuild src/roles/index.ts --bundle --format=cjs --outdir=./dist/roles --allow-overwrite --packages=external
|
|
37
42
|
|
|
38
43
|
# Build common authentication
|
|
39
44
|
npx esbuild src/authentication/index.ts --bundle --format=cjs --outdir=./dist/authentication --allow-overwrite --packages=external
|
|
40
|
-
cp -r ../commons/build/dist/common/authentication.d.ts ./dist/authentication/index.d.ts
|
|
45
|
+
cp -r ../commons/build/dist/common/users/authentication.d.ts ./dist/authentication/index.d.ts
|
|
41
46
|
|
|
42
47
|
# Build api client
|
|
43
48
|
npx esbuild src/api/index.ts --bundle --format=cjs --outdir=./dist/api --allow-overwrite --packages=external
|
|
@@ -218,7 +218,7 @@ var z7 = __toESM(require("zod/v4"));
|
|
|
218
218
|
// ../commons/src/documents.ts
|
|
219
219
|
var z4 = __toESM(require("zod/v4"));
|
|
220
220
|
var FullDocumentUrl = z4.string().brand("FullDocumentUrl").describe(
|
|
221
|
-
"A full url with protocol, host, bucket name, starting from the root of the S3 server, https://
|
|
221
|
+
"A full url with protocol, host, bucket name, starting from the root of the S3 server, https://s3.opencrvs.com/bucket-name/document-id.jpg"
|
|
222
222
|
);
|
|
223
223
|
var FullDocumentPath = z4.string().overwrite((val) => val.startsWith("/") ? val : `/${val}`).meta({ effectType: "input", type: "string" }).describe(
|
|
224
224
|
"A full absolute path with bucket name, starting from the root of the S3 server, /bucket-name/document-id.jpg"
|
|
@@ -228,7 +228,7 @@ var DocumentPath = z4.string().brand("DocumentPath").describe(
|
|
|
228
228
|
);
|
|
229
229
|
|
|
230
230
|
// ../commons/src/events/CompositeFieldValue.ts
|
|
231
|
-
var z5 = __toESM(require("zod
|
|
231
|
+
var z5 = __toESM(require("zod"));
|
|
232
232
|
var AddressType = {
|
|
233
233
|
DOMESTIC: "DOMESTIC",
|
|
234
234
|
INTERNATIONAL: "INTERNATIONAL"
|
|
@@ -433,7 +433,7 @@ function safeUnion(schemas) {
|
|
|
433
433
|
);
|
|
434
434
|
return z7.any().superRefine((val, ctx) => {
|
|
435
435
|
for (const schema of sortedSchemas) {
|
|
436
|
-
if (schema.
|
|
436
|
+
if (schema.validate(val)) {
|
|
437
437
|
return;
|
|
438
438
|
}
|
|
439
439
|
}
|
|
@@ -619,11 +619,11 @@ var META_ACTIONS = [
|
|
|
619
619
|
ActionType.READ
|
|
620
620
|
];
|
|
621
621
|
|
|
622
|
-
// ../commons/src/authentication.ts
|
|
622
|
+
// ../commons/src/users/authentication.ts
|
|
623
623
|
var import_jwt_decode = __toESM(require("jwt-decode"));
|
|
624
624
|
var z14 = __toESM(require("zod/v4"));
|
|
625
625
|
|
|
626
|
-
// ../commons/src/scopes.ts
|
|
626
|
+
// ../commons/src/users/scopes.ts
|
|
627
627
|
var z13 = __toESM(require("zod/v4"));
|
|
628
628
|
var qs = __toESM(require("qs"));
|
|
629
629
|
|
|
@@ -635,7 +635,7 @@ var ActionStatus = {
|
|
|
635
635
|
};
|
|
636
636
|
|
|
637
637
|
// ../commons/src/events/Flag.ts
|
|
638
|
-
var z11 = __toESM(require("zod
|
|
638
|
+
var z11 = __toESM(require("zod"));
|
|
639
639
|
var InherentFlags = {
|
|
640
640
|
REJECTED: "rejected",
|
|
641
641
|
CORRECTION_REQUESTED: "correction-requested",
|
|
@@ -664,7 +664,7 @@ var CustomFlag = z11.string().refine((val) => !Object.values(InherentFlags).incl
|
|
|
664
664
|
message: `Custom flag cannot be one of the inherent flags: ${Object.values(
|
|
665
665
|
InherentFlags
|
|
666
666
|
).join(", ")}`
|
|
667
|
-
}).refine((val) => !ActionFlag.
|
|
667
|
+
}).refine((val) => !ActionFlag.validate(val), {
|
|
668
668
|
message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
|
|
669
669
|
}).describe("Custom flag identifier defined by the country config.");
|
|
670
670
|
var Flag = ActionFlag.or(z11.enum(InherentFlags)).or(CustomFlag);
|
|
@@ -707,7 +707,7 @@ var EventStatus = z12.enum([
|
|
|
707
707
|
"ARCHIVED"
|
|
708
708
|
]);
|
|
709
709
|
|
|
710
|
-
// ../commons/src/scopes.ts
|
|
710
|
+
// ../commons/src/users/scopes.ts
|
|
711
711
|
var JurisdictionFilter = z13.enum(["administrativeArea", "location", "all"]).describe(
|
|
712
712
|
"Filters based on user jurisdiction relative to their office location in hierarchy."
|
|
713
713
|
);
|
|
@@ -980,7 +980,7 @@ var DEFAULT_SCOPE_OPTIONS = {
|
|
|
980
980
|
registeredIn: JurisdictionFilter.enum.all
|
|
981
981
|
};
|
|
982
982
|
|
|
983
|
-
// ../commons/src/authentication.ts
|
|
983
|
+
// ../commons/src/users/authentication.ts
|
|
984
984
|
var TokenUserType = z14.enum(["user", "system"]);
|
|
985
985
|
var TokenWithBearer = z14.string().regex(/^Bearer\s/);
|
|
986
986
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Nominal } from '
|
|
1
|
+
import { Nominal } from '../nominal';
|
|
2
2
|
import * as z from 'zod/v4';
|
|
3
3
|
import { ScopeType, Scope, EncodedScope } from './scopes';
|
|
4
4
|
export * from './scopes';
|
|
@@ -63,4 +63,5 @@ export declare const getUserTypeFromToken: (token: TokenWithBearer) => TokenUser
|
|
|
63
63
|
export declare const TokenWithBearer: z.ZodType<`Bearer ${string}`>;
|
|
64
64
|
export type TokenWithBearer = z.infer<typeof TokenWithBearer>;
|
|
65
65
|
export type Token = Nominal<string, 'TokenWithoutBearer'>;
|
|
66
|
+
export declare function isTokenWithBearer(value: unknown): value is TokenWithBearer;
|
|
66
67
|
//# sourceMappingURL=authentication.d.ts.map
|
|
@@ -48,8 +48,8 @@ __export(authentication_exports, {
|
|
|
48
48
|
UserFilter: () => UserFilter,
|
|
49
49
|
UserScopeV2: () => UserScopeV2,
|
|
50
50
|
canUserCreateEvent: () => canUserCreateEvent,
|
|
51
|
+
canUserNotifyEvent: () => canUserNotifyEvent,
|
|
51
52
|
decodeScope: () => decodeScope,
|
|
52
|
-
defineRoles: () => defineRoles,
|
|
53
53
|
defineScopes: () => defineScopes,
|
|
54
54
|
encodeScope: () => encodeScope,
|
|
55
55
|
getAcceptedScopesByType: () => getAcceptedScopesByType,
|
|
@@ -62,8 +62,10 @@ __export(authentication_exports, {
|
|
|
62
62
|
getUserTypeFromToken: () => getUserTypeFromToken,
|
|
63
63
|
hasAnyScope: () => hasAnyScope,
|
|
64
64
|
hasScope: () => hasScope,
|
|
65
|
+
hasScopeForEventType: () => hasScopeForEventType,
|
|
65
66
|
isCustomActionScope: () => isCustomActionScope,
|
|
66
67
|
isServiceToken: () => isServiceToken,
|
|
68
|
+
isTokenWithBearer: () => isTokenWithBearer,
|
|
67
69
|
scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
|
|
68
70
|
scopeUsesFullOptions: () => scopeUsesFullOptions,
|
|
69
71
|
scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
|
|
@@ -73,11 +75,11 @@ __export(authentication_exports, {
|
|
|
73
75
|
module.exports = __toCommonJS(authentication_exports);
|
|
74
76
|
var z9 = __toESM(require("zod/v4"));
|
|
75
77
|
|
|
76
|
-
// ../commons/src/authentication.ts
|
|
78
|
+
// ../commons/src/users/authentication.ts
|
|
77
79
|
var import_jwt_decode = __toESM(require("jwt-decode"));
|
|
78
80
|
var z8 = __toESM(require("zod/v4"));
|
|
79
81
|
|
|
80
|
-
// ../commons/src/scopes.ts
|
|
82
|
+
// ../commons/src/users/scopes.ts
|
|
81
83
|
var z7 = __toESM(require("zod/v4"));
|
|
82
84
|
var qs = __toESM(require("qs"));
|
|
83
85
|
|
|
@@ -210,7 +212,7 @@ var ActionStatus = {
|
|
|
210
212
|
};
|
|
211
213
|
|
|
212
214
|
// ../commons/src/events/Flag.ts
|
|
213
|
-
var z5 = __toESM(require("zod
|
|
215
|
+
var z5 = __toESM(require("zod"));
|
|
214
216
|
|
|
215
217
|
// ../commons/src/events/TranslationConfig.ts
|
|
216
218
|
var z3 = __toESM(require("zod/v4"));
|
|
@@ -306,7 +308,7 @@ var CustomFlag = z5.string().refine((val) => !Object.values(InherentFlags).inclu
|
|
|
306
308
|
message: `Custom flag cannot be one of the inherent flags: ${Object.values(
|
|
307
309
|
InherentFlags
|
|
308
310
|
).join(", ")}`
|
|
309
|
-
}).refine((val) => !ActionFlag.
|
|
311
|
+
}).refine((val) => !ActionFlag.validate(val), {
|
|
310
312
|
message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
|
|
311
313
|
}).describe("Custom flag identifier defined by the country config.");
|
|
312
314
|
var Flag = ActionFlag.or(z5.enum(InherentFlags)).or(CustomFlag);
|
|
@@ -349,7 +351,7 @@ var EventStatus = z6.enum([
|
|
|
349
351
|
"ARCHIVED"
|
|
350
352
|
]);
|
|
351
353
|
|
|
352
|
-
// ../commons/src/scopes.ts
|
|
354
|
+
// ../commons/src/users/scopes.ts
|
|
353
355
|
var JurisdictionFilter = z7.enum(["administrativeArea", "location", "all"]).describe(
|
|
354
356
|
"Filters based on user jurisdiction relative to their office location in hierarchy."
|
|
355
357
|
);
|
|
@@ -703,9 +705,9 @@ function hasScope(tokenOrScopes, scope) {
|
|
|
703
705
|
}
|
|
704
706
|
return hasAnyScope(tokenOrScopes, [scope]);
|
|
705
707
|
}
|
|
706
|
-
function
|
|
708
|
+
function hasScopeForEventType(userScopes, eventType, acceptedScope) {
|
|
707
709
|
const scopes = getAcceptedScopesByType({
|
|
708
|
-
acceptedScopes: [
|
|
710
|
+
acceptedScopes: [acceptedScope],
|
|
709
711
|
scopes: userScopes
|
|
710
712
|
});
|
|
711
713
|
return scopes.some((scope) => {
|
|
@@ -715,14 +717,17 @@ function canUserCreateEvent(userScopes, eventType) {
|
|
|
715
717
|
return scope.options?.event?.includes(eventType);
|
|
716
718
|
});
|
|
717
719
|
}
|
|
720
|
+
function canUserCreateEvent(userScopes, eventType) {
|
|
721
|
+
return hasScopeForEventType(userScopes, eventType, "record.create");
|
|
722
|
+
}
|
|
723
|
+
function canUserNotifyEvent(userScopes, eventType) {
|
|
724
|
+
return hasScopeForEventType(userScopes, eventType, "record.notify");
|
|
725
|
+
}
|
|
718
726
|
function defineScopes(scopes) {
|
|
719
727
|
return scopes.map((scope) => Scope.parse(scope)).map(encodeScope);
|
|
720
728
|
}
|
|
721
|
-
function defineRoles(roles) {
|
|
722
|
-
return roles;
|
|
723
|
-
}
|
|
724
729
|
|
|
725
|
-
// ../commons/src/authentication.ts
|
|
730
|
+
// ../commons/src/users/authentication.ts
|
|
726
731
|
function getAcceptedScopesFromToken(token, acceptedScopes) {
|
|
727
732
|
const tokenScopes = getScopes(token);
|
|
728
733
|
return tokenScopes.map((scope) => {
|
|
@@ -772,6 +777,9 @@ var getUserTypeFromToken = (token) => {
|
|
|
772
777
|
return TokenUserType.parse(tokenPayload.userType);
|
|
773
778
|
};
|
|
774
779
|
var TokenWithBearer = z8.string().regex(/^Bearer\s/);
|
|
780
|
+
function isTokenWithBearer(value) {
|
|
781
|
+
return TokenWithBearer.validate(value);
|
|
782
|
+
}
|
|
775
783
|
|
|
776
784
|
// src/authentication/index.ts
|
|
777
785
|
z9.globalRegistry.clear();
|