vet-sdk-core-ts 0.4.38 → 0.4.40

package/README.md

@@ -7,6 +7,12 @@ An animal is the first member of its own Individual Organization, so
 human that creates it is `Organization.owner`, the controller by default;
 `RESPRSN` must never be copied into the animal member.
 
+Name, birth date, exact NCBI species and optional breed are animal
+demographics. Breed remains separate descriptive text. Controller-authored
+demographics remain editable until a veterinarian attests them; attestation
+does not rewrite the original author, and later correction creates a new
+veterinarian-authored version.
+
 Use `buildVetChainAnimalDraftClaims(...)` while the name, exact NCBI species or
 public Card is missing. Only a draft for which
 `readVetChainAnimalOnboardingReadiness(...)` returns `ready: true` may be
@@ -222,6 +228,16 @@ The catalogue is a governed starter set, not a closed biological universe.
 Callers may retain another verified positive non-human NCBI Taxonomy identifier.
 This matters because animal keeping varies by jurisdiction and taxonomy evolves.
 
+Species-language resolution is channel-neutral. Voice, WhatsApp, portal chat
+and portal speech call `resolveVetChainSpeciesAlias` with the same localized
+lexicon. It performs exact normalized matching only. If that fast path misses,
+a server adapter implements `VetChainSpeciesTerminologyResolver` and sends text
+plus locale to the authenticated terminology service. The service returns a
+closed NCBI candidate set, which must pass
+`validateVetChainSpeciesTerminologyCandidates`; a model such as Gemma may rank
+that set but cannot add codes. `selectVetChainSpeciesTerminologyCandidate`
+accepts only a code actually returned for user review and confirmation.
+
 Current cards are issued with `issueVetChainAnimalCard`: five jurisdiction
 digits plus `animalNumericId15 + checkDigit1`, and the matching
 `did:web:{host}:card:vetchain:{jurisdiction5}:{animal16}`. Species is separate
@@ -232,10 +248,16 @@ being repeated in the 21 printed digits.
 import {
   VetChainDomesticAnimalSpecies,
   findVetChainSpeciesByTaxonomyId,
+  resolveVetChainSpeciesAlias,
 } from "vet-sdk-core-ts/species";
 
 VetChainDomesticAnimalSpecies.DomesticFerret.ncbiTaxonomyId; // "9669"
 findVetChainSpeciesByTaxonomyId("9685")?.key; // "Cat"
+resolveVetChainSpeciesAlias({
+  text: "Dog.",
+  locale: "en-CA",
+  lexicon: [{ ncbiTaxonomyId: "9615", acceptedTexts: ["dog", "it is a dog"] }],
+})?.ncbiTaxonomyId; // "9615"
 ```
 
 ## Digital-twin search

package/dist/animal-onboarding.d.ts

@@ -11,6 +11,7 @@ export type VetChainAnimalOnboardingInput = Readonly<{
     birthYear?: number;
     gender?: 'female' | 'male' | 'other' | 'unknown';
     ncbiTaxonomyId: string;
+    breedLabel?: string;
     controllerEmail?: string;
     controllerTelephone?: string;
     sector?: string;
@@ -24,6 +25,7 @@ export type VetChainAnimalDraftInput = Readonly<{
     birthYear?: number;
     gender?: 'female' | 'male' | 'other' | 'unknown';
     ncbiTaxonomyId?: string;
+    breedLabel?: string;
     controllerEmail?: string;
     controllerTelephone?: string;
     sector?: string;
@@ -41,6 +43,7 @@ export declare const VetChainAnimalOnboardingClaimNames: Readonly<{
     readonly sameAs: "org.schema.Organization.sameAs";
     readonly memberName: "org.schema.Organization.member.name";
     readonly memberAdditionalType: "org.schema.Organization.member.additionalType";
+    readonly memberBreed: "org.schema.Organization.member.breed";
     readonly memberBirthDate: "org.schema.Organization.member.birthDate";
     readonly memberGender: "org.schema.Organization.member.gender";
     readonly memberRole: "org.schema.Organization.member.role";

package/dist/animal-onboarding.js

@@ -12,6 +12,7 @@ export const VetChainAnimalOnboardingClaimNames = Object.freeze({
     sameAs: 'org.schema.Organization.sameAs',
     memberName: 'org.schema.Organization.member.name',
     memberAdditionalType: 'org.schema.Organization.member.additionalType',
+    memberBreed: 'org.schema.Organization.member.breed',
     memberBirthDate: 'org.schema.Organization.member.birthDate',
     memberGender: 'org.schema.Organization.member.gender',
     memberRole: 'org.schema.Organization.member.role',
@@ -37,8 +38,9 @@ export function buildVetChainAnimalDraftClaims(input) {
         throw new TypeError('vet_animal_card_species_required');
     if (cardDidWeb)
         assertCardSpecies(cardDidWeb, ncbiTaxonomyId);
-    const birthDate = String(input.birthDate || '').trim()
-        || (Number.isInteger(input.birthYear) ? String(input.birthYear) : '');
+    const birthDate = normalizePartialBirthDate(String(input.birthDate || '').trim()
+        || (Number.isInteger(input.birthYear) ? String(input.birthYear) : ''));
+    const breedLabel = String(input.breedLabel || '').trim();
     const legalName = String(input.legalName || '').trim();
     const gender = input.gender && input.gender !== 'unknown' ? input.gender : '';
     const claim = VetChainAnimalOnboardingClaimNames;
@@ -55,6 +57,7 @@ export function buildVetChainAnimalDraftClaims(input) {
         ...(ncbiTaxonomyId ? {
             [claim.memberAdditionalType]: `http://purl.obolibrary.org/obo/NCBITaxon_${ncbiTaxonomyId}`,
         } : {}),
