@opencrvs/toolkit 2.0.0-rc.32c9d97 → 2.0.0-rc.32d244a

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.
@@ -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" | "user.read" | "user.create" | "user.edit";
645
+ type: "organisation.read-locations";
574
646
  options?: {
575
647
  accessLevel?: "administrativeArea" | "location" | "all" | undefined;
576
648
  } | undefined;
@@ -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
- z3.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "2.0.0-rc.32c9d97",
3
+ "version": "2.0.0-rc.32d244a",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "bin": {