@ecrvs/opencrvs-toolkit 1.8.1-rc.a7ee8fb

package/dist/scopes/index.d.ts

@@ -0,0 +1,335 @@
+import { z } from 'zod';
+import { SearchScopeAccessLevels } from './events';
+export declare const SCOPES: {
+    readonly NATLSYSADMIN: "natlsysadmin";
+    readonly BYPASSRATELIMIT: "bypassratelimit";
+    readonly DECLARE: "declare";
+    readonly REGISTER: "register";
+    readonly VALIDATE: "validate";
+    readonly DEMO: "demo";
+    readonly CERTIFY: "certify";
+    readonly PERFORMANCE: "performance";
+    readonly SYSADMIN: "sysadmin";
+    readonly TEAMS: "teams";
+    readonly CONFIG: "config";
+    readonly WEBHOOK: "webhook";
+    readonly NATIONALID: "nationalId";
+    readonly NOTIFICATION_API: "notification-api";
+    readonly RECORDSEARCH: "recordsearch";
+    readonly RECORD_IMPORT: "record.import";
+    readonly RECORD_EXPORT: "record.export";
+    readonly RECORD_REINDEX: "record.reindex";
+    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";
+    readonly RECORD_DECLARE_DEATH_MY_JURISDICTION: "record.declare-death:my-jurisdiction";
+    readonly RECORD_DECLARE_MARRIAGE: "record.declare-marriage";
+    readonly RECORD_DECLARE_MARRIAGE_MY_JURISDICTION: "record.declare-marriage:my-jurisdiction";
+    readonly RECORD_SUBMIT_INCOMPLETE: "record.declaration-submit-incomplete";
+    readonly RECORD_SUBMIT_FOR_REVIEW: "record.declaration-submit-for-review";
+    readonly RECORD_UNASSIGN_OTHERS: "record.unassign-others";
+    readonly RECORD_SUBMIT_FOR_APPROVAL: "record.declaration-submit-for-approval";
+    readonly RECORD_SUBMIT_FOR_UPDATES: "record.declaration-submit-for-updates";
+    readonly RECORD_DECLARATION_EDIT: "record.declaration-edit";
+    readonly RECORD_REVIEW_DUPLICATES: "record.review-duplicates";
+    readonly RECORD_DECLARATION_ARCHIVE: "record.declaration-archive";
+    readonly RECORD_DECLARATION_REINSTATE: "record.declaration-reinstate";
+    readonly RECORD_REGISTER: "record.register";
+    readonly RECORD_EXPORT_RECORDS: "record.export-records";
+    readonly RECORD_DECLARATION_PRINT: "record.declaration-print";
+    readonly RECORD_PRINT_RECORDS_SUPPORTING_DOCUMENTS: "record.declaration-print-supporting-documents";
+    readonly RECORD_REGISTRATION_PRINT: "record.registration-print";
+    /**
+     * This scope is used to **print and **issue certified copies of a record
+     * after it has been registered. Previously Registrars had this permission.
+     */
+    readonly RECORD_PRINT_ISSUE_CERTIFIED_COPIES: "record.registration-print&issue-certified-copies";
+    readonly RECORD_PRINT_CERTIFIED_COPIES: "record.registration-print-certified-copies";
+    readonly RECORD_REGISTRATION_VERIFY_CERTIFIED_COPIES: "record.registration-verify-certified-copies";
+    readonly RECORD_REGISTRATION_REQUEST_CORRECTION: "record.registration-request-correction";
+    readonly RECORD_REGISTRATION_CORRECT: "record.registration-correct";
+    readonly RECORD_CONFIRM_REGISTRATION: "record.confirm-registration";
+    readonly RECORD_REJECT_REGISTRATION: "record.reject-registration";
+    readonly SEARCH_BIRTH_MY_JURISDICTION: "search.birth:my-jurisdiction";
+    readonly SEARCH_BIRTH: "search.birth";
+    readonly SEARCH_DEATH_MY_JURISDICTION: "search.death:my-jurisdiction";
+    readonly SEARCH_DEATH: "search.death";
+    readonly SEARCH_MARRIAGE_MY_JURISDICTION: "search.marriage:my-jurisdiction";
+    readonly SEARCH_MARRIAGE: "search.marriage";
+    readonly RECORD_READ: "record.read";
+    readonly PROFILE_UPDATE: "profile.update";
+    readonly PROFILE_ELECTRONIC_SIGNATURE: "profile.electronic-signature";
+    readonly PERFORMANCE_READ: "performance.read";
+    readonly PERFORMANCE_READ_DASHBOARDS: "performance.read-dashboards";
+    readonly PERFORMANCE_EXPORT_VITAL_STATISTICS: "performance.vital-statistics-export";
+    readonly ORGANISATION_READ_LOCATIONS: "organisation.read-locations:all";
+    readonly ORGANISATION_READ_LOCATIONS_MY_OFFICE: "organisation.read-locations:my-office";
+    readonly ORGANISATION_READ_LOCATIONS_MY_JURISDICTION: "organisation.read-locations:my-jurisdiction";
+    readonly USER_READ: "user.read:all";
+    readonly USER_READ_MY_OFFICE: "user.read:my-office";
+    readonly USER_READ_MY_JURISDICTION: "user.read:my-jurisdiction";
+    readonly USER_READ_ONLY_MY_AUDIT: "user.read:only-my-audit";
+    readonly USER_CREATE: "user.create:all";
+    readonly USER_CREATE_MY_JURISDICTION: "user.create:my-jurisdiction";
+    readonly USER_UPDATE: "user.update:all";
+    readonly USER_UPDATE_MY_JURISDICTION: "user.update:my-jurisdiction";
+    readonly CONFIG_UPDATE_ALL: "config.update:all";
+    readonly USER_DATA_SEEDING: "user.data-seeding";
+};
+export declare const SearchScopes: z.ZodUnion<[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">]>;
+declare const LiteralScopes: z.ZodUnion<[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.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"nationalId">, z.ZodLiteral<"notification-api">, z.ZodLiteral<"recordsearch">]>, z.ZodLiteral<"record.unassign-others">, z.ZodUnion<[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.ZodUnion<[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.ZodUnion<[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-verify-certified-copies">]>, z.ZodUnion<[z.ZodLiteral<"record.registration-request-correction">, z.ZodLiteral<"record.registration-correct">, z.ZodLiteral<"record.confirm-registration">, z.ZodLiteral<"record.reject-registration">]>, z.ZodUnion<[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.ZodUnion<[z.ZodLiteral<"profile.update">, z.ZodLiteral<"profile.electronic-signature">]>, z.ZodUnion<[z.ZodLiteral<"performance.read">, z.ZodLiteral<"performance.read-dashboards">, z.ZodLiteral<"performance.vital-statistics-export">]>, z.ZodUnion<[z.ZodLiteral<"organisation.read-locations:all">, z.ZodLiteral<"organisation.read-locations:my-office">, z.ZodLiteral<"organisation.read-locations:my-jurisdiction">]>, z.ZodUnion<[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">, z.ZodUnion<[z.ZodLiteral<"record.reindex">, z.ZodLiteral<"record.import">]>]>;
+declare const SearchScope: z.ZodObject<{
+    type: z.ZodLiteral<"search">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+        access: z.ZodArray<z.ZodEnum<["my-jurisdiction", "all"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}>;
+export type SearchScope = z.infer<typeof SearchScope>;
+export declare const RecordScopeType: z.ZodEnum<["record.create", "record.read", "record.declare", "record.notify", "record.declared.validate", "record.declared.reject", "record.declared.archive", "record.declared.review-duplicates", "record.register", "record.registered.print-certified-copies", "record.registered.request-correction", "record.registered.correct", "record.unassign-others"]>;
+export type RecordScopeType = z.infer<typeof RecordScopeType>;
+export declare const RecordScope: z.ZodObject<{
+    type: z.ZodEnum<["record.create", "record.read", "record.declare", "record.notify", "record.declared.validate", "record.declared.reject", "record.declared.archive", "record.declared.review-duplicates", "record.register", "record.registered.print-certified-copies", "record.registered.request-correction", "record.registered.correct", "record.unassign-others"]>;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+    }, {
+        event: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+}, {
+    type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+}>;
+export type RecordScope = z.infer<typeof RecordScope>;
+declare const ConfigurableRawScopes: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"search">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+        access: z.ZodArray<z.ZodEnum<["my-jurisdiction", "all"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}>, 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.ZodEnum<["record.create", "record.read", "record.declare", "record.notify", "record.declared.validate", "record.declared.reject", "record.declared.archive", "record.declared.review-duplicates", "record.register", "record.registered.print-certified-copies", "record.registered.request-correction", "record.registered.correct", "record.unassign-others"]>;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+    }, {
+        event: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+}, {
+    type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+}>]>;
+type ConfigurableRawScopes = z.infer<typeof ConfigurableRawScopes>;
+export type ConfigurableScopeType = ConfigurableRawScopes['type'];
+type FlattenedSearchScope = {
+    type: 'search';
+    options: Record<string, SearchScopeAccessLevels>;
+};
+export type ConfigurableScopes = Exclude<ConfigurableRawScopes, {
+    type: 'search';
+}> | FlattenedSearchScope;
+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.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+}, {
+    type: T;
+}> | Extract<FlattenedSearchScope, {
+    type: T;
+}> | undefined;
+/**
+ * Parses a configurable scope string into a ConfigurableRawScopes object.
+ * @param {string} scope - The scope string to parse
+ * @returns {ConfigurableRawScopes | 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 parseConfigurableScope(scope: string): {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+} | {
+    type: "user.create";
+    options: {
+        role: string[];
+    };
+} | {
+    type: "user.edit";
+    options: {
+        role: string[];
+    };
+} | {
+    type: "workqueue";
+    options: {
+        id: string[];
+    };
+} | {
+    type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
+    options: {
+        event: string[];
+    };
+} | undefined;
+export declare function parseLiteralScope(scope: string): {
+    type: "natlsysadmin" | "bypassratelimit" | "declare" | "register" | "validate" | "demo" | "certify" | "performance" | "sysadmin" | "teams" | "config" | "webhook" | "nationalId" | "notification-api" | "recordsearch" | "record.import" | "record.reindex" | "record.declare-birth" | "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-verify-certified-copies" | "record.registration-request-correction" | "record.registration-correct" | "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" | "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: ["birth", "tennis-club-membership"] }
+ * })
+ * // Returns: "record.notify[event=birth|tennis-club-membership]"
+ */
+export declare function stringifyScope(scope: z.infer<typeof ConfigurableRawScopes>): string;
+/**
+ * Extracts authorized event identifiers (e.g. birth, death) from the provided configurable scopes.
+ *
+ * @param scopes - Array of configurable scopes with options
+ * @returns Array of authorized event identifiers
+ */
+export declare function getAuthorizedEventsFromScopes(scopes: ConfigurableScopes[]): string[];
+export declare const scopes: Scope[];
+export type ParsedScopes = NonNullable<ReturnType<typeof parseConfigurableScope>>;
+export type RawScopes = z.infer<typeof LiteralScopes> | (string & {});
+export type Scope = RawScopes;
+export declare const ActionScopes: z.ZodUnion<[z.ZodUnion<[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.ZodUnion<[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.ZodUnion<[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-verify-certified-copies">]>, z.ZodUnion<[z.ZodLiteral<"record.registration-request-correction">, z.ZodLiteral<"record.registration-correct">, z.ZodLiteral<"record.confirm-registration">, z.ZodLiteral<"record.reject-registration">]>]>;
+export type ActionScopes = z.infer<typeof ActionScopes>;
+export {};
+//# sourceMappingURL=scopes.d.ts.map

package/dist/scopes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/scopes/index.ts"],"names":[],"mappings":"AAUA,cAAc,0BAA0B,CAAA"}