@opencrvs/toolkit 2.0.0-rc.fef9d21 → 2.0.0-rc.ff777d6

package/dist/scopes/index.d.ts

@@ -41,6 +41,7 @@ declare const AllScopeOptions: z.ZodObject<{
         location: "location";
         all: "all";
     }>>;
+    role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
     event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
     placeOfEvent: z.ZodOptional<z.ZodEnum<{
         administrativeArea: "administrativeArea";
@@ -66,6 +67,7 @@ declare const AllScopeOptions: z.ZodObject<{
 }, z.core.$strip>;
 type AllScopeOptions = z.infer<typeof AllScopeOptions>;
 export declare const ScopeOptionKey: z.ZodEnum<{
+    role: "role";
     event: "event";
     placeOfEvent: "placeOfEvent";
     declaredIn: "declaredIn";
@@ -220,6 +222,56 @@ export declare const RecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
         templates: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>], "type">;
+declare const SystemScopeType: z.ZodEnum<{
+    "organisation.read-locations": "organisation.read-locations";
+    "user.read": "user.read";
+    "user.create": "user.create";
+    "user.edit": "user.edit";
+    "user.search": "user.search";
+}>;
+export type SystemScopeType = z.infer<typeof SystemScopeType>;
+declare const UserScopeType: z.ZodEnum<{
+    "user.read": "user.read";
+    "user.create": "user.create";
+    "user.edit": "user.edit";
+    "user.search": "user.search";
+}>;
+export type UserScopeType = z.infer<typeof UserScopeType>;
+declare const ScopesWithRoleOption: z.ZodEnum<{
+    "user.create": "user.create";
+    "user.edit": "user.edit";
+}>;
+export type ScopesWithRoleOption = z.infer<typeof ScopesWithRoleOption>;
+export declare const UserScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodEnum<{
+        "user.create": "user.create";
+        "user.edit": "user.edit";
+    }>;
+    options: z.ZodOptional<z.ZodObject<{
+        accessLevel: z.ZodOptional<z.ZodEnum<{
+            administrativeArea: "administrativeArea";
+            location: "location";
+            all: "all";
+        }>>;
+        role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodEnum<{
+        "user.read": "user.read";
+        "user.search": "user.search";
+    }>;
+    options: z.ZodOptional<z.ZodObject<{
+        accessLevel: z.ZodOptional<z.ZodEnum<{
+            administrativeArea: "administrativeArea";
+            location: "location";
+            all: "all";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+export type UserScopeV2 = z.infer<typeof UserScopeV2>;
+export declare function scopeUsesRoleOptions(scope: UserScopeV2): scope is Extract<UserScopeV2, {
+    type: ScopesWithRoleOption;
+}>;
 export declare function scopeUsesDeclaredOptions(scope: Scope): scope is Extract<Scope, {
     type: z.infer<typeof ScopesWithDeclaredOptions>;
 }>;
@@ -286,13 +338,6 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
 }, z.core.$strip>], "type">;
 export type RecordScopeV2 = z.infer<typeof RecordScopeV2>;
 export type ResolvedRecordScopeV2 = z.infer<typeof ResolvedRecordScopeV2>;
-declare const SystemScopeType: z.ZodEnum<{
-    "organisation.read-locations": "organisation.read-locations";
-    "user.read": "user.read";
-    "user.create": "user.create";
-    "user.edit": "user.edit";
-}>;
-export type SystemScopeType = z.infer<typeof SystemScopeType>;
 /** The primary scope schema which gathers all scope types together. All scopes are discriminated by type and options are determined according to the type. */
 export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodEnum<{
@@ -437,11 +482,31 @@ export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodEnum<{
-        "organisation.read-locations": "organisation.read-locations";
-        "user.read": "user.read";
         "user.create": "user.create";
         "user.edit": "user.edit";
     }>;
+    options: z.ZodOptional<z.ZodObject<{
+        accessLevel: z.ZodOptional<z.ZodEnum<{
+            administrativeArea: "administrativeArea";
+            location: "location";
+            all: "all";
+        }>>;
+        role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodEnum<{
+        "user.read": "user.read";
+        "user.search": "user.search";
+    }>;
+    options: z.ZodOptional<z.ZodObject<{
+        accessLevel: z.ZodOptional<z.ZodEnum<{
+            administrativeArea: "administrativeArea";
+            location: "location";
+            all: "all";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"organisation.read-locations">;
     options: z.ZodOptional<z.ZodObject<{
         accessLevel: z.ZodOptional<z.ZodEnum<{
             administrativeArea: "administrativeArea";
@@ -495,6 +560,7 @@ export declare const ScopeType: z.ZodEnum<{
     "user.read": "user.read";
     "user.create": "user.create";
     "user.edit": "user.edit";
+    "user.search": "user.search";
     workqueue: "workqueue";
     "dashboard.view": "dashboard.view";
 }>;
@@ -514,14 +580,12 @@ export type EncodedScope = z.infer<typeof EncodedScope>;
  */
 export declare const encodeScope: (scope: Scope) => EncodedScope;
 /**
- * Converts a scope object into an encoded query string representation.
+ * Converts an encoded scope string into a scope object.
  *
- * @TODO scope param could be defined as EncodedScope instead of string.
- *
- * @param scope - The scope object to encode.
- * @returns The encoded scope as a branded string (`EncodedScope`).
+ * @param scope - The encoded scope string to decode.
+ * @returns The decoded scope object.
  */
-export declare const decodeScope: (query: EncodedScope) => {
+export declare const decodeScope: (encodedScope: EncodedScope) => {
     type: "record.create" | "record.declare" | "record.notify";
     options?: {
         event?: string[] | undefined;
@@ -567,10 +631,21 @@ export declare const decodeScope: (query: EncodedScope) => {
         registeredBy?: "user" | undefined;
         templates?: string[] | undefined;
     } | undefined;
+} | {
+    type: "user.create" | "user.edit";
+    options?: {
+        accessLevel?: "administrativeArea" | "location" | "all" | undefined;
+        role?: string[] | undefined;
+    } | undefined;
+} | {
+    type: "user.read" | "user.search";
+    options?: {
+        accessLevel?: "administrativeArea" | "location" | "all" | undefined;
+    } | undefined;
 } | {
     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";
 } | {
-    type: "organisation.read-locations" | "user.read" | "user.create" | "user.edit";
+    type: "organisation.read-locations";
     options?: {
         accessLevel?: "administrativeArea" | "location" | "all" | undefined;
     } | undefined;

package/dist/scopes/index.js

@@ -42,6 +42,7 @@ __export(scopes_exports, {
   ScopesWithFullOptions: () => ScopesWithFullOptions,
   ScopesWithPlaceEventOptions: () => ScopesWithPlaceEventOptions,
   UserFilter: () => UserFilter,
+  UserScopeV2: () => UserScopeV2,
   canUserCreateEvent: () => canUserCreateEvent,
   decodeScope: () => decodeScope,
   defineRoles: () => defineRoles,
@@ -54,7 +55,8 @@ __export(scopes_exports, {
   isCustomActionScope: () => isCustomActionScope,
   scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
   scopeUsesFullOptions: () => scopeUsesFullOptions,
-  scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions
+  scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
+  scopeUsesRoleOptions: () => scopeUsesRoleOptions
 });
 module.exports = __toCommonJS(scopes_exports);
 var z4 = __toESM(require("zod/v4"));
@@ -139,6 +141,10 @@ var scopeByEvent = z3.preprocess(
   (val) => val === void 0 ? void 0 : [val].flat(),
   z3.array(z3.string()).optional()
 ).describe("Event type, e.g. birth, death");
+var userRole = z3.preprocess(
+  (val) => val === void 0 ? void 0 : [val].flat(),
+  z3.array(z3.string()).optional()
+).describe("User role, e.g. admin, field agent");
 var scopeOptionsPlaceEvent = z3.object({
   event: scopeByEvent,
   placeOfEvent: JurisdictionFilter.optional()
@@ -162,6 +168,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
 var AccessLevelOptions = z3.object({
   accessLevel: JurisdictionFilter.optional()
 });
+var AllUserScopeOptions = AccessLevelOptions.extend({
+  role: userRole.optional()
+});
 var WorkqueueOrDashboardOptions = z3.object({
   ids: z3.preprocess(
     (val) => val === void 0 ? void 0 : [val].flat(),
@@ -171,6 +180,7 @@ var WorkqueueOrDashboardOptions = z3.object({
 var AllScopeOptions = z3.object({
   ...AllRecordScopeOptions.shape,
   ...AccessLevelOptions.shape,
+  ...AllUserScopeOptions.shape,
   ...WorkqueueOrDashboardOptions.shape
 });
 var ScopeOptionKey = AllScopeOptions.keyof();
@@ -243,6 +253,33 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
 ]).describe(
   "Scopes used to check user's permission to perform actions on a record."
 );
+var SystemScopeType = z3.enum([
+  "organisation.read-locations",
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var UserScopeType = SystemScopeType.extract([
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
+var UserScopeV2 = z3.discriminatedUnion("type", [
+  z3.object({
+    type: ScopesWithRoleOption,
+    options: AllUserScopeOptions.optional()
+  }),
+  z3.object({
+    type: UserScopeType.extract(["user.read", "user.search"]),
+    options: AccessLevelOptions.optional()
+  })
+]);
+function scopeUsesRoleOptions(scope) {
+  return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
+}
 function scopeUsesDeclaredOptions(scope) {
   return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
 }
@@ -275,16 +312,14 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
     }).optional()
   })
 ]).describe("Resolved scope with location/user IDs instead of filters.");
-var SystemScopeType = z3.enum([
-  "organisation.read-locations",
-  "user.read",
-  "user.create",
-  "user.edit"
-]);
 var Scope2 = z3.discriminatedUnion("type", [
   z3.object({ type: PlainScopeType }),
   ...RecordScopeV2.options,
-  z3.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
+  ...UserScopeV2.options,
+  z3.object({
+    type: z3.literal("organisation.read-locations"),
+    options: AccessLevelOptions.optional()
+  }),
   z3.object({
     type: z3.literal("workqueue"),
     options: WorkqueueOrDashboardOptions
@@ -319,18 +354,26 @@ var encodeScope = (scope) => {
     encode: false
   });
 };
-var decodeScope = (query) => {
-  const scope = qs.parse(query, {
+var decodedScopeCache = /* @__PURE__ */ new Map();
+var decodeScope = (encodedScope) => {
+  if (decodedScopeCache.has(encodedScope)) {
+    return decodedScopeCache.get(encodedScope);
+  }
+  const scope = qs.parse(encodedScope, {
     ignoreQueryPrefix: true,
     comma: true,
     allowDots: true
   });
   const unflattenedScope = unflattenScope(scope);
-  return Scope2.safeParse(unflattenedScope)?.data;
+  const result = Scope2.safeParse(unflattenedScope)?.data;
+  decodedScopeCache.set(encodedScope, result);
+  return result;
 };
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,
-  accessLevel: JurisdictionFilter.enum.all
+  accessLevel: JurisdictionFilter.enum.all,
+  registeredIn: JurisdictionFilter.enum.all,
+  declaredIn: JurisdictionFilter.enum.all
 };
 function getScopeOptionValue(scope, option) {
   const options = "options" in scope ? scope.options : void 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "2.0.0-rc.fef9d21",
+  "version": "2.0.0-rc.ff777d6",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "bin": {
@@ -20,6 +20,10 @@
     "build": "./build.sh",
     "build:all": "lerna run build --include-dependencies --scope @opencrvs/toolkit && ./build.sh"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/opencrvs/opencrvs-core.git"
+  },
   "dependencies": {
     "@trpc/client": "11.4.3",
     "@trpc/server": "^11.8.0",
@@ -29,7 +33,7 @@
     "jwt-decode": "^3.0.0",
     "lodash": "^4.17.10",
     "object-hash": "^3.0.0",
-    "qs": "6.14.0",
+    "qs": "6.15.2",
     "superjson": "1.9.0-0",
     "ts-morph": "^27.0.2",
     "uuid": "^9.0.0",

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/cli.ts","./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/migrations/v2.0/add-birth-certificate-issuance-flag.ts","./src/migrations/v2.0/add-resend-invite-notification.ts","./src/migrations/v2.0/checkout-upstream-files.ts","./src/migrations/v2.0/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.ts","./src/migrations/v2.0/create-events-index.ts","./src/migrations/v2.0/delete-infrastructure-directory.ts","./src/migrations/v2.0/index.ts","./src/migrations/v2.0/make-built-in-validate-actions-custom.ts","./src/migrations/v2.0/merge-infrastructure-directory.ts","./src/migrations/v2.0/migrate-application-config-url.ts","./src/migrations/v2.0/migrate-scopes.ts","./src/migrations/v2.0/migrate-validated-workqueue-status-to-flag.ts","./src/migrations/v2.0/migrate-workqueue-configs.ts","./src/migrations/v2.0/remove-delete-actions.ts","./src/migrations/v2.0/remove-demo-scope.ts","./src/migrations/v2.0/remove-deprecated-imports.ts","./src/migrations/v2.0/remove-fhir-url-helpers.ts","./src/migrations/v2.0/remove-hearth-migrations.ts","./src/migrations/v2.0/remove-old-statistics-service.ts","./src/migrations/v2.0/remove-pending-certification-flag.ts","./src/migrations/v2.0/remove-review-from-register-action.ts","./src/migrations/v2.0/remove-unused-environment-variables.ts","./src/migrations/v2.0/rename-api-paths.ts","./src/migrations/v2.0/rename-location-parent-id.ts","./src/migrations/v2.0/simplify-analytics-precalculations.ts","./src/migrations/v2.0/update-package-json.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}
+{"root":["./src/cli.ts","./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/migrations/v2.0/add-birth-certificate-issuance-flag.ts","./src/migrations/v2.0/add-resend-invite-notification.ts","./src/migrations/v2.0/checkout-upstream-files.ts","./src/migrations/v2.0/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.ts","./src/migrations/v2.0/create-events-index.ts","./src/migrations/v2.0/delete-infrastructure-directory.ts","./src/migrations/v2.0/fix-accept-requested-registration-function-type.ts","./src/migrations/v2.0/index.ts","./src/migrations/v2.0/make-built-in-validate-actions-custom.ts","./src/migrations/v2.0/merge-infrastructure-directory.ts","./src/migrations/v2.0/migrate-application-config-url.ts","./src/migrations/v2.0/migrate-scopes.ts","./src/migrations/v2.0/migrate-validated-workqueue-status-to-flag.ts","./src/migrations/v2.0/migrate-workqueue-configs.ts","./src/migrations/v2.0/remove-delete-actions.ts","./src/migrations/v2.0/remove-demo-scope.ts","./src/migrations/v2.0/remove-deprecated-imports.ts","./src/migrations/v2.0/remove-fhir-url-helpers.ts","./src/migrations/v2.0/remove-hearth-migrations.ts","./src/migrations/v2.0/remove-old-statistics-service.ts","./src/migrations/v2.0/remove-pending-certification-flag.ts","./src/migrations/v2.0/remove-review-from-register-action.ts","./src/migrations/v2.0/remove-unused-environment-variables.ts","./src/migrations/v2.0/rename-api-paths.ts","./src/migrations/v2.0/rename-location-parent-id.ts","./src/migrations/v2.0/simplify-analytics-precalculations.ts","./src/migrations/v2.0/update-package-json.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}