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

package/create-countryconfig/index.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+
+const { execSync } = require('child_process')
+const path = require('path')
+const fs = require('fs')
+
+const REPO_URL = 'https://github.com/opencrvs/opencrvs-countryconfig.git'
+
+const projectName = process.argv[2]
+
+if (!projectName) {
+  console.error(
+    'Please specify a project name:\n\n  npm create @opencrvs/countryconfig <project-name>\n'
+  )
+  process.exit(1)
+}
+
+const targetDir = path.resolve(process.cwd(), projectName)
+
+if (fs.existsSync(targetDir)) {
+  console.error(`Error: Directory "${projectName}" already exists.`)
+  process.exit(1)
+}
+
+console.log(`\nScaffolding OpenCRVS country config in ./${projectName}...\n`)
+
+try {
+  execSync(`git clone --depth 1 ${REPO_URL} ${projectName}`, {
+    stdio: 'inherit'
+  })
+} catch (err) {
+  console.error('Failed to clone the repository:', err.message)
+  process.exit(1)
+}
+
+try {
+  fs.rmSync(path.join(targetDir, '.git'), { recursive: true, force: true })
+} catch (err) {
+  console.error('Failed to remove .git directory:', err.message)
+  process.exit(1)
+}
+
+const pkgPath = path.join(targetDir, 'package.json')
+if (fs.existsSync(pkgPath)) {
+  try {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+    pkg.name = projectName
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+  } catch (err) {
+    console.error('Failed to update package.json:', err.message)
+    process.exit(1)
+  }
+} else {
+  console.warn(
+    `Warning: No package.json found in the cloned repository. Project name was not updated.`
+  )
+}
+
+console.log(`\nDone! To get started:\n`)
+console.log(`  cd ${projectName}`)
+console.log(`  git init`)
+console.log(`  npm install\n`)

package/create-countryconfig/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@opencrvs/create-countryconfig",
+  "version": "1.0.0",
+  "description": "Scaffold a new OpenCRVS country configuration",
+  "bin": {
+    "create-countryconfig": "./index.js"
+  },
+  "files": ["index.js"],
+  "keywords": ["opencrvs", "countryconfig", "create"],
+  "license": "MPL-2.0"
+}

package/dist/application-config/index.js

