@carecard/validate 3.36.0 → 3.37.0

package/.agents/skills/carecard-api-contract/SKILL.md

@@ -0,0 +1,101 @@
+---
+name: carecard-api-contract
+description: 'Mandatory for every task after carecard-must-do and the repository engineering standards. Maintain non-negotiable API conformity across server calls, direct browser uploads and messaging, seed data, mocks, tests, and documentation.'
+---
+
+# CareCard API Contract
+
+## Mandatory Use
+
+Every agent must read and apply this skill on every task, including planning,
+read-only investigation, coding, review, tests, documentation, and skill work.
+Load `carecard-must-do` first, then the repository engineering standards, then
+this skill before narrower skills. Use this repository's own copy; no test,
+hook, build, or runtime dependency on another checkout is permitted.
+
+## Non-Negotiable API Conformity
+
+The authoritative API contracts are the implemented request and response
+boundaries between `ms-*` and `app-*` server components, called through the
+`app-*` service layer. The implemented direct browser contracts for file
+uploads and messaging are also authoritative.
+
+Seed data in `cc-seed-data`, mock data and test data in every `app-*` repository,
+API documentation, E2E test data, helpers, examples, and every other place
+where these contracts are represented must always use and conform to those
+authoritative contracts. A mock, seed, test, document, or example must never
+redefine an API contract. This requirement is non-negotiable.
+
+Every field in every non-authoritative request and response must have the same
+data type and nullability as its authoritative boundary. Preserve UUID string
+formats, timestamp and date-only string formats, booleans, numbers, arrays,
+objects, and explicit null values. Preserve endpoint-specific numeric strings
+when the owner returns them, including PostgreSQL BIGINT message sequences;
+do not substitute numbers just because an app transform later parses them.
+
+## Determine the Contract Before Changing Representations
+
+- Trace each request through the application service query, validation, and
+  transform to the owning microservice route, controller, and response writer.
+  Inspect database/model behavior when it determines the returned data.
+- Compare method, path, authentication, parameters, headers, body fields,
+  casing, types, identifiers, required/optional/null values, status codes,
+  response data, errors, envelope metadata, and pagination.
+- Distinguish raw HTTP data from transformed application objects and relational
+  seed rows. Seed rows must satisfy the owning schema and produce conforming
+  API results; they are not HTTP response envelopes.
+- Preserve intentional mock-only controls as explicit development seams. They
+  do not authorize different production API payloads or outcomes.
+- For direct browser uploads, trace the application-owned intent request and
+  the byte upload with its one-use bearer credential. Preserve the actual
+  multipart body, response, and failure contract.
+- For direct browser messaging, trace application-owned ticket issuance,
+  handshake authentication, commands, acknowledgements, events, and recovery.
+  Preserve endpoint-specific formats; do not wrap binary content, bodyless
+  responses, tickets, or realtime acknowledgements in a generic JSON envelope.
+
+## Repair and Maintain All Affected Representations
+
+- Fix verified drift at its originating input, generator, mock factory, or
+  fixture and update every dependent representation in the same task.
+- Edit seed facts/generators in `cc-seed-data`; regenerate ignored outputs
+  rather than patching generated dumps or creating editable seed copies.
+- Reuse existing service types and repository-native helpers. Do not add
+  compatibility aliases, alternate shapes, a parallel schema framework, or
+  runtime cross-repository imports to conceal a mismatch.
+- When an authoritative contract intentionally evolves, identify and update
+  every affected seed, mock, test, example, API document, E2E scenario, and skill.
+  Documentation inventories remain derived evidence, not a new authority.
+- Keep equivalent copies of this skill aligned and preserve repository-local
+  ownership. Do not infer authorization to publish, deploy, or reset data.
+
+## Behavioral Validation
+
+Use TDD for executable changes: establish a failing observable request,
+response, event, or persisted-data assertion before implementation. Exercise
+public callable boundaries; do not test source text or internal structure.
+Cover affected success and failure outcomes, and run the validation required
+by the current task and the owning repository. Validate documentation and
+skill changes with focused non-test checks. Never claim an unrun check passed.
+
+## Shared Engineering Requirements
+
+Non-negotiable TDD rule: Always write the failing test first, run it to confirm it fails for the intended reason, then implement the code and rerun the test until it passes. Test Driven Development is required for all coding work and must not be skipped. For documentation- or skill-only edits, run the relevant focused non-test validation before changing the prose; do not add automated tests that inspect prose, files, or repository structure.
+
+Non-negotiable repository isolation rule: Every repository must run its Husky hooks and tests using only files, code, fixtures, dependencies, and services contained within that repository. Tests and Husky scripts must not import, require, read, execute, or otherwise depend on sibling repositories or paths outside the repository root. app-e2e-tests is the only exception because cross-repository end-to-end testing is its explicit responsibility.
+
+Non-negotiable code organization rule: Functions with the same or equivalent behavior must use the same or clearly corresponding descriptive names across CareCard repositories, and equivalent functionality must live in files with the same names within each repository's established architecture. No backward compatibility names, aliases, or duplicate locations are allowed.
+
+### Non-Negotiable Microservice Layer Testing Contract
+
+For every `ms-*` microservice, each applicable testing layer below is mandatory. In this contract, testing a function directly means invoking its documented callable boundary with controlled inputs. It never means testing its internals or other implementation details directly. Every function under test must be treated as a black box.
+
+- Every database function and every stable database-access function must be exercised through its callable database boundary against the repository-owned test database. Place this coverage in `test/db/<related-model>[.<behavior>].test.<ext>`.
+- Every model function that reads or changes database data must be exercised through its callable model interface. Place this coverage in `test/<sub-app>/model.test.<ext>` or a more specific model test file in the same directory.
+- Every controller function used by the application must be exercised through its callable controller interface with controlled request, response, and error inputs. Place this coverage in `test/<sub-app>/controller.test.<ext>` or a more specific controller test file in the same directory.
+- Every application route must be exercised with real HTTP requests against the composed application mounted on a repository-managed Node HTTP server. Place this coverage in `test/<sub-app>/app.test.<ext>`; use `test/app/app.test.<ext>` for routes without a sub-app.
+- Every large helper function and every helper with independent domain behavior, validation, mapping, branching, state transition, object mutation, or failure behavior must have behavior coverage in `test/<sub-app>/helper.test.<ext>` or an appropriately named test file. Exercise a documented callable helper interface as a black box. Cover a private helper implementation through the callable boundary that owns it, and never export or invoke it solely for testing.
+- Tests must provide inputs and assert observable outputs, errors, persisted state, side effects, emitted behavior, or intentional object mutation.
+- Tests must not directly invoke, inspect, spy on, or assert implementation details, including private functions or state, SQL or query text and construction, algorithms, branches, control flow, variable names, collaborator sequences, or internal call counts.
+- A behavior-preserving rewrite behind an unchanged callable contract must not require functional test changes.
+- Use the repository-native test extension, such as `.js`, `.ts`, or `.mjs`. A microservice without a particular layer does not need an empty placeholder test file.

