@carecard/validate 3.30.0 → 3.31.0

package/index.d.ts

@@ -84,7 +84,7 @@ export interface ValidateWhitelistPropertiesFunction {
 
 export const validateWhitelistProperties: ValidateWhitelistPropertiesFunction;
 
-export type UserRoleRequestRole = 'student' | 'intern' | 'volunteer';
+export type UserRoleRequestRole = 'student' | 'intern' | 'volunteer' | 'applicant';
 export type UserRoleRequestScopeRequirement =
   boolean | typeof REQUIRE_SCOPE_WHEN_ROLE_OR_SCOPE_PRESENT;
 
@@ -120,7 +120,7 @@ export interface ValidateNewUserRoleRequestPayload extends Record<string, unknow
 
 /**
  * Normalizes and validates an institutions.new_user_role_request payload.
- * Only student, intern, and volunteer are accepted. When scope is required,
+ * Only student, intern, volunteer, and applicant are accepted. When scope is required,
  * both institution_id and campus_id must be provided.
  */
 export function validateNewUserRoleRequestObject(

package/lib/validate.js

@@ -229,7 +229,7 @@ const isUserRoleRequestStatusString = inputString => {
 };
 
 const isUserRoleRequestRoleString = inputString => {
-  const roles = ['student', 'intern', 'volunteer'];
+  const roles = ['student', 'intern', 'volunteer', 'applicant'];
   return typeof inputString === 'string' && roles.includes(inputString.trim().toLowerCase());
 };
 

package/lib/validateNewUserRoleRequest.js

@@ -45,7 +45,7 @@ function normalizeNewUserRoleRequestRole(roleRequest) {
   if (!isUserRoleRequestRoleString(roleRequest.role_name)) {
     throwBadInputError({
       userMessage: 'Invalid property: role.role',
-      details: { role: 'Role requests are limited to student, intern, or volunteer' },
+      details: { role: 'Role requests are limited to student, intern, volunteer, or applicant' },
     });
   }
   roleRequest.role_name = roleRequest.role_name.trim().toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carecard/validate",
-  "version": "3.30.0",
+  "version": "3.31.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/CareCard-ca/pkg-validate.git"
@@ -47,7 +47,7 @@
     "typescript": "6.0.3"
   },
   "dependencies": {
-    "@carecard/common-util": "3.30.0"
+    "@carecard/common-util": "3.31.0"
   },
   "nyc": {
     "all": true,

package/readme.md

@@ -477,3 +477,10 @@ A correct implementation may be completely rewritten or refactored without requi
 Any test that fails solely because the implementation changed while the externally observable behavior remained correct is incorrectly designed and must be rewritten or removed.
 
 This requirement is mandatory for all new tests and must be applied whenever existing tests are modified.
+
+### Institution request roles
+
+`isUserRoleRequestRoleString`, `validateNewUserRoleRequest`, and the exported
+`UserRoleRequestRole` type accept student, intern, volunteer, and applicant.
+Institution and campus remain required. Provider-specific eligibility is owned
+by ms-institutions; accepting applicant here does not grant assignment authority.