@@ -75,7 +75,10 @@ var ActionConditional = z.discriminatedUnion("type", [
   ShowConditional,
   // Action can be shown to the user in the list but as disabled
   EnableConditional
-]);
+]).meta({
+  description: "Action conditional configuration",
+  id: "ActionConditional"
+});
 var DisplayOnReviewConditional = z.object({
   type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
   conditional: Conditional
@@ -418,28 +421,20 @@ function schemaPriority(schema) {
   return idx === -1 ? 9999 : idx;
 }
 function safeUnion(schemas) {
+  const sortedSchemas = [...schemas].sort(
+    (a, b) => schemaPriority(a) - schemaPriority(b)
+  );
   return z7.any().superRefine((val, ctx) => {
-    const successful = schemas.filter((s) => s.safeParse(val).success);
-    if (successful.length === 1) {
-      return;
-    }
-    if (successful.length === 0) {
-      ctx.addIssue({
-        code: "invalid_type",
-        expected: "custom",
-        message: "Value does not match any schema"
-      });
-      return;
-    }
-    successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
-    const best = successful[0];
-    if (!best.safeParse(val).success) {
-      ctx.addIssue({
-        expected: "custom",
-        code: "invalid_type",
-        message: "Value did not match the best schema"
-      });
+    for (const schema of sortedSchemas) {
+      if (schema.safeParse(val).success) {
+        return;
+      }
     }
+    ctx.addIssue({
+      code: "invalid_type",
+      expected: "custom",
+      message: "Value does not match any schema"
+    });
   }).meta({
     description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
   });
@@ -656,6 +651,10 @@ var scopeByEvent = z11.preprocess(
   (val) => val === void 0 ? void 0 : [val].flat(),
   z11.array(z11.string()).optional()
 ).describe("Event type, e.g. birth, death");
+var userRole = z11.preprocess(
+  (val) => val === void 0 ? void 0 : [val].flat(),
+  z11.array(z11.string()).optional()
+).describe("User role, e.g. admin, field agent");
 var scopeOptionsPlaceEvent = z11.object({
   event: scopeByEvent,
   placeOfEvent: JurisdictionFilter.optional()
@@ -679,6 +678,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
 var AccessLevelOptions = z11.object({
   accessLevel: JurisdictionFilter.optional()
 });
+var AllUserScopeOptions = AccessLevelOptions.extend({
+  role: userRole.optional()
+});
 var WorkqueueOrDashboardOptions = z11.object({
   ids: z11.preprocess(
     (val) => val === void 0 ? void 0 : [val].flat(),
@@ -688,6 +690,7 @@ var WorkqueueOrDashboardOptions = z11.object({
 var AllScopeOptions = z11.object({
   ...AllRecordScopeOptions.shape,
   ...AccessLevelOptions.shape,
+  ...AllUserScopeOptions.shape,
   ...WorkqueueOrDashboardOptions.shape
 });
 var ScopeOptionKey = AllScopeOptions.keyof();
@@ -760,6 +763,30 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
 ]).describe(
   "Scopes used to check user's permission to perform actions on a record."
 );
+var SystemScopeType = z11.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 = z11.discriminatedUnion("type", [
+  z11.object({
+    type: ScopesWithRoleOption,
+    options: AllUserScopeOptions.optional()
+  }),
+  z11.object({
+    type: UserScopeType.extract(["user.read", "user.search"]),
+    options: AccessLevelOptions.optional()
+  })
+]);
 var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
   z11.object({
     type: ScopesWithPlaceEventOptions,
@@ -780,16 +807,14 @@ var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
     }).optional()
   })
 ]).describe("Resolved scope with location/user IDs instead of filters.");
-var SystemScopeType = z11.enum([
-  "organisation.read-locations",
-  "user.read",
-  "user.create",
-  "user.edit"
-]);
 var Scope = z11.discriminatedUnion("type", [
   z11.object({ type: PlainScopeType }),
   ...RecordScopeV2.options,
-  z11.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
+  ...UserScopeV2.options,
+  z11.object({
+    type: z11.literal("organisation.read-locations"),
+    options: AccessLevelOptions.optional()
+  }),
   z11.object({
     type: z11.literal("workqueue"),
     options: WorkqueueOrDashboardOptions
@@ -809,7 +834,9 @@ var ScopeType = z11.enum([
 var EncodedScope = z11.string().brand("EncodedScope");
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,
-  accessLevel: JurisdictionFilter.enum.all
+  accessLevel: JurisdictionFilter.enum.all,
+  registeredIn: JurisdictionFilter.enum.all,
+  declaredIn: JurisdictionFilter.enum.all
 };
 
 // ../commons/src/authentication.ts
@@ -1055,6 +1082,9 @@ var FlagConfig = z14.object({
     "Indicates if this flag expects an action to be performed to be cleared."
   ),
   label: TranslationConfig.describe("Human readable label of the flag.")
+}).meta({
+  description: "Flag configuration",
+  id: "FlagConfig"
 });
 var ActionFlagConfig = z14.object({
   id: Flag,
@@ -1062,6 +1092,9 @@ var ActionFlagConfig = z14.object({
   conditional: Conditional.optional().describe(
     "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
   )
+}).meta({
+  description: "Action flag configuration",
+  id: "ActionFlagConfig"
 });
 
 // ../commons/src/events/EventMetadata.ts
@@ -1083,8 +1116,7 @@ var ActionCreationMetadata = z15.object({
   ),
   createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
   acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
-  createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
-  createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
+  createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
 });
 var RegistrationCreationMetadata = ActionCreationMetadata.extend({
   registrationNumber: z15.string().describe(
@@ -1112,9 +1144,6 @@ var EventMetadata = z15.object({
   createdAtLocation: UUID.nullish().describe(
     "Location of the user who created the event."
   ),
-  createdBySignature: DocumentPath.nullish().describe(
-    "Signature of the user who created the event."
-  ),
   updatedAtLocation: UUID.nullish().describe(
     "Location of the user who last changed the status."
   ),
@@ -1378,7 +1407,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
   }
 }).describe("Unique identifier for the field");
 var FieldReference = import_v43.default.object({
-  $$field: FieldId,
+  $$field: FieldId.describe("Id of the field to reference"),
   $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
     'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
   )
@@ -2078,8 +2107,8 @@ var ApplicationConfig = z20.object({
     })
   ),
   PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
-  USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
-  INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
+  USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
+  INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
   SEARCH_DEFAULT_CRITERIA: SearchCriteria.optional().default("TRACKING_ID"),
   ADDITIONAL_USER_FIELDS: z20.array(FieldConfig).optional().default([])
 });
@@ -2097,8 +2126,8 @@ var BackgroundConfig = z20.object({
 var LoginConfig = z20.object({
   COUNTRY: z20.string(),
   LANGUAGES: z20.array(z20.string()),
-  USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
-  INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
+  USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
+  INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
   PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
   LOGIN_BACKGROUND: BackgroundConfig,
   SENTRY: z20.string().optional()