vet-sdk-core-ts 0.4.40 → 0.4.41

package/README.md

@@ -7,13 +7,15 @@ 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
+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
 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
+Use `buildVetChainAnimalDraftClaims(...)` while the generated/supplied usual 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

package/dist/animal-onboarding.d.ts

@@ -1,3 +1,50 @@
+/**
+ * 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,6 +1,55 @@
 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. */
@@ -136,3 +185,6 @@ 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/docs/101-ANIMAL-INDIVIDUAL-ONBOARDING.md

@@ -40,7 +40,8 @@ readVetChainAnimalOnboardingReadiness(draft)
 // { ready: false, missing: ['alternateName', 'species', 'card'] }
 ```
 
-The BFF later rebuilds the same subject draft with its name and exact NCBI
+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
 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.40",
+  "version": "0.4.41",
   "description": "Browser-safe VetChain core contracts and governed animal species identifiers",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",