@opencrvs/toolkit 1.8.0-rc.fef85f2 → 1.8.0-rc.ff0b26c

package/dist/scopes/index.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 export declare const SCOPES: {
     readonly NATLSYSADMIN: "natlsysadmin";
     readonly BYPASSRATELIMIT: "bypassratelimit";
@@ -18,6 +19,7 @@ export declare const SCOPES: {
      * @TODO This is a temporary scope to be used for V2 Events custom events declaration
      */
     readonly RECORD_DECLARE: "record.declare-birth";
+    readonly RECORD_IMPORT: "record.import";
     readonly RECORD_DECLARE_BIRTH: "record.declare-birth";
     readonly RECORD_DECLARE_BIRTH_MY_JURISDICTION: "record.declare-birth:my-jurisdiction";
     readonly RECORD_DECLARE_DEATH: "record.declare-death";
@@ -83,6 +85,161 @@ export declare const SCOPES: {
     readonly CONFIG_UPDATE_ALL: "config.update:all";
     readonly USER_DATA_SEEDING: "user.data-seeding";
 };
-export type Scope = (typeof SCOPES)[keyof typeof SCOPES];
+declare const LiteralScopes: z.ZodUnion<[z.ZodLiteral<"natlsysadmin">, z.ZodLiteral<"bypassratelimit">, z.ZodLiteral<"declare">, z.ZodLiteral<"register">, z.ZodLiteral<"validate">, z.ZodLiteral<"demo">, z.ZodLiteral<"certify">, z.ZodLiteral<"performance">, z.ZodLiteral<"sysadmin">, z.ZodLiteral<"teams">, z.ZodLiteral<"config">, z.ZodLiteral<"webhook">, z.ZodLiteral<"nationalId">, z.ZodLiteral<"notification-api">, z.ZodLiteral<"recordsearch">, z.ZodLiteral<"record.import">, z.ZodLiteral<"record.declare-birth">, z.ZodLiteral<"record.declare-birth:my-jurisdiction">, z.ZodLiteral<"record.declare-death">, z.ZodLiteral<"record.declare-death:my-jurisdiction">, z.ZodLiteral<"record.declare-marriage">, z.ZodLiteral<"record.declare-marriage:my-jurisdiction">, z.ZodLiteral<"record.declaration-submit-incomplete">, z.ZodLiteral<"record.declaration-submit-for-review">, z.ZodLiteral<"record.unassign-others">, z.ZodLiteral<"record.declaration-submit-for-approval">, z.ZodLiteral<"record.declaration-submit-for-updates">, z.ZodLiteral<"record.declaration-edit">, z.ZodLiteral<"record.review-duplicates">, z.ZodLiteral<"record.declaration-archive">, z.ZodLiteral<"record.declaration-reinstate">, z.ZodLiteral<"record.register">, z.ZodLiteral<"record.export-records">, z.ZodLiteral<"record.declaration-print">, z.ZodLiteral<"record.declaration-print-supporting-documents">, z.ZodLiteral<"record.registration-print">, z.ZodLiteral<"record.registration-print&issue-certified-copies">, z.ZodLiteral<"record.registration-print-certified-copies">, z.ZodLiteral<"record.registration-bulk-print-certified-copies">, z.ZodLiteral<"record.registration-verify-certified-copies">, z.ZodLiteral<"record.registration-request-correction">, z.ZodLiteral<"record.registration-correct">, z.ZodLiteral<"record.registration-request-revocation">, z.ZodLiteral<"record.registration-revoke">, z.ZodLiteral<"record.registration-request-reinstatement">, z.ZodLiteral<"record.registration-reinstate">, z.ZodLiteral<"record.confirm-registration">, z.ZodLiteral<"record.reject-registration">, z.ZodLiteral<"search.birth:my-jurisdiction">, z.ZodLiteral<"search.birth">, z.ZodLiteral<"search.death:my-jurisdiction">, z.ZodLiteral<"search.death">, z.ZodLiteral<"search.marriage:my-jurisdiction">, z.ZodLiteral<"search.marriage">, z.ZodLiteral<"record.read">, z.ZodLiteral<"record.read-audit">, z.ZodLiteral<"record.read-comments">, z.ZodLiteral<"record.create-comments">, z.ZodLiteral<"profile.update">, z.ZodLiteral<"profile.electronic-signature">, z.ZodLiteral<"performance.read">, z.ZodLiteral<"performance.read-dashboards">, z.ZodLiteral<"performance.vital-statistics-export">, z.ZodLiteral<"organisation.read-locations:all">, z.ZodLiteral<"organisation.read-locations:my-office">, z.ZodLiteral<"organisation.read-locations:my-jurisdiction">, z.ZodLiteral<"user.read:all">, z.ZodLiteral<"user.read:my-office">, z.ZodLiteral<"user.read:my-jurisdiction">, z.ZodLiteral<"user.read:only-my-audit">, z.ZodLiteral<"user.create:all">, z.ZodLiteral<"user.create:my-jurisdiction">, z.ZodLiteral<"user.update:all">, z.ZodLiteral<"user.update:my-jurisdiction">, z.ZodLiteral<"config.update:all">, z.ZodLiteral<"user.data-seeding">]>;
+declare const ConfigurableScopes: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"user.create">;
+    options: z.ZodObject<{
+        role: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        role: string[];
+    }, {
+        role: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "user.create";
+    options: {
+        role: string[];
+    };
+}, {
+    type: "user.create";
+    options: {
+        role: string[];
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"user.edit">;
+    options: z.ZodObject<{
+        role: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        role: string[];
+    }, {
+        role: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "user.edit";
+    options: {
+        role: string[];
+    };
+}, {
+    type: "user.edit";
+    options: {
+        role: string[];
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"workqueue">;
+    options: z.ZodObject<{
+        id: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string[];
+    }, {
+        id: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "workqueue";
+    options: {
+        id: string[];
+    };
+}, {
+    type: "workqueue";
+    options: {
+        id: string[];
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"record.notify">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+    }, {
+        event: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+}, {
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+}>]>;
+export type ConfigurableScopeType = ConfigurableScopes['type'];
+export type ConfigurableScopes = z.infer<typeof ConfigurableScopes>;
+export declare function findScope<T extends ConfigurableScopeType>(scopes: string[], scopeType: T): Extract<{
+    type: "user.create";
+    options: {
+        role: string[];
+    };
+}, {
+    type: T;
+}> | Extract<{
+    type: "user.edit";
+    options: {
+        role: string[];
+    };
+}, {
+    type: T;
+}> | Extract<{
+    type: "workqueue";
+    options: {
+        id: string[];
+    };
+}, {
+    type: T;
+}> | Extract<{
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+}, {
+    type: T;
+}> | undefined;
+/**
+ * Parses a configurable scope string into a ConfigurableScopes object.
+ * @param {string} scope - The scope string to parse
+ * @returns {ConfigurableScopes | undefined} The parsed scope object if valid, undefined otherwise
+ * @example
+ * parseScope("user.create[role=field-agent|registration-agent]")
+ * // Returns: { type: "user.create", options: { role: ["field-agent", "registration-agent"] } }
+ */
+export declare function parseScope(scope: string): {
+    type: "user.create";
+    options: {
+        role: string[];
+    };
+} | {
+    type: "user.edit";
+    options: {
+        role: string[];
+    };
+} | {
+    type: "workqueue";
+    options: {
+        id: string[];
+    };
+} | {
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+} | {
+    type: "natlsysadmin" | "bypassratelimit" | "declare" | "register" | "validate" | "demo" | "certify" | "performance" | "sysadmin" | "teams" | "config" | "webhook" | "nationalId" | "notification-api" | "recordsearch" | "record.declare-birth" | "record.import" | "record.declare-birth:my-jurisdiction" | "record.declare-death" | "record.declare-death:my-jurisdiction" | "record.declare-marriage" | "record.declare-marriage:my-jurisdiction" | "record.declaration-submit-incomplete" | "record.declaration-submit-for-review" | "record.unassign-others" | "record.declaration-submit-for-approval" | "record.declaration-submit-for-updates" | "record.declaration-edit" | "record.review-duplicates" | "record.declaration-archive" | "record.declaration-reinstate" | "record.register" | "record.export-records" | "record.declaration-print" | "record.declaration-print-supporting-documents" | "record.registration-print" | "record.registration-print&issue-certified-copies" | "record.registration-print-certified-copies" | "record.registration-bulk-print-certified-copies" | "record.registration-verify-certified-copies" | "record.registration-request-correction" | "record.registration-correct" | "record.registration-request-revocation" | "record.registration-revoke" | "record.registration-request-reinstatement" | "record.registration-reinstate" | "record.confirm-registration" | "record.reject-registration" | "search.birth:my-jurisdiction" | "search.birth" | "search.death:my-jurisdiction" | "search.death" | "search.marriage:my-jurisdiction" | "search.marriage" | "record.read" | "record.read-audit" | "record.read-comments" | "record.create-comments" | "profile.update" | "profile.electronic-signature" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "organisation.read-locations:all" | "organisation.read-locations:my-office" | "organisation.read-locations:my-jurisdiction" | "user.read:all" | "user.read:my-office" | "user.read:my-jurisdiction" | "user.read:only-my-audit" | "user.create:all" | "user.create:my-jurisdiction" | "user.update:all" | "user.update:my-jurisdiction" | "config.update:all" | "user.data-seeding";
+} | undefined;
+/**
+ * Stringifies a ConfigurableScopes object into a scope string.
+ * @param {ConfigurableScopes} scope - The scope object to stringify
+ * @returns {string} The stringified scope in format "type[key1=value1|value2,key2=value3|value4]"
+ * @example
+ * stringifyScope({
+ *   type: "record.notify",
+ *   options: { event: ["v2.birth", "tennis-club-membership"] }
+ * })
+ * // Returns: "record.notify[event=v2.birth|tennis-club-membership]"
+ */
+export declare function stringifyScope(scope: ConfigurableScopes): string;
 export declare const scopes: Scope[];
+export type ParsedScopes = NonNullable<ReturnType<typeof parseScope>>;
+export type RawScopes = z.infer<typeof LiteralScopes> | (string & {});
+export type Scope = RawScopes;
+export {};
 //# sourceMappingURL=scopes.d.ts.map

package/dist/scopes/index.js

@@ -21,11 +21,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var scopes_exports = {};
 __export(scopes_exports, {
   SCOPES: () => SCOPES,
-  scopes: () => scopes
+  findScope: () => findScope,
+  parseScope: () => parseScope,
+  scopes: () => scopes,
+  stringifyScope: () => stringifyScope
 });
 module.exports = __toCommonJS(scopes_exports);
 
 // ../commons/src/scopes.ts
+var import_zod = require("zod");
 var SCOPES = {
   // TODO v1.8 legacy scopes
   NATLSYSADMIN: "natlsysadmin",
@@ -49,6 +53,8 @@ var SCOPES = {
    */
   RECORD_DECLARE: "record.declare-birth",
   // declare
+  RECORD_IMPORT: "record.import",
+  // declare
   RECORD_DECLARE_BIRTH: "record.declare-birth",
   RECORD_DECLARE_BIRTH_MY_JURISDICTION: "record.declare-birth:my-jurisdiction",
   RECORD_DECLARE_DEATH: "record.declare-death",
@@ -136,4 +142,149 @@ var SCOPES = {
   // data seeding
   USER_DATA_SEEDING: "user.data-seeding"
 };
+var LiteralScopes = import_zod.z.union([
+  import_zod.z.literal(SCOPES.NATLSYSADMIN),
+  import_zod.z.literal(SCOPES.BYPASSRATELIMIT),
+  import_zod.z.literal(SCOPES.DECLARE),
+  import_zod.z.literal(SCOPES.REGISTER),
+  import_zod.z.literal(SCOPES.VALIDATE),
+  import_zod.z.literal(SCOPES.DEMO),
+  import_zod.z.literal(SCOPES.CERTIFY),
+  import_zod.z.literal(SCOPES.PERFORMANCE),
+  import_zod.z.literal(SCOPES.SYSADMIN),
+  import_zod.z.literal(SCOPES.TEAMS),
+  import_zod.z.literal(SCOPES.CONFIG),
+  import_zod.z.literal(SCOPES.WEBHOOK),
+  import_zod.z.literal(SCOPES.NATIONALID),
+  import_zod.z.literal(SCOPES.NOTIFICATION_API),
+  import_zod.z.literal(SCOPES.RECORDSEARCH),
+  import_zod.z.literal(SCOPES.RECORD_IMPORT),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_BIRTH),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_BIRTH_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_DEATH),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_DEATH_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_MARRIAGE),
+  import_zod.z.literal(SCOPES.RECORD_DECLARE_MARRIAGE_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.RECORD_SUBMIT_INCOMPLETE),
+  import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_REVIEW),
+  import_zod.z.literal(SCOPES.RECORD_UNASSIGN_OTHERS),
+  import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_APPROVAL),
+  import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_UPDATES),
+  import_zod.z.literal(SCOPES.RECORD_DECLARATION_EDIT),
+  import_zod.z.literal(SCOPES.RECORD_REVIEW_DUPLICATES),
+  import_zod.z.literal(SCOPES.RECORD_DECLARATION_ARCHIVE),
+  import_zod.z.literal(SCOPES.RECORD_DECLARATION_REINSTATE),
+  import_zod.z.literal(SCOPES.RECORD_REGISTER),
+  import_zod.z.literal(SCOPES.RECORD_EXPORT_RECORDS),
+  import_zod.z.literal(SCOPES.RECORD_DECLARATION_PRINT),
+  import_zod.z.literal(SCOPES.RECORD_PRINT_RECORDS_SUPPORTING_DOCUMENTS),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_PRINT),
+  import_zod.z.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
+  import_zod.z.literal(SCOPES.RECORD_PRINT_CERTIFIED_COPIES),
+  import_zod.z.literal(SCOPES.RECORD_BULK_PRINT_CERTIFIED_COPIES),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_VERIFY_CERTIFIED_COPIES),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REQUEST_CORRECTION),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_CORRECT),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REQUEST_REVOCATION),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REVOKE),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REQUEST_REINSTATEMENT),
+  import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REINSTATE),
+  import_zod.z.literal(SCOPES.RECORD_CONFIRM_REGISTRATION),
+  import_zod.z.literal(SCOPES.RECORD_REJECT_REGISTRATION),
+  import_zod.z.literal(SCOPES.SEARCH_BIRTH_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.SEARCH_BIRTH),
+  import_zod.z.literal(SCOPES.SEARCH_DEATH_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.SEARCH_DEATH),
+  import_zod.z.literal(SCOPES.SEARCH_MARRIAGE_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.SEARCH_MARRIAGE),
+  import_zod.z.literal(SCOPES.RECORD_READ),
+  import_zod.z.literal(SCOPES.RECORD_READ_AUDIT),
+  import_zod.z.literal(SCOPES.RECORD_READ_COMMENTS),
+  import_zod.z.literal(SCOPES.RECORD_CREATE_COMMENTS),
+  import_zod.z.literal(SCOPES.PROFILE_UPDATE),
+  import_zod.z.literal(SCOPES.PROFILE_ELECTRONIC_SIGNATURE),
+  import_zod.z.literal(SCOPES.PERFORMANCE_READ),
+  import_zod.z.literal(SCOPES.PERFORMANCE_READ_DASHBOARDS),
+  import_zod.z.literal(SCOPES.PERFORMANCE_EXPORT_VITAL_STATISTICS),
+  import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS),
+  import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_OFFICE),
+  import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.USER_READ),
+  import_zod.z.literal(SCOPES.USER_READ_MY_OFFICE),
+  import_zod.z.literal(SCOPES.USER_READ_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.USER_READ_ONLY_MY_AUDIT),
+  import_zod.z.literal(SCOPES.USER_CREATE),
+  import_zod.z.literal(SCOPES.USER_CREATE_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.USER_UPDATE),
+  import_zod.z.literal(SCOPES.USER_UPDATE_MY_JURISDICTION),
+  import_zod.z.literal(SCOPES.CONFIG_UPDATE_ALL),
+  import_zod.z.literal(SCOPES.USER_DATA_SEEDING)
+]);
+var rawConfigurableScopeRegex = /^([a-zA-Z\.]+)\[((?:\w+=[\w.-]+(?:\|[\w.-]+)*)(?:,[\w]+=[\w.-]+(?:\|[\w.-]+)*)*)\]$/;
+var rawConfigurableScope = import_zod.z.string().regex(rawConfigurableScopeRegex);
+var CreateUserScope = import_zod.z.object({
+  type: import_zod.z.literal("user.create"),
+  options: import_zod.z.object({
+    role: import_zod.z.array(import_zod.z.string())
+  })
+});
+var EditUserScope = import_zod.z.object({
+  type: import_zod.z.literal("user.edit"),
+  options: import_zod.z.object({
+    role: import_zod.z.array(import_zod.z.string())
+  })
+});
+var WorkqueueScope = import_zod.z.object({
+  type: import_zod.z.literal("workqueue"),
+  options: import_zod.z.object({
+    id: import_zod.z.array(import_zod.z.string())
+  })
+});
+var NotifyRecordScope = import_zod.z.object({
+  type: import_zod.z.literal("record.notify"),
+  options: import_zod.z.object({
+    event: import_zod.z.array(import_zod.z.string())
+  })
+});
+var ConfigurableScopes = import_zod.z.discriminatedUnion("type", [
+  CreateUserScope,
+  EditUserScope,
+  WorkqueueScope,
+  NotifyRecordScope
+]);
+function findScope(scopes2, scopeType) {
+  const parsedScopes = scopes2.map((rawScope) => parseScope(rawScope));
+  return parsedScopes.find(
+    (parsedScope) => parsedScope?.type === scopeType
+  );
+}
+function parseScope(scope) {
+  const maybeLiteralScope = LiteralScopes.safeParse(scope);
+  if (maybeLiteralScope.success) {
+    return {
+      type: maybeLiteralScope.data
+    };
+  }
+  const maybeConfigurableScope = rawConfigurableScope.safeParse(scope);
+  if (!maybeConfigurableScope.success) {
+    return;
+  }
+  const rawScope = maybeConfigurableScope.data;
+  const [, type, rawOptions] = rawScope.match(rawConfigurableScopeRegex) ?? [];
+  const options = rawOptions.split(",").reduce((acc, option) => {
+    const [key, value] = option.split("=");
+    acc[key] = value.split("|");
+    return acc;
+  }, {});
+  const parsedScope = {
+    type,
+    options
+  };
+  const result = ConfigurableScopes.safeParse(parsedScope);
+  return result.success ? result.data : void 0;
+}
+function stringifyScope(scope) {
+  const options = Object.entries(scope.options).map(([key, value]) => `${key}=${value.join("|")}`).join(",");
+  return `${scope.type}[${options}]`;
+}
 var scopes = Object.values(SCOPES);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "1.8.0-rc.fef85f2",
+  "version": "1.8.0-rc.ff0b26c",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "exports": {
@@ -20,7 +20,8 @@
     "ajv-formats": "^3.0.1",
     "superjson": "1.9.0-0",
     "@trpc/client": "^11.0.0-rc.648",
-    "@trpc/server": "^11.0.0-rc.532"
+    "@trpc/server": "^11.0.0-rc.532",
+    "zod-openapi": "^4.2.4"
   },
   "devDependencies": {
     "@types/uuid": "^9.0.3",