@opencrvs/toolkit 2.0.0-rc.cedcafb → 2.0.0-rc.d7cb6e7
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 +35 -7
- package/dist/cli.js +35 -7
- 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/index.js +35 -7
- 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.d7cb6e7.tgz +0 -0
- package/package.json +1 -1
- package/opencrvs-toolkit-2.0.0-rc.cedcafb.tgz +0 -0
|
@@ -656,6 +656,10 @@ var scopeByEvent = z11.preprocess(
|
|
|
656
656
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
657
657
|
z11.array(z11.string()).optional()
|
|
658
658
|
).describe("Event type, e.g. birth, death");
|
|
659
|
+
var userRole = z11.preprocess(
|
|
660
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
661
|
+
z11.array(z11.string()).optional()
|
|
662
|
+
).describe("User role, e.g. admin, field agent");
|
|
659
663
|
var scopeOptionsPlaceEvent = z11.object({
|
|
660
664
|
event: scopeByEvent,
|
|
661
665
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -679,6 +683,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
679
683
|
var AccessLevelOptions = z11.object({
|
|
680
684
|
accessLevel: JurisdictionFilter.optional()
|
|
681
685
|
});
|
|
686
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
687
|
+
role: userRole.optional()
|
|
688
|
+
});
|
|
682
689
|
var WorkqueueOrDashboardOptions = z11.object({
|
|
683
690
|
ids: z11.preprocess(
|
|
684
691
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -688,6 +695,7 @@ var WorkqueueOrDashboardOptions = z11.object({
|
|
|
688
695
|
var AllScopeOptions = z11.object({
|
|
689
696
|
...AllRecordScopeOptions.shape,
|
|
690
697
|
...AccessLevelOptions.shape,
|
|
698
|
+
...AllUserScopeOptions.shape,
|
|
691
699
|
...WorkqueueOrDashboardOptions.shape
|
|
692
700
|
});
|
|
693
701
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -760,6 +768,28 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
|
|
|
760
768
|
]).describe(
|
|
761
769
|
"Scopes used to check user's permission to perform actions on a record."
|
|
762
770
|
);
|
|
771
|
+
var SystemScopeType = z11.enum([
|
|
772
|
+
"organisation.read-locations",
|
|
773
|
+
"user.read",
|
|
774
|
+
"user.create",
|
|
775
|
+
"user.edit"
|
|
776
|
+
]);
|
|
777
|
+
var UserScopeType = SystemScopeType.extract([
|
|
778
|
+
"user.read",
|
|
779
|
+
"user.create",
|
|
780
|
+
"user.edit"
|
|
781
|
+
]);
|
|
782
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
783
|
+
var UserScopeV2 = z11.discriminatedUnion("type", [
|
|
784
|
+
z11.object({
|
|
785
|
+
type: ScopesWithRoleOption,
|
|
786
|
+
options: AllUserScopeOptions.optional()
|
|
787
|
+
}),
|
|
788
|
+
z11.object({
|
|
789
|
+
type: UserScopeType.extract(["user.read"]),
|
|
790
|
+
options: AccessLevelOptions.optional()
|
|
791
|
+
})
|
|
792
|
+
]);
|
|
763
793
|
var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
|
|
764
794
|
z11.object({
|
|
765
795
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -780,16 +810,14 @@ var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
|
|
|
780
810
|
}).optional()
|
|
781
811
|
})
|
|
782
812
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
783
|
-
var SystemScopeType = z11.enum([
|
|
784
|
-
"organisation.read-locations",
|
|
785
|
-
"user.read",
|
|
786
|
-
"user.create",
|
|
787
|
-
"user.edit"
|
|
788
|
-
]);
|
|
789
813
|
var Scope = z11.discriminatedUnion("type", [
|
|
790
814
|
z11.object({ type: PlainScopeType }),
|
|
791
815
|
...RecordScopeV2.options,
|
|
792
|
-
|
|
816
|
+
...UserScopeV2.options,
|
|
817
|
+
z11.object({
|
|
818
|
+
type: z11.literal("organisation.read-locations"),
|
|
819
|
+
options: AccessLevelOptions.optional()
|
|
820
|
+
}),
|
|
793
821
|
z11.object({
|
|
794
822
|
type: z11.literal("workqueue"),
|
|
795
823
|
options: WorkqueueOrDashboardOptions
|
package/dist/cli.js
CHANGED
|
@@ -2110,6 +2110,10 @@ var scopeByEvent = z3.preprocess(
|
|
|
2110
2110
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
2111
2111
|
z3.array(z3.string()).optional()
|
|
2112
2112
|
).describe("Event type, e.g. birth, death");
|
|
2113
|
+
var userRole = z3.preprocess(
|
|
2114
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
2115
|
+
z3.array(z3.string()).optional()
|
|
2116
|
+
).describe("User role, e.g. admin, field agent");
|
|
2113
2117
|
var scopeOptionsPlaceEvent = z3.object({
|
|
2114
2118
|
event: scopeByEvent,
|
|
2115
2119
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -2133,6 +2137,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
2133
2137
|
var AccessLevelOptions = z3.object({
|
|
2134
2138
|
accessLevel: JurisdictionFilter.optional()
|
|
2135
2139
|
});
|
|
2140
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
2141
|
+
role: userRole.optional()
|
|
2142
|
+
});
|
|
2136
2143
|
var WorkqueueOrDashboardOptions = z3.object({
|
|
2137
2144
|
ids: z3.preprocess(
|
|
2138
2145
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -2142,6 +2149,7 @@ var WorkqueueOrDashboardOptions = z3.object({
|
|
|
2142
2149
|
var AllScopeOptions = z3.object({
|
|
2143
2150
|
...AllRecordScopeOptions.shape,
|
|
2144
2151
|
...AccessLevelOptions.shape,
|
|
2152
|
+
...AllUserScopeOptions.shape,
|
|
2145
2153
|
...WorkqueueOrDashboardOptions.shape
|
|
2146
2154
|
});
|
|
2147
2155
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -2214,6 +2222,28 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
2214
2222
|
]).describe(
|
|
2215
2223
|
"Scopes used to check user's permission to perform actions on a record."
|
|
2216
2224
|
);
|
|
2225
|
+
var SystemScopeType = z3.enum([
|
|
2226
|
+
"organisation.read-locations",
|
|
2227
|
+
"user.read",
|
|
2228
|
+
"user.create",
|
|
2229
|
+
"user.edit"
|
|
2230
|
+
]);
|
|
2231
|
+
var UserScopeType = SystemScopeType.extract([
|
|
2232
|
+
"user.read",
|
|
2233
|
+
"user.create",
|
|
2234
|
+
"user.edit"
|
|
2235
|
+
]);
|
|
2236
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
2237
|
+
var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
2238
|
+
z3.object({
|
|
2239
|
+
type: ScopesWithRoleOption,
|
|
2240
|
+
options: AllUserScopeOptions.optional()
|
|
2241
|
+
}),
|
|
2242
|
+
z3.object({
|
|
2243
|
+
type: UserScopeType.extract(["user.read"]),
|
|
2244
|
+
options: AccessLevelOptions.optional()
|
|
2245
|
+
})
|
|
2246
|
+
]);
|
|
2217
2247
|
var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
|
|
2218
2248
|
z3.object({
|
|
2219
2249
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -2234,16 +2264,14 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
2234
2264
|
}).optional()
|
|
2235
2265
|
})
|
|
2236
2266
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
2237
|
-
var SystemScopeType = z3.enum([
|
|
2238
|
-
"organisation.read-locations",
|
|
2239
|
-
"user.read",
|
|
2240
|
-
"user.create",
|
|
2241
|
-
"user.edit"
|
|
2242
|
-
]);
|
|
2243
2267
|
var Scope2 = z3.discriminatedUnion("type", [
|
|
2244
2268
|
z3.object({ type: PlainScopeType }),
|
|
2245
2269
|
...RecordScopeV2.options,
|
|
2246
|
-
|
|
2270
|
+
...UserScopeV2.options,
|
|
2271
|
+
z3.object({
|
|
2272
|
+
type: z3.literal("organisation.read-locations"),
|
|
2273
|
+
options: AccessLevelOptions.optional()
|
|
2274
|
+
}),
|
|
2247
2275
|
z3.object({
|
|
2248
2276
|
type: z3.literal("workqueue"),
|
|
2249
2277
|
options: WorkqueueOrDashboardOptions
|
|
@@ -87,16 +87,16 @@ export declare const user: typeof userSerializer & {
|
|
|
87
87
|
scope: (scope: import("../scopes").ScopeType) => {
|
|
88
88
|
attribute: (option: import("../scopes").ScopeOptionKey) => {
|
|
89
89
|
$scope: "record.search" | "record.create" | "record.read" | "record.declare" | "record.notify" | "record.edit" | "record.reject" | "record.archive" | "record.review-duplicates" | "record.register" | "record.print-certified-copies" | "record.request-correction" | "record.correct" | "record.unassign-others" | "record.custom-action" | "bypassratelimit" | "record.reindex" | "user.data-seeding" | "integration.create" | "record.import" | "config.update-all" | "attachment.upload" | "profile.electronic-signature" | "user.read-only-my-audit" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "record.confirm-registration" | "record.reject-registration" | "organisation.read-locations" | "user.read" | "user.create" | "user.edit" | "workqueue" | "dashboard.view";
|
|
90
|
-
$option: "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
90
|
+
$option: "role" | "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
91
91
|
};
|
|
92
92
|
};
|
|
93
93
|
jurisdiction: (jurisdiction: import("../scopes").JurisdictionFilter | {
|
|
94
94
|
$scope: "record.search" | "record.create" | "record.read" | "record.declare" | "record.notify" | "record.edit" | "record.reject" | "record.archive" | "record.review-duplicates" | "record.register" | "record.print-certified-copies" | "record.request-correction" | "record.correct" | "record.unassign-others" | "record.custom-action" | "bypassratelimit" | "record.reindex" | "user.data-seeding" | "integration.create" | "record.import" | "config.update-all" | "attachment.upload" | "profile.electronic-signature" | "user.read-only-my-audit" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "record.confirm-registration" | "record.reject-registration" | "organisation.read-locations" | "user.read" | "user.create" | "user.edit" | "workqueue" | "dashboard.view";
|
|
95
|
-
$option: "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
95
|
+
$option: "role" | "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
96
96
|
}) => {
|
|
97
97
|
$jurisdiction: "administrativeArea" | "location" | "all" | {
|
|
98
98
|
$scope: "record.search" | "record.create" | "record.read" | "record.declare" | "record.notify" | "record.edit" | "record.reject" | "record.archive" | "record.review-duplicates" | "record.register" | "record.print-certified-copies" | "record.request-correction" | "record.correct" | "record.unassign-others" | "record.custom-action" | "bypassratelimit" | "record.reindex" | "user.data-seeding" | "integration.create" | "record.import" | "config.update-all" | "attachment.upload" | "profile.electronic-signature" | "user.read-only-my-audit" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "record.confirm-registration" | "record.reject-registration" | "organisation.read-locations" | "user.read" | "user.create" | "user.edit" | "workqueue" | "dashboard.view";
|
|
99
|
-
$option: "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
99
|
+
$option: "role" | "event" | "placeOfEvent" | "declaredIn" | "declaredBy" | "registeredIn" | "registeredBy" | "accessLevel" | "ids";
|
|
100
100
|
};
|
|
101
101
|
};
|
|
102
102
|
};
|
|
@@ -1727,6 +1727,7 @@ declare const AdministrativeAreaField: z.ZodObject<{
|
|
|
1727
1727
|
"dashboard.view": "dashboard.view";
|
|
1728
1728
|
}>;
|
|
1729
1729
|
$option: z.ZodEnum<{
|
|
1730
|
+
role: "role";
|
|
1730
1731
|
event: "event";
|
|
1731
1732
|
placeOfEvent: "placeOfEvent";
|
|
1732
1733
|
declaredIn: "declaredIn";
|
|
@@ -1845,6 +1846,7 @@ declare const LocationInput: z.ZodObject<{
|
|
|
1845
1846
|
"dashboard.view": "dashboard.view";
|
|
1846
1847
|
}>;
|
|
1847
1848
|
$option: z.ZodEnum<{
|
|
1849
|
+
role: "role";
|
|
1848
1850
|
event: "event";
|
|
1849
1851
|
placeOfEvent: "placeOfEvent";
|
|
1850
1852
|
declaredIn: "declaredIn";
|
|
@@ -2028,6 +2030,7 @@ declare const Facility: z.ZodObject<{
|
|
|
2028
2030
|
"dashboard.view": "dashboard.view";
|
|
2029
2031
|
}>;
|
|
2030
2032
|
$option: z.ZodEnum<{
|
|
2033
|
+
role: "role";
|
|
2031
2034
|
event: "event";
|
|
2032
2035
|
placeOfEvent: "placeOfEvent";
|
|
2033
2036
|
declaredIn: "declaredIn";
|
|
@@ -2132,6 +2135,7 @@ declare const Office: z.ZodObject<{
|
|
|
2132
2135
|
"dashboard.view": "dashboard.view";
|
|
2133
2136
|
}>;
|
|
2134
2137
|
$option: z.ZodEnum<{
|
|
2138
|
+
role: "role";
|
|
2135
2139
|
event: "event";
|
|
2136
2140
|
placeOfEvent: "placeOfEvent";
|
|
2137
2141
|
declaredIn: "declaredIn";
|
|
@@ -2323,6 +2327,7 @@ declare const Address: z.ZodObject<{
|
|
|
2323
2327
|
"dashboard.view": "dashboard.view";
|
|
2324
2328
|
}>;
|
|
2325
2329
|
$option: z.ZodEnum<{
|
|
2330
|
+
role: "role";
|
|
2326
2331
|
event: "event";
|
|
2327
2332
|
placeOfEvent: "placeOfEvent";
|
|
2328
2333
|
declaredIn: "declaredIn";
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
+
import { UUID } from '../uuid';
|
|
1
2
|
import * as z from 'zod/v4';
|
|
2
3
|
import { EventIndex } from './EventIndex';
|
|
3
4
|
import { ActionCreationMetadata, RegistrationCreationMetadata } from './EventMetadata';
|
|
4
|
-
import { RecordScopeV2 } from '../scopes';
|
|
5
|
+
import { RecordScopeV2, UserScopeV2 } from '../scopes';
|
|
5
6
|
import { SystemContext, UserContext } from '../users/User';
|
|
6
7
|
/** @deprecated Moving on, location types are arbitrary and defined by the country config. */
|
|
7
8
|
export declare const LocationTypeV1: z.ZodEnum<{
|
|
@@ -51,6 +52,21 @@ export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventInde
|
|
|
51
52
|
*
|
|
52
53
|
*/
|
|
53
54
|
export declare function canAccessEventWithScope(event: Partial<EventIndexWithAdministrativeHierarchy>, scope: RecordScopeV2, user: UserContext | SystemContext, customActionType?: string): boolean;
|
|
55
|
+
export type UserWithResolvedHierarchy = {
|
|
56
|
+
role: string;
|
|
57
|
+
administrativeHierarchy: UUID[];
|
|
58
|
+
primaryOfficeId: UUID;
|
|
59
|
+
};
|
|
60
|
+
export declare function canAccessUserWithScope({ userToAccess, scope, user }: {
|
|
61
|
+
userToAccess: UserWithResolvedHierarchy;
|
|
62
|
+
scope: UserScopeV2;
|
|
63
|
+
user: UserContext | SystemContext;
|
|
64
|
+
}): boolean;
|
|
65
|
+
export declare function canAccessOtherUserWithScopes({ scopes, userToAccess, user }: {
|
|
66
|
+
scopes: UserScopeV2[];
|
|
67
|
+
userToAccess: UserWithResolvedHierarchy;
|
|
68
|
+
user: UserContext | SystemContext;
|
|
69
|
+
}): boolean;
|
|
54
70
|
/**
|
|
55
71
|
* Given indexed event and list of resolved scopes, determine if any of the scopes allow access to the event.
|
|
56
72
|
*
|
|
@@ -182,6 +182,10 @@ var scopeByEvent = z6.preprocess(
|
|
|
182
182
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
183
183
|
z6.array(z6.string()).optional()
|
|
184
184
|
).describe("Event type, e.g. birth, death");
|
|
185
|
+
var userRole = z6.preprocess(
|
|
186
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
187
|
+
z6.array(z6.string()).optional()
|
|
188
|
+
).describe("User role, e.g. admin, field agent");
|
|
185
189
|
var scopeOptionsPlaceEvent = z6.object({
|
|
186
190
|
event: scopeByEvent,
|
|
187
191
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -205,6 +209,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
205
209
|
var AccessLevelOptions = z6.object({
|
|
206
210
|
accessLevel: JurisdictionFilter.optional()
|
|
207
211
|
});
|
|
212
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
213
|
+
role: userRole.optional()
|
|
214
|
+
});
|
|
208
215
|
var WorkqueueOrDashboardOptions = z6.object({
|
|
209
216
|
ids: z6.preprocess(
|
|
210
217
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -214,6 +221,7 @@ var WorkqueueOrDashboardOptions = z6.object({
|
|
|
214
221
|
var AllScopeOptions = z6.object({
|
|
215
222
|
...AllRecordScopeOptions.shape,
|
|
216
223
|
...AccessLevelOptions.shape,
|
|
224
|
+
...AllUserScopeOptions.shape,
|
|
217
225
|
...WorkqueueOrDashboardOptions.shape
|
|
218
226
|
});
|
|
219
227
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -286,6 +294,28 @@ var RecordScopeV2 = z6.discriminatedUnion("type", [
|
|
|
286
294
|
]).describe(
|
|
287
295
|
"Scopes used to check user's permission to perform actions on a record."
|
|
288
296
|
);
|
|
297
|
+
var SystemScopeType = z6.enum([
|
|
298
|
+
"organisation.read-locations",
|
|
299
|
+
"user.read",
|
|
300
|
+
"user.create",
|
|
301
|
+
"user.edit"
|
|
302
|
+
]);
|
|
303
|
+
var UserScopeType = SystemScopeType.extract([
|
|
304
|
+
"user.read",
|
|
305
|
+
"user.create",
|
|
306
|
+
"user.edit"
|
|
307
|
+
]);
|
|
308
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
309
|
+
var UserScopeV2 = z6.discriminatedUnion("type", [
|
|
310
|
+
z6.object({
|
|
311
|
+
type: ScopesWithRoleOption,
|
|
312
|
+
options: AllUserScopeOptions.optional()
|
|
313
|
+
}),
|
|
314
|
+
z6.object({
|
|
315
|
+
type: UserScopeType.extract(["user.read"]),
|
|
316
|
+
options: AccessLevelOptions.optional()
|
|
317
|
+
})
|
|
318
|
+
]);
|
|
289
319
|
var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
|
|
290
320
|
z6.object({
|
|
291
321
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -306,16 +336,14 @@ var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
|
|
|
306
336
|
}).optional()
|
|
307
337
|
})
|
|
308
338
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
309
|
-
var SystemScopeType = z6.enum([
|
|
310
|
-
"organisation.read-locations",
|
|
311
|
-
"user.read",
|
|
312
|
-
"user.create",
|
|
313
|
-
"user.edit"
|
|
314
|
-
]);
|
|
315
339
|
var Scope2 = z6.discriminatedUnion("type", [
|
|
316
340
|
z6.object({ type: PlainScopeType }),
|
|
317
341
|
...RecordScopeV2.options,
|
|
318
|
-
|
|
342
|
+
...UserScopeV2.options,
|
|
343
|
+
z6.object({
|
|
344
|
+
type: z6.literal("organisation.read-locations"),
|
|
345
|
+
options: AccessLevelOptions.optional()
|
|
346
|
+
}),
|
|
319
347
|
z6.object({
|
|
320
348
|
type: z6.literal("workqueue"),
|
|
321
349
|
options: WorkqueueOrDashboardOptions
|
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)
|
|
@@ -2123,6 +2123,10 @@ var scopeByEvent = z3.preprocess(
|
|
|
2123
2123
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
2124
2124
|
z3.array(z3.string()).optional()
|
|
2125
2125
|
).describe("Event type, e.g. birth, death");
|
|
2126
|
+
var userRole = z3.preprocess(
|
|
2127
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
2128
|
+
z3.array(z3.string()).optional()
|
|
2129
|
+
).describe("User role, e.g. admin, field agent");
|
|
2126
2130
|
var scopeOptionsPlaceEvent = z3.object({
|
|
2127
2131
|
event: scopeByEvent,
|
|
2128
2132
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -2146,6 +2150,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
2146
2150
|
var AccessLevelOptions = z3.object({
|
|
2147
2151
|
accessLevel: JurisdictionFilter.optional()
|
|
2148
2152
|
});
|
|
2153
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
2154
|
+
role: userRole.optional()
|
|
2155
|
+
});
|
|
2149
2156
|
var WorkqueueOrDashboardOptions = z3.object({
|
|
2150
2157
|
ids: z3.preprocess(
|
|
2151
2158
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -2155,6 +2162,7 @@ var WorkqueueOrDashboardOptions = z3.object({
|
|
|
2155
2162
|
var AllScopeOptions = z3.object({
|
|
2156
2163
|
...AllRecordScopeOptions.shape,
|
|
2157
2164
|
...AccessLevelOptions.shape,
|
|
2165
|
+
...AllUserScopeOptions.shape,
|
|
2158
2166
|
...WorkqueueOrDashboardOptions.shape
|
|
2159
2167
|
});
|
|
2160
2168
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -2227,6 +2235,28 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
2227
2235
|
]).describe(
|
|
2228
2236
|
"Scopes used to check user's permission to perform actions on a record."
|
|
2229
2237
|
);
|
|
2238
|
+
var SystemScopeType = z3.enum([
|
|
2239
|
+
"organisation.read-locations",
|
|
2240
|
+
"user.read",
|
|
2241
|
+
"user.create",
|
|
2242
|
+
"user.edit"
|
|
2243
|
+
]);
|
|
2244
|
+
var UserScopeType = SystemScopeType.extract([
|
|
2245
|
+
"user.read",
|
|
2246
|
+
"user.create",
|
|
2247
|
+
"user.edit"
|
|
2248
|
+
]);
|
|
2249
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
2250
|
+
var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
2251
|
+
z3.object({
|
|
2252
|
+
type: ScopesWithRoleOption,
|
|
2253
|
+
options: AllUserScopeOptions.optional()
|
|
2254
|
+
}),
|
|
2255
|
+
z3.object({
|
|
2256
|
+
type: UserScopeType.extract(["user.read"]),
|
|
2257
|
+
options: AccessLevelOptions.optional()
|
|
2258
|
+
})
|
|
2259
|
+
]);
|
|
2230
2260
|
var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
|
|
2231
2261
|
z3.object({
|
|
2232
2262
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -2247,16 +2277,14 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
2247
2277
|
}).optional()
|
|
2248
2278
|
})
|
|
2249
2279
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
2250
|
-
var SystemScopeType = z3.enum([
|
|
2251
|
-
"organisation.read-locations",
|
|
2252
|
-
"user.read",
|
|
2253
|
-
"user.create",
|
|
2254
|
-
"user.edit"
|
|
2255
|
-
]);
|
|
2256
2280
|
var Scope2 = z3.discriminatedUnion("type", [
|
|
2257
2281
|
z3.object({ type: PlainScopeType }),
|
|
2258
2282
|
...RecordScopeV2.options,
|
|
2259
|
-
|
|
2283
|
+
...UserScopeV2.options,
|
|
2284
|
+
z3.object({
|
|
2285
|
+
type: z3.literal("organisation.read-locations"),
|
|
2286
|
+
options: AccessLevelOptions.optional()
|
|
2287
|
+
}),
|
|
2260
2288
|
z3.object({
|
|
2261
2289
|
type: z3.literal("workqueue"),
|
|
2262
2290
|
options: WorkqueueOrDashboardOptions
|
|
@@ -110,6 +110,10 @@ var scopeByEvent = z2.preprocess(
|
|
|
110
110
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
111
111
|
z2.array(z2.string()).optional()
|
|
112
112
|
).describe("Event type, e.g. birth, death");
|
|
113
|
+
var userRole = z2.preprocess(
|
|
114
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
115
|
+
z2.array(z2.string()).optional()
|
|
116
|
+
).describe("User role, e.g. admin, field agent");
|
|
113
117
|
var scopeOptionsPlaceEvent = z2.object({
|
|
114
118
|
event: scopeByEvent,
|
|
115
119
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -133,6 +137,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
133
137
|
var AccessLevelOptions = z2.object({
|
|
134
138
|
accessLevel: JurisdictionFilter.optional()
|
|
135
139
|
});
|
|
140
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
141
|
+
role: userRole.optional()
|
|
142
|
+
});
|
|
136
143
|
var WorkqueueOrDashboardOptions = z2.object({
|
|
137
144
|
ids: z2.preprocess(
|
|
138
145
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -142,6 +149,7 @@ var WorkqueueOrDashboardOptions = z2.object({
|
|
|
142
149
|
var AllScopeOptions = z2.object({
|
|
143
150
|
...AllRecordScopeOptions.shape,
|
|
144
151
|
...AccessLevelOptions.shape,
|
|
152
|
+
...AllUserScopeOptions.shape,
|
|
145
153
|
...WorkqueueOrDashboardOptions.shape
|
|
146
154
|
});
|
|
147
155
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -214,6 +222,28 @@ var RecordScopeV2 = z2.discriminatedUnion("type", [
|
|
|
214
222
|
]).describe(
|
|
215
223
|
"Scopes used to check user's permission to perform actions on a record."
|
|
216
224
|
);
|
|
225
|
+
var SystemScopeType = z2.enum([
|
|
226
|
+
"organisation.read-locations",
|
|
227
|
+
"user.read",
|
|
228
|
+
"user.create",
|
|
229
|
+
"user.edit"
|
|
230
|
+
]);
|
|
231
|
+
var UserScopeType = SystemScopeType.extract([
|
|
232
|
+
"user.read",
|
|
233
|
+
"user.create",
|
|
234
|
+
"user.edit"
|
|
235
|
+
]);
|
|
236
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
237
|
+
var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
238
|
+
z2.object({
|
|
239
|
+
type: ScopesWithRoleOption,
|
|
240
|
+
options: AllUserScopeOptions.optional()
|
|
241
|
+
}),
|
|
242
|
+
z2.object({
|
|
243
|
+
type: UserScopeType.extract(["user.read"]),
|
|
244
|
+
options: AccessLevelOptions.optional()
|
|
245
|
+
})
|
|
246
|
+
]);
|
|
217
247
|
var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
|
|
218
248
|
z2.object({
|
|
219
249
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -234,16 +264,14 @@ var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
|
|
|
234
264
|
}).optional()
|
|
235
265
|
})
|
|
236
266
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
237
|
-
var SystemScopeType = z2.enum([
|
|
238
|
-
"organisation.read-locations",
|
|
239
|
-
"user.read",
|
|
240
|
-
"user.create",
|
|
241
|
-
"user.edit"
|
|
242
|
-
]);
|
|
243
267
|
var Scope = z2.discriminatedUnion("type", [
|
|
244
268
|
z2.object({ type: PlainScopeType }),
|
|
245
269
|
...RecordScopeV2.options,
|
|
246
|
-
|
|
270
|
+
...UserScopeV2.options,
|
|
271
|
+
z2.object({
|
|
272
|
+
type: z2.literal("organisation.read-locations"),
|
|
273
|
+
options: AccessLevelOptions.optional()
|
|
274
|
+
}),
|
|
247
275
|
z2.object({
|
|
248
276
|
type: z2.literal("workqueue"),
|
|
249
277
|
options: WorkqueueOrDashboardOptions
|
package/dist/scopes/index.d.ts
CHANGED
|
@@ -41,6 +41,7 @@ declare const AllScopeOptions: z.ZodObject<{
|
|
|
41
41
|
location: "location";
|
|
42
42
|
all: "all";
|
|
43
43
|
}>>;
|
|
44
|
+
role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
|
|
44
45
|
event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
45
46
|
placeOfEvent: z.ZodOptional<z.ZodEnum<{
|
|
46
47
|
administrativeArea: "administrativeArea";
|
|
@@ -66,6 +67,7 @@ declare const AllScopeOptions: z.ZodObject<{
|
|
|
66
67
|
}, z.core.$strip>;
|
|
67
68
|
type AllScopeOptions = z.infer<typeof AllScopeOptions>;
|
|
68
69
|
export declare const ScopeOptionKey: z.ZodEnum<{
|
|
70
|
+
role: "role";
|
|
69
71
|
event: "event";
|
|
70
72
|
placeOfEvent: "placeOfEvent";
|
|
71
73
|
declaredIn: "declaredIn";
|
|
@@ -220,6 +222,53 @@ export declare const RecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
220
222
|
templates: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
221
223
|
}, z.core.$strip>>;
|
|
222
224
|
}, z.core.$strip>], "type">;
|
|
225
|
+
declare const SystemScopeType: z.ZodEnum<{
|
|
226
|
+
"organisation.read-locations": "organisation.read-locations";
|
|
227
|
+
"user.read": "user.read";
|
|
228
|
+
"user.create": "user.create";
|
|
229
|
+
"user.edit": "user.edit";
|
|
230
|
+
}>;
|
|
231
|
+
export type SystemScopeType = z.infer<typeof SystemScopeType>;
|
|
232
|
+
declare const UserScopeType: z.ZodEnum<{
|
|
233
|
+
"user.read": "user.read";
|
|
234
|
+
"user.create": "user.create";
|
|
235
|
+
"user.edit": "user.edit";
|
|
236
|
+
}>;
|
|
237
|
+
export type UserScopeType = z.infer<typeof UserScopeType>;
|
|
238
|
+
declare const ScopesWithRoleOption: z.ZodEnum<{
|
|
239
|
+
"user.create": "user.create";
|
|
240
|
+
"user.edit": "user.edit";
|
|
241
|
+
}>;
|
|
242
|
+
export type ScopesWithRoleOption = z.infer<typeof ScopesWithRoleOption>;
|
|
243
|
+
export declare const UserScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
244
|
+
type: z.ZodEnum<{
|
|
245
|
+
"user.create": "user.create";
|
|
246
|
+
"user.edit": "user.edit";
|
|
247
|
+
}>;
|
|
248
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
249
|
+
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
250
|
+
administrativeArea: "administrativeArea";
|
|
251
|
+
location: "location";
|
|
252
|
+
all: "all";
|
|
253
|
+
}>>;
|
|
254
|
+
role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
|
|
255
|
+
}, z.core.$strip>>;
|
|
256
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
257
|
+
type: z.ZodEnum<{
|
|
258
|
+
"user.read": "user.read";
|
|
259
|
+
}>;
|
|
260
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
261
|
+
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
262
|
+
administrativeArea: "administrativeArea";
|
|
263
|
+
location: "location";
|
|
264
|
+
all: "all";
|
|
265
|
+
}>>;
|
|
266
|
+
}, z.core.$strip>>;
|
|
267
|
+
}, z.core.$strip>], "type">;
|
|
268
|
+
export type UserScopeV2 = z.infer<typeof UserScopeV2>;
|
|
269
|
+
export declare function scopeUsesRoleOptions(scope: UserScopeV2): scope is Extract<UserScopeV2, {
|
|
270
|
+
type: ScopesWithRoleOption;
|
|
271
|
+
}>;
|
|
223
272
|
export declare function scopeUsesDeclaredOptions(scope: Scope): scope is Extract<Scope, {
|
|
224
273
|
type: z.infer<typeof ScopesWithDeclaredOptions>;
|
|
225
274
|
}>;
|
|
@@ -286,13 +335,6 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
|
|
|
286
335
|
}, z.core.$strip>], "type">;
|
|
287
336
|
export type RecordScopeV2 = z.infer<typeof RecordScopeV2>;
|
|
288
337
|
export type ResolvedRecordScopeV2 = z.infer<typeof ResolvedRecordScopeV2>;
|
|
289
|
-
declare const SystemScopeType: z.ZodEnum<{
|
|
290
|
-
"organisation.read-locations": "organisation.read-locations";
|
|
291
|
-
"user.read": "user.read";
|
|
292
|
-
"user.create": "user.create";
|
|
293
|
-
"user.edit": "user.edit";
|
|
294
|
-
}>;
|
|
295
|
-
export type SystemScopeType = z.infer<typeof SystemScopeType>;
|
|
296
338
|
/** The primary scope schema which gathers all scope types together. All scopes are discriminated by type and options are determined according to the type. */
|
|
297
339
|
export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
298
340
|
type: z.ZodEnum<{
|
|
@@ -437,11 +479,30 @@ export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
437
479
|
}, z.core.$strip>>;
|
|
438
480
|
}, z.core.$strip>, z.ZodObject<{
|
|
439
481
|
type: z.ZodEnum<{
|
|
440
|
-
"organisation.read-locations": "organisation.read-locations";
|
|
441
|
-
"user.read": "user.read";
|
|
442
482
|
"user.create": "user.create";
|
|
443
483
|
"user.edit": "user.edit";
|
|
444
484
|
}>;
|
|
485
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
486
|
+
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
487
|
+
administrativeArea: "administrativeArea";
|
|
488
|
+
location: "location";
|
|
489
|
+
all: "all";
|
|
490
|
+
}>>;
|
|
491
|
+
role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
|
|
492
|
+
}, z.core.$strip>>;
|
|
493
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
494
|
+
type: z.ZodEnum<{
|
|
495
|
+
"user.read": "user.read";
|
|
496
|
+
}>;
|
|
497
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
498
|
+
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
499
|
+
administrativeArea: "administrativeArea";
|
|
500
|
+
location: "location";
|
|
501
|
+
all: "all";
|
|
502
|
+
}>>;
|
|
503
|
+
}, z.core.$strip>>;
|
|
504
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
505
|
+
type: z.ZodLiteral<"organisation.read-locations">;
|
|
445
506
|
options: z.ZodOptional<z.ZodObject<{
|
|
446
507
|
accessLevel: z.ZodOptional<z.ZodEnum<{
|
|
447
508
|
administrativeArea: "administrativeArea";
|
|
@@ -567,10 +628,21 @@ export declare const decodeScope: (query: EncodedScope) => {
|
|
|
567
628
|
registeredBy?: "user" | undefined;
|
|
568
629
|
templates?: string[] | undefined;
|
|
569
630
|
} | undefined;
|
|
631
|
+
} | {
|
|
632
|
+
type: "user.create" | "user.edit";
|
|
633
|
+
options?: {
|
|
634
|
+
accessLevel?: "administrativeArea" | "location" | "all" | undefined;
|
|
635
|
+
role?: string[] | undefined;
|
|
636
|
+
} | undefined;
|
|
637
|
+
} | {
|
|
638
|
+
type: "user.read";
|
|
639
|
+
options?: {
|
|
640
|
+
accessLevel?: "administrativeArea" | "location" | "all" | undefined;
|
|
641
|
+
} | undefined;
|
|
570
642
|
} | {
|
|
571
643
|
type: "bypassratelimit" | "record.reindex" | "user.data-seeding" | "integration.create" | "record.import" | "config.update-all" | "attachment.upload" | "profile.electronic-signature" | "user.read-only-my-audit" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "record.confirm-registration" | "record.reject-registration";
|
|
572
644
|
} | {
|
|
573
|
-
type: "organisation.read-locations"
|
|
645
|
+
type: "organisation.read-locations";
|
|
574
646
|
options?: {
|
|
575
647
|
accessLevel?: "administrativeArea" | "location" | "all" | undefined;
|
|
576
648
|
} | undefined;
|
package/dist/scopes/index.js
CHANGED
|
@@ -42,6 +42,7 @@ __export(scopes_exports, {
|
|
|
42
42
|
ScopesWithFullOptions: () => ScopesWithFullOptions,
|
|
43
43
|
ScopesWithPlaceEventOptions: () => ScopesWithPlaceEventOptions,
|
|
44
44
|
UserFilter: () => UserFilter,
|
|
45
|
+
UserScopeV2: () => UserScopeV2,
|
|
45
46
|
canUserCreateEvent: () => canUserCreateEvent,
|
|
46
47
|
decodeScope: () => decodeScope,
|
|
47
48
|
defineRoles: () => defineRoles,
|
|
@@ -54,7 +55,8 @@ __export(scopes_exports, {
|
|
|
54
55
|
isCustomActionScope: () => isCustomActionScope,
|
|
55
56
|
scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
|
|
56
57
|
scopeUsesFullOptions: () => scopeUsesFullOptions,
|
|
57
|
-
scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions
|
|
58
|
+
scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
|
|
59
|
+
scopeUsesRoleOptions: () => scopeUsesRoleOptions
|
|
58
60
|
});
|
|
59
61
|
module.exports = __toCommonJS(scopes_exports);
|
|
60
62
|
var z4 = __toESM(require("zod/v4"));
|
|
@@ -139,6 +141,10 @@ var scopeByEvent = z3.preprocess(
|
|
|
139
141
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
140
142
|
z3.array(z3.string()).optional()
|
|
141
143
|
).describe("Event type, e.g. birth, death");
|
|
144
|
+
var userRole = z3.preprocess(
|
|
145
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
146
|
+
z3.array(z3.string()).optional()
|
|
147
|
+
).describe("User role, e.g. admin, field agent");
|
|
142
148
|
var scopeOptionsPlaceEvent = z3.object({
|
|
143
149
|
event: scopeByEvent,
|
|
144
150
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -162,6 +168,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
162
168
|
var AccessLevelOptions = z3.object({
|
|
163
169
|
accessLevel: JurisdictionFilter.optional()
|
|
164
170
|
});
|
|
171
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
172
|
+
role: userRole.optional()
|
|
173
|
+
});
|
|
165
174
|
var WorkqueueOrDashboardOptions = z3.object({
|
|
166
175
|
ids: z3.preprocess(
|
|
167
176
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -171,6 +180,7 @@ var WorkqueueOrDashboardOptions = z3.object({
|
|
|
171
180
|
var AllScopeOptions = z3.object({
|
|
172
181
|
...AllRecordScopeOptions.shape,
|
|
173
182
|
...AccessLevelOptions.shape,
|
|
183
|
+
...AllUserScopeOptions.shape,
|
|
174
184
|
...WorkqueueOrDashboardOptions.shape
|
|
175
185
|
});
|
|
176
186
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -243,6 +253,31 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
243
253
|
]).describe(
|
|
244
254
|
"Scopes used to check user's permission to perform actions on a record."
|
|
245
255
|
);
|
|
256
|
+
var SystemScopeType = z3.enum([
|
|
257
|
+
"organisation.read-locations",
|
|
258
|
+
"user.read",
|
|
259
|
+
"user.create",
|
|
260
|
+
"user.edit"
|
|
261
|
+
]);
|
|
262
|
+
var UserScopeType = SystemScopeType.extract([
|
|
263
|
+
"user.read",
|
|
264
|
+
"user.create",
|
|
265
|
+
"user.edit"
|
|
266
|
+
]);
|
|
267
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
268
|
+
var UserScopeV2 = z3.discriminatedUnion("type", [
|
|
269
|
+
z3.object({
|
|
270
|
+
type: ScopesWithRoleOption,
|
|
271
|
+
options: AllUserScopeOptions.optional()
|
|
272
|
+
}),
|
|
273
|
+
z3.object({
|
|
274
|
+
type: UserScopeType.extract(["user.read"]),
|
|
275
|
+
options: AccessLevelOptions.optional()
|
|
276
|
+
})
|
|
277
|
+
]);
|
|
278
|
+
function scopeUsesRoleOptions(scope) {
|
|
279
|
+
return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
|
|
280
|
+
}
|
|
246
281
|
function scopeUsesDeclaredOptions(scope) {
|
|
247
282
|
return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
|
|
248
283
|
}
|
|
@@ -275,16 +310,14 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
|
|
|
275
310
|
}).optional()
|
|
276
311
|
})
|
|
277
312
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
278
|
-
var SystemScopeType = z3.enum([
|
|
279
|
-
"organisation.read-locations",
|
|
280
|
-
"user.read",
|
|
281
|
-
"user.create",
|
|
282
|
-
"user.edit"
|
|
283
|
-
]);
|
|
284
313
|
var Scope2 = z3.discriminatedUnion("type", [
|
|
285
314
|
z3.object({ type: PlainScopeType }),
|
|
286
315
|
...RecordScopeV2.options,
|
|
287
|
-
|
|
316
|
+
...UserScopeV2.options,
|
|
317
|
+
z3.object({
|
|
318
|
+
type: z3.literal("organisation.read-locations"),
|
|
319
|
+
options: AccessLevelOptions.optional()
|
|
320
|
+
}),
|
|
288
321
|
z3.object({
|
|
289
322
|
type: z3.literal("workqueue"),
|
|
290
323
|
options: WorkqueueOrDashboardOptions
|
|
Binary file
|
package/package.json
CHANGED
|
Binary file
|