package/.agents/skills/pkg-validate-coding-standards-and-best-practices/SKILL.md

@@ -5,6 +5,15 @@ description: 'Use after carecard-must-do. Mandatory for every pkg-validate task,
 
 # Pkg Validate Coding Standards And Best Practices
 
+## Mandatory API Contract Skill
+
+Non-negotiable: On every task, read and apply
+[carecard-api-contract](../carecard-api-contract/SKILL.md) after
+`carecard-must-do` and this engineering skill, before any narrower skill. This
+applies to planning, read-only work, implementation, tests, documentation, and
+skill maintenance. All non-authoritative representations must always conform
+to the implemented server and direct browser API contracts.
+
 ## Release 1.1.1 and production data
 
 CareCard Release 1.1.1 is the production baseline. Seeding with

package/index.d.ts

@@ -144,8 +144,10 @@ export const isCcIdString: BoolValidator;
 export const isCharactersString: BoolValidator;
 /** Checks if the string is a valid street address format. */
 export const isStreetString: BoolValidator;
-/** Checks if the string is a valid name format. */
+/** Checks visible, well-formed Unicode names up to 1000 UTF-16 code units. */
 export const isNameString: BoolValidator;
+/** Checks NFKC-trimmed filename metadata up to 255 code points, excluding paths and unsafe controls. */
+export const isFileNameString: BoolValidator;
 /** Checks if the string is safe for search queries. */
 export const isSafeSearchString: BoolValidator;
 /** Checks if the string is a valid email address. */
