vet-sdk-core-ts 0.4.41 → 0.4.43

package/README.md

@@ -7,15 +7,13 @@ 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.
 
-Usual name, birth date, exact NCBI species and optional breed are animal
-demographics. The usual name may be supplied by the controller or generated as
-a pronounceable species ordinal such as `Dog 1`; it is not identity evidence.
-Breed remains separate descriptive text. Controller-authored
+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 generated/supplied usual name, exact NCBI species or
+Use `buildVetChainAnimalDraftClaims(...)` while the name, exact NCBI species or
 public Card is missing. Only a draft for which
 `readVetChainAnimalOnboardingReadiness(...)` returns `ready: true` may be
 activated and issued a Card. See
@@ -32,8 +30,10 @@ Development and releases follow the mandatory
 Browser-safe VetChain domain contracts. This repository is independent from
 UHC SDK packages and must not import them.
 
-The SDK consumes governed browser-safe values from `vet-data-utils-ts` and
-owns gateway request construction. GW VET remains the policy authority.
+The SDK consumes governed browser-safe values from `vet-data-utils-ts` and the
+product-neutral Task, subject-card index and emergency record contracts from
+`sos-data-utils-ts`. It owns veterinary orchestration and gateway request
+construction. GW VET remains the policy authority.
 
 `vet-sdk-core-ts/health-dcat` provides the neutral manager for tenant-owned
 HealthDCAT metadata. It publishes and searches claims-first resources, asks an

package/dist/animal-identity.js

@@ -1,6 +1,7 @@
 // Copyright 2026 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
 import { sha3_256 } from "@noble/hashes/sha3.js";
 import { bytesToHex, utf8ToBytes } from "@noble/hashes/utils.js";