+        ...(breedLabel ? { [claim.memberBreed]: breedLabel } : {}),
         [claim.memberRole]: VetChainAnimalMemberRoles.Self,
         ...(birthDate ? { [claim.memberBirthDate]: birthDate } : {}),
         ...(gender ? { [claim.memberGender]: gender } : {}),
@@ -63,6 +66,26 @@ export function buildVetChainAnimalDraftClaims(input) {
         [claim.serviceCategory]: String(input.sector || '').trim() || 'animal-care',
     });
 }
+/** Normalizes ISO 8601 reduced-precision animal birth dates (year, year-month or full date). */
+function normalizePartialBirthDate(value) {
+    if (!value)
+        return '';
+    const match = value.match(/^(\d{4})(?:-(\d{2})(?:-(\d{2}))?)?$/);
+    if (!match)
+        throw new TypeError('vet_animal_birth_date_invalid');
+    const year = Number(match[1]);
+    const month = match[2] ? Number(match[2]) : undefined;
+    const day = match[3] ? Number(match[3]) : undefined;
+    if (year < 1000 || year > 9999 || (month !== undefined && (month < 1 || month > 12))) {
+        throw new TypeError('vet_animal_birth_date_invalid');
+    }
+    if (day !== undefined) {
+        const lastDay = new Date(Date.UTC(year, month, 0)).getUTCDate();
+        if (day < 1 || day > lastDay)
+            throw new TypeError('vet_animal_birth_date_invalid');
+    }
+    return value;
+}
 /** Reports whether an animal draft can be activated and issued a public Card. */
 export function readVetChainAnimalOnboardingReadiness(claims) {
     const claim = VetChainAnimalOnboardingClaimNames;

package/dist/species.d.ts

@@ -9,6 +9,27 @@ export type VetChainSpeciesDefinition = Readonly<{
     scientificName: string;
     group: VetChainAnimalGroup;
 }>;
+export declare const VETCHAIN_NCBI_TAXONOMY_CODE_SYSTEM: "https://www.ncbi.nlm.nih.gov/Taxonomy";
+/** Localized exact texts supplied by a VetChain product, independently of its channel adapter. */
+export type VetChainSpeciesLexiconEntry = Readonly<{
+    ncbiTaxonomyId: NcbiTaxonomyId;
+    acceptedTexts: readonly string[];
+}>;
+/** One reviewable result returned by the authenticated terminology service. */
+export type VetChainSpeciesTerminologyCandidate = Readonly<{
+    codeSystem: typeof VETCHAIN_NCBI_TAXONOMY_CODE_SYSTEM;
+    codeValue: NcbiTaxonomyId;
+    display: string;
+    score?: number;
+}>;
+/** Channel-neutral boundary implemented by a server-side VetChain terminology adapter. */
+export interface VetChainSpeciesTerminologyResolver {
+    search(input: Readonly<{
+        text: string;
+        locale: string;
+        maxCandidates: number;
+    }>): Promise<readonly VetChainSpeciesTerminologyCandidate[]>;
+}
 /**
  * Governed starter catalogue for domesticated and commonly kept animals.
  *
@@ -482,3 +503,27 @@ export declare const VetChainDomesticAnimalSpeciesList: readonly Readonly<{
 export declare function findVetChainSpeciesByTaxonomyId(value: string): VetChainSpeciesDefinition | undefined;
 /** The current printed card layout can embed only NCBI Taxonomy IDs of at most five digits. */
 export declare function isVetChainSpeciesCode5Compatible(value: string): boolean;
+/** Normalizes human text consistently before an exact localized alias lookup. */
+export declare function normalizeVetChainSpeciesText(value: string, locale?: string): string;
+/**
+ * Resolves only an exact normalized text configured by the product locale.
+ *
+ * Voice, WhatsApp, portal chat and portal speech must call this same helper.
+ * Unmatched free text belongs at the terminology boundary, not in an LLM-only
+ * inference path.
+ */
+export declare function resolveVetChainSpeciesAlias(input: Readonly<{
+    text: string;
+    locale: string;
+    lexicon: readonly VetChainSpeciesLexiconEntry[];
+}>): Readonly<{
+    ncbiTaxonomyId: NcbiTaxonomyId;
+    matchedText: string;
+}> | undefined;
+/** Validates the closed candidate set before it can be presented or ranked. */
+export declare function validateVetChainSpeciesTerminologyCandidates(values: readonly VetChainSpeciesTerminologyCandidate[]): readonly VetChainSpeciesTerminologyCandidate[];
+/**
+ * Selects only a code in the terminology service's reviewed candidate set.
+ * A Gemma/ranking service may reorder this set but cannot add a code.
+ */
+export declare function selectVetChainSpeciesTerminologyCandidate(candidates: readonly VetChainSpeciesTerminologyCandidate[], selectedCodeValue: string): VetChainSpeciesTerminologyCandidate;

package/dist/species.js

@@ -1,4 +1,5 @@
 // Copyright 2026 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+export const VETCHAIN_NCBI_TAXONOMY_CODE_SYSTEM = "https://www.ncbi.nlm.nih.gov/Taxonomy";
 function species(key, ncbiTaxonomyId, scientificName, group) {
     if (!/^[1-9]\d*$/.test(ncbiTaxonomyId) || ncbiTaxonomyId === "9606") {
         throw new TypeError("A species requires a positive, non-human NCBI Taxonomy identifier.");
@@ -74,3 +75,71 @@ export function findVetChainSpeciesByTaxonomyId(value) {
 export function isVetChainSpeciesCode5Compatible(value) {
     return /^[1-9]\d{0,4}$/.test(value) && value !== "9606";
 }
+/** Normalizes human text consistently before an exact localized alias lookup. */
+export function normalizeVetChainSpeciesText(value, locale = "en") {
+    const normalizedLocale = String(locale || "en").trim() || "en";
+    return String(value || "")
+        .normalize("NFD")
+        .replace(/[\u0300-\u036f]/g, "")
+        .toLocaleLowerCase(normalizedLocale)
+        .replace(/[^\p{L}\p{N}\s]/gu, " ")
+        .replace(/\s+/g, " ")
+        .trim();
+}
+/**
+ * Resolves only an exact normalized text configured by the product locale.
+ *
+ * Voice, WhatsApp, portal chat and portal speech must call this same helper.
+ * Unmatched free text belongs at the terminology boundary, not in an LLM-only
+ * inference path.
+ */
+export function resolveVetChainSpeciesAlias(input) {
+    const normalizedInput = normalizeVetChainSpeciesText(input.text, input.locale);
+    if (!normalizedInput)
+        return undefined;
+    for (const entry of input.lexicon) {
+        assertNonHumanTaxonomyId(entry.ncbiTaxonomyId);
+        if (entry.acceptedTexts.some((text) => normalizeVetChainSpeciesText(text, input.locale) === normalizedInput)) {
+            return Object.freeze({ ncbiTaxonomyId: entry.ncbiTaxonomyId, matchedText: normalizedInput });
+        }
+    }
+    return undefined;
+}
+/** Validates the closed candidate set before it can be presented or ranked. */
+export function validateVetChainSpeciesTerminologyCandidates(values) {
+    if (!Array.isArray(values) || values.length === 0 || values.length > 20) {
+        throw new TypeError("Species terminology must return between one and twenty candidates.");
+    }
+    const seen = new Set();
+    return Object.freeze(values.map((candidate) => {
+        if (candidate.codeSystem !== VETCHAIN_NCBI_TAXONOMY_CODE_SYSTEM) {
+            throw new TypeError("Species terminology candidates must use the canonical NCBI Taxonomy code system.");
+        }
+        assertNonHumanTaxonomyId(candidate.codeValue);
+        if (!candidate.display.trim())
+            throw new TypeError("A species terminology candidate requires a display label.");
+        if (seen.has(candidate.codeValue))
+            throw new TypeError("Species terminology candidates must be unique.");
+        if (candidate.score !== undefined && (!Number.isFinite(candidate.score) || candidate.score < 0 || candidate.score > 1)) {
+            throw new TypeError("A species terminology candidate score must be between zero and one.");
+        }
+        seen.add(candidate.codeValue);
+        return Object.freeze({ ...candidate, display: candidate.display.trim() });
+    }));
+}
+/**
+ * Selects only a code in the terminology service's reviewed candidate set.
+ * A Gemma/ranking service may reorder this set but cannot add a code.
+ */
+export function selectVetChainSpeciesTerminologyCandidate(candidates, selectedCodeValue) {
+    const validated = validateVetChainSpeciesTerminologyCandidates(candidates);
+    const selected = validated.find((candidate) => candidate.codeValue === selectedCodeValue.trim());
+    if (!selected)
+        throw new TypeError("The selected species was not returned by the terminology service.");
+    return selected;
+}
+function assertNonHumanTaxonomyId(value) {
+    if (!/^[1-9]\d*$/.test(value) || value === "9606") {
+        throw new TypeError("A species requires a positive, non-human NCBI Taxonomy identifier.");
+    }
+}

package/docs/101-ANIMAL-INDIVIDUAL-ONBOARDING.md

@@ -21,6 +21,16 @@ const draft = buildVetChainAnimalDraftClaims({
   controllerTelephone: '+12365162385',
 })
 
+// Optional breed text stays separate from the governed NCBI species. The
+// birth date may safely retain reduced year-month precision.
+buildVetChainAnimalDraftClaims({
+  subjectId: crypto.randomUUID(),
+  controllerTelephone: '+12365162385',
+  ncbiTaxonomyId: '9615',
+  breedLabel: 'Beagle',
+  birthDate: '2022-01',
+})
+
 // Step 2. The draft has member=SELF/ONESELF and owner=controller.
 draft['org.schema.Organization.member.role'] // ONESELF
 draft['org.schema.Organization.owner.telephone'] // verified controller
@@ -35,3 +45,10 @@ taxonomy, issues the public Card, and resubmits it under the same private
 `subjectId`. GW VET alone performs the `pending -> active` transition. A draft
 does not need a clinical `Composition`; the active clinical index is a
 separate document lifecycle.
+
+The controller is the author of demographics supplied during this draft. A
+veterinarian later verifies them as attester. That verification locks the
+controller-facing edit path; a correction is a new version authored and
+attested by an authorized veterinarian, never a rewrite of the earlier author.
+Veterinary identity evidence publishes only protected proof and lifecycle
+metadata to the ledger, not raw identity documents or private demographics.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-sdk-core-ts",
-  "version": "0.4.38",
+  "version": "0.4.40",
   "description": "Browser-safe VetChain core contracts and governed animal species identifiers",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",