@@ -203,6 +205,7 @@ export const validate: {
   isCharactersString: typeof isCharactersString;
   isStreetString: typeof isStreetString;
   isNameString: typeof isNameString;
+  isFileNameString: typeof isFileNameString;
   isSafeSearchString: typeof isSafeSearchString;
   isEmailString: typeof isEmailString;
   isJwtString: typeof isJwtString;

package/lib/validate.js

@@ -68,11 +68,36 @@ const isStreetString = str => {
   return streetRegex.test(value);
 };
 
+// Pattern: Predicate - shares Unicode safety without changing the original text.
+const hasSafeVisibleName = value => {
+  return (
+    value.isWellFormed() &&
+    !/[\p{Cc}\p{Zl}\p{Zp}\u202a-\u202e\u2066-\u2069]/u.test(value) &&
+    /[\p{L}\p{N}\p{P}\p{S}\p{Co}]/u.test(value.replace(/\p{Default_Ignorable_Code_Point}/gu, ''))
+  );
+};
+
+// Pattern: Predicate - accepts visible international names within the existing size budget.
 const isNameString = str => {
   if (typeof str !== 'string' || str.length === 0 || str.length > 1000) {
     return false;
   }
-  return /^[A-Za-z][0-9a-zA-Z-_.,'() ]+$/.test(str.trim());
+  return hasSafeVisibleName(str.trim());
+};
+
+// Pattern: Predicate - validates canonical display metadata, never a filesystem path.
+const isFileNameString = str => {
+  if (typeof str !== 'string') {
+    return false;
+  }
+  const fileName = str.normalize('NFKC').trim();
+  return (
+    [...fileName].length <= 255 &&
+    hasSafeVisibleName(fileName) &&
+    fileName !== '.' &&
+    fileName !== '..' &&
+    !/[/\\]/u.test(fileName)
+  );
 };
 
 const isSafeSearchString = str => {
@@ -350,6 +375,7 @@ module.exports = {
   isCharactersString,
   isStreetString,
   isNameString,
+  isFileNameString,
   isSafeSearchString,
   isEmailString,
   isJwtString,

package/lib/validateProperties.js

@@ -7,7 +7,7 @@ const {
   isCcIdString,
   validatePassword,
   isNameString,
-  isSafeSearchString,
+  isFileNameString,
   isCharactersString,
   isValidIntegerString,
   isValidJsonString,
@@ -35,7 +35,14 @@ function validateProperties(obj = {}) {
       case 'firstName':
       case 'last_name':
       case 'lastName':
-      case 'username':
+      case 'middle_name':
+      case 'middleName':
+      case 'nick_name':
+      case 'nickName':
+      case 'requested_by_name':
+      case 'requestedByName':
+      case 'approved_by_name':
+      case 'approvedByName':
       case 'new_status':
       case 'newStatus':
       case 'description':
@@ -79,6 +86,18 @@ function validateProperties(obj = {}) {
           returnObj[key] = value;
         }
         break;
+      case 'username':
+        if (isNameString(value) && /^[A-Za-z][0-9a-zA-Z-_.,'() ]+$/.test(value.trim())) {
+          returnObj[key] = value;
+        }
+        break;
+      case 'file_name':
+      case 'fileName':
+      case 'filename':
+        if (isFileNameString(value)) {
+          returnObj[key] = value.normalize('NFKC').trim();
+        }
+        break;
       case 'street':
         if (isStreetString(value)) {
           returnObj[key] = value;
@@ -101,7 +120,7 @@ function validateProperties(obj = {}) {
         break;
       case 'search_string':
       case 'searchString':
-        if (isSafeSearchString(value)) {
+        if (isNameString(value) && value.trim().length <= 101) {
           returnObj[key] = value;
         }
         break;
@@ -205,16 +224,10 @@ function validateProperties(obj = {}) {
           returnObj[key] = value;
         }
         break;
-      case 'requested_by_name':
-      case 'requestedByName':
       case 'document_description':
       case 'documentDescription':
-      case 'nick_name':
-      case 'nickName':
       case 'requested_by_phone':
       case 'requestedByPhone':
-      case 'approved_by_name':
-      case 'approvedByName':
       case 'approved_by_phone':
       case 'approvedByPhone':
         if (isTextString(value)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carecard/validate",
-  "version": "3.36.0",
+  "version": "3.37.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.36.0"
+    "@carecard/common-util": "3.37.0"
   },
   "nyc": {
     "all": true,