+import { normalizeSubjectSpeciesId7 } from "sos-data-utils-ts/subject-card-index";
 export const AnimalIdentityEvidenceSystems = Object.freeze({
     UsdaAin: "usda-ain",
     CfiaIso11784: "cfia-iso-11784",
@@ -28,17 +29,11 @@ const DAMM_TABLE = Object.freeze([
  * projection, never an organization fiscal identifier.
  */
 export function buildSpeciesId7(ncbiTaxonomyId) {
-    const source = String(ncbiTaxonomyId || "").trim();
-    if (!/^\d{1,7}$/.test(source)) {
-        throw new TypeError("NCBI Taxonomy identifier must contain at most seven digits.");
-    }
-    const normalized = source.replace(/^0+/, "") || "0";
-    if (normalized === "9606") {
+    const speciesId7 = normalizeSubjectSpeciesId7(ncbiTaxonomyId);
+    if (speciesId7 === "0009606") {
         throw new TypeError("Human NCBI Taxonomy identifier 9606 is not valid for a VetChain animal.");
     }
-    if (normalized === "0")
-        throw new TypeError("NCBI Taxonomy identifier must be positive.");
-    return normalized.padStart(7, "0");
+    return speciesId7;
 }
 /** Country3 plus immutable birth/initial-registration region2. */
 export function normalizeJurisdictionCode5(value) {

package/dist/animal-onboarding.d.ts

@@ -1,50 +1,3 @@
-/**
- * Channel-neutral form contract for animal demographics.
- *
- * Voice, chat and portal navigation may render this schema differently, but
- * they must not redefine required fields or post-activation mutability.
- */
-export declare const VETCHAIN_ANIMAL_DEMOGRAPHICS_SCHEMA: Readonly<{
-    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
-    readonly $id: "https://vetchain.org/schemas/animal-demographics/v1";
-    readonly type: "object";
-    readonly additionalProperties: false;
-    readonly properties: Readonly<{
-        usualName: Readonly<{
-            type: "string";
-            maxLength: 200;
-            'x-vetchain-claim': "org.schema.Organization.alternateName";
-            'x-vetchain-auto-generated': true;
-            'x-vetchain-mutable-until-attested': true;
-        }>;
-        birthDate: Readonly<{
-            type: "string";
-            pattern: "^\\d{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12]\\d|3[01]))?)?$";
-            'x-vetchain-claim': "org.schema.Organization.member.birthDate";
-            'x-vetchain-mutable-until-attested': true;
-        }>;
-        species: Readonly<{
-            type: "string";
-            pattern: "^[1-9]\\d*$";
-            not: Readonly<{
-                const: "9606";
-            }>;
-            'x-vetchain-claim': "org.schema.Organization.member.additionalType";
-            'x-vetchain-immutable-after-activation': true;
-        }>;
-    }>;
-    readonly required: readonly string[];
-}>;
-/**
- * Returns the controller-supplied usual name or a stable, pronounceable
- * English fallback such as `Dog 1`. The ordinal is allocated durably by the
- * owning BFF; this pure helper never counts records or exposes a private UUID.
- */
-export declare function resolveVetChainAnimalUsualName(input: Readonly<{
-    usualName?: string;
-    ncbiTaxonomyId: string;
-    ordinal: number;
-}>): string;
 /** Canonical member relationship for the animal SELF subject. */
 export declare const VetChainAnimalMemberRoles: Readonly<{
     readonly Self: "ONESELF";

package/dist/animal-onboarding.js

@@ -1,55 +1,6 @@
 import { parseVetChainAnimalCardDid } from 'vet-data-utils-ts';
 import { buildAnimalIdentifier16, buildSpeciesId7 } from './animal-identity.js';
 import { normalizeVetChainNcbiTaxonomyId } from './card-issuance.js';
-import { findVetChainSpeciesByTaxonomyId } from './species.js';
-/**
- * Channel-neutral form contract for animal demographics.
- *
- * Voice, chat and portal navigation may render this schema differently, but
- * they must not redefine required fields or post-activation mutability.
- */
-export const VETCHAIN_ANIMAL_DEMOGRAPHICS_SCHEMA = Object.freeze({
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://vetchain.org/schemas/animal-demographics/v1',
-    type: 'object',
-    additionalProperties: false,
-    properties: Object.freeze({
-        usualName: Object.freeze({
-            type: 'string', maxLength: 200,
-            'x-vetchain-claim': 'org.schema.Organization.alternateName',
-            'x-vetchain-auto-generated': true,
-            'x-vetchain-mutable-until-attested': true,
-        }),
-        birthDate: Object.freeze({
-            type: 'string', pattern: '^\\d{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12]\\d|3[01]))?)?$',
-            'x-vetchain-claim': 'org.schema.Organization.member.birthDate',
-            'x-vetchain-mutable-until-attested': true,
-        }),
-        species: Object.freeze({
-            type: 'string', pattern: '^[1-9]\\d*$', not: Object.freeze({ const: '9606' }),
-            'x-vetchain-claim': 'org.schema.Organization.member.additionalType',
-            'x-vetchain-immutable-after-activation': true,
-        }),
-    }),
-    required: Object.freeze(['species']),
-});
-/**
- * Returns the controller-supplied usual name or a stable, pronounceable
- * English fallback such as `Dog 1`. The ordinal is allocated durably by the
- * owning BFF; this pure helper never counts records or exposes a private UUID.
- */
-export function resolveVetChainAnimalUsualName(input) {
-    const supplied = String(input.usualName || '').trim();
-    if (supplied)
-        return supplied;
-    if (!Number.isSafeInteger(input.ordinal) || input.ordinal < 1) {
-        throw new TypeError('vet_animal_usual_name_ordinal_invalid');
-    }
-    const taxonomy = normalizeVetChainNcbiTaxonomyId(input.ncbiTaxonomyId);
-    const species = findVetChainSpeciesByTaxonomyId(taxonomy);
-    const label = species ? humanizeSpeciesKey(species.key) : 'Animal';
-    return `${label} ${input.ordinal}`;
-}
 /** Canonical member relationship for the animal SELF subject. */
 export const VetChainAnimalMemberRoles = Object.freeze({ Self: 'ONESELF' });
 /** Canonical schema.org claim names for the VetChain animal registration. */
@@ -185,6 +136,3 @@ function required(value, error) {
         throw new TypeError(error);
     return normalized;
 }
-function humanizeSpeciesKey(value) {
-    return value.replace(/([a-z0-9])([A-Z])/g, '$1 $2').trim();
-}

package/dist/card-issuance.d.ts

@@ -2,7 +2,8 @@ export type VetChainIssuedAnimalCard = Readonly<{
     providerCode9: string;
     jurisdictionCode5: string;
     ncbiTaxonomyId: string;
-    speciesCode5: string;
+    /** Separate checksum/hash context; never embedded in cardNumber21. */
+    speciesId7: string;
     animalNumericId15: string;
     animalId16: string;
     cardNumber21: string;

package/dist/card-issuance.js

@@ -8,7 +8,7 @@ export function issueVetChainAnimalCard(input) {
     const providerCode9 = digits(input.providerCode9, 9, 'vet_card_provider_code_invalid');
     const jurisdictionCode5 = providerCode9.slice(0, 5);
     const ncbiTaxonomyId = taxonomy(input.ncbiTaxonomyId);
-    const speciesCode5 = ncbiTaxonomyId.padStart(5, '0');
+    const speciesId7 = buildSpeciesId7(ncbiTaxonomyId);
     const subjectUuid = String(input.subjectUuid || '').trim().toLowerCase().replace(/[{}]/g, '');
     if (!/^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.test(subjectUuid)) {
         throw new TypeError('vet_card_subject_uuid_invalid');
@@ -24,7 +24,7 @@ export function issueVetChainAnimalCard(input) {
     ].join(':')));
     const animalNumericId15 = `000${reduceDigestToDecimalDigits(digest, 12)}`;
     const animalId16 = buildAnimalIdentifier16({
-        speciesId7: buildSpeciesId7(ncbiTaxonomyId),
+        speciesId7,
         jurisdictionCode5,
         animalNumericId15,
     });
@@ -34,14 +34,14 @@ export function issueVetChainAnimalCard(input) {
         throw new TypeError('vet_card_host_invalid');
     const cardDidWeb = `did:web:${host.replace(':', '%3A')}:card:vetchain:${jurisdictionCode5}:${animalId16}`;
     parseVetChainAnimalCardDid(cardDidWeb);
-    return Object.freeze({ providerCode9, jurisdictionCode5, ncbiTaxonomyId, speciesCode5, animalNumericId15, animalId16, cardNumber21, cardDidWeb });
+    return Object.freeze({ providerCode9, jurisdictionCode5, ncbiTaxonomyId, speciesId7, animalNumericId15, animalId16, cardNumber21, cardDidWeb });
 }
 export function normalizeVetChainNcbiTaxonomyId(value) {
     return taxonomy(value);
 }
 function taxonomy(value) {
     const normalized = String(value || '').trim();
-    if (!/^[1-9]\d{0,4}$/.test(normalized) || normalized === '9606')
+    if (!/^[1-9]\d{0,6}$/.test(normalized) || normalized === '9606')
         throw new TypeError('vet_card_taxonomy_invalid');
     return normalized;
 }

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

@@ -40,8 +40,7 @@ readVetChainAnimalOnboardingReadiness(draft)
 // { ready: false, missing: ['alternateName', 'species', 'card'] }
 ```
 
-The BFF later rebuilds the same subject draft with its supplied usual name or a
-durably numbered species fallback such as `Dog 1`, plus its exact NCBI
+The BFF later rebuilds the same subject draft with its name and exact NCBI
 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-sdk-core-ts",
-  "version": "0.4.41",
+  "version": "0.4.43",
   "description": "Browser-safe VetChain core contracts and governed animal species identifiers",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -89,6 +89,7 @@
     "@noble/hashes": "^2.2.0",
     "@noble/post-quantum": "0.5.4",
     "gdc-common-utils-ts": "2.9.10",
+    "sos-data-utils-ts": "0.3.0",
     "vet-data-utils-ts": "0.5.28"
   }
 }