vet-sdk-core-ts 0.4.37 → 0.4.38

package/README.md

@@ -1,5 +1,18 @@
 # VetChain Core SDK
 
+## Animal Individual Organization identity
+
+An animal is the first member of its own Individual Organization, so
+`Organization.member.role` is always the HL7 code `ONESELF`. The authenticated
+human that creates it is `Organization.owner`, the controller by default;
+`RESPRSN` must never be copied into the animal member.
+
+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
+[`docs/101-ANIMAL-INDIVIDUAL-ONBOARDING.md`](docs/101-ANIMAL-INDIVIDUAL-ONBOARDING.md).
+
 `vet-sdk-core-ts/place-service-directory` is the VetChain-only bundle boundary
 for claims-first Schema.org `Place` and `Service` resources. It builds GW VET
 batch/search envelopes and joins authorized directory search responses for the

package/dist/animal-onboarding.d.ts

@@ -1,3 +1,7 @@
+/** Canonical member relationship for the animal SELF subject. */
+export declare const VetChainAnimalMemberRoles: Readonly<{
+    readonly Self: "ONESELF";
+}>;
 export type VetChainAnimalOnboardingInput = Readonly<{
     subjectId: string;
     cardDidWeb: string;
@@ -11,6 +15,23 @@ export type VetChainAnimalOnboardingInput = Readonly<{
     controllerTelephone?: string;
     sector?: string;
 }>;
+export type VetChainAnimalDraftInput = Readonly<{
+    subjectId: string;
+    cardDidWeb?: string;
+    alternateName?: string;
+    legalName?: string;
+    birthDate?: string;
+    birthYear?: number;
+    gender?: 'female' | 'male' | 'other' | 'unknown';
+    ncbiTaxonomyId?: string;
+    controllerEmail?: string;
+    controllerTelephone?: string;
+    sector?: string;
+}>;
+export type VetChainAnimalOnboardingReadiness = Readonly<{
+    ready: boolean;
+    missing: ReadonlyArray<'alternateName' | 'species' | 'card'>;
+}>;
 /** Canonical schema.org claim names for the VetChain animal registration. */
 export declare const VetChainAnimalOnboardingClaimNames: Readonly<{
     readonly identifierValue: "org.schema.Organization.identifier.value";
@@ -27,9 +48,24 @@ export declare const VetChainAnimalOnboardingClaimNames: Readonly<{
     readonly ownerTelephone: "org.schema.Organization.owner.telephone";
     readonly serviceCategory: "org.schema.Service.category";
 }>;
+/**
+ * Creates the claims-first administrative draft for one animal.
+ *
+ * A draft always identifies its private subject and the creating controller,
+ * but name, NCBI species and public Card DID may remain absent. The animal is
+ * still its own `ONESELF` member; `Organization.owner` is the controller.
+ */
+export declare function buildVetChainAnimalDraftClaims(input: VetChainAnimalDraftInput): Readonly<Record<string, string>>;
+/** Reports whether an animal draft can be activated and issued a public Card. */
+export declare function readVetChainAnimalOnboardingReadiness(claims: Readonly<Record<string, unknown>>): VetChainAnimalOnboardingReadiness;
 /**
  * Projects one controller-authorized animal to the GW Organization envelope.
  *
+ * The animal is the envelope's first member and therefore has the HL7
+ * `ONESELF` relationship. The authenticated human that creates it is kept in
+ * `Organization.owner`; controller authority such as `RESPRSN` is never
+ * copied into `Organization.member.role`.
+ *
  * Species remains separate governed metadata. It validates the Damm digit with
  * jurisdiction and animalNumericId15 but is never decoded from cardNumber21.
  */

package/dist/animal-onboarding.js

@@ -1,6 +1,8 @@
 import { parseVetChainAnimalCardDid } from 'vet-data-utils-ts';
 import { buildAnimalIdentifier16, buildSpeciesId7 } from './animal-identity.js';
 import { normalizeVetChainNcbiTaxonomyId } from './card-issuance.js';
+/** 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. */
 export const VetChainAnimalOnboardingClaimNames = Object.freeze({
     identifierValue: 'org.schema.Organization.identifier.value',
@@ -18,24 +20,23 @@ export const VetChainAnimalOnboardingClaimNames = Object.freeze({
     serviceCategory: 'org.schema.Service.category',
 });
 /**
- * Projects one controller-authorized animal to the GW Organization envelope.
+ * Creates the claims-first administrative draft for one animal.
  *
- * Species remains separate governed metadata. It validates the Damm digit with
- * jurisdiction and animalNumericId15 but is never decoded from cardNumber21.
+ * A draft always identifies its private subject and the creating controller,
+ * but name, NCBI species and public Card DID may remain absent. The animal is
+ * still its own `ONESELF` member; `Organization.owner` is the controller.
  */
-export function buildVetChainAnimalOnboardingClaims(input) {
+export function buildVetChainAnimalDraftClaims(input) {
     const subjectId = required(input.subjectId, 'vet_animal_subject_id_invalid');
-    const alternateName = required(input.alternateName, 'vet_animal_name_invalid');
-    const card = parseVetChainAnimalCardDid(input.cardDidWeb);
-    const ncbiTaxonomyId = normalizeVetChainNcbiTaxonomyId(input.ncbiTaxonomyId);
-    const expectedAnimalId16 = buildAnimalIdentifier16({
-        speciesId7: buildSpeciesId7(ncbiTaxonomyId),
-        jurisdictionCode5: card.jurisdictionCode5,
-        animalNumericId15: card.animalNumericId15,
-    });
-    if (expectedAnimalId16 !== card.animalId16) {
-        throw new TypeError('vet_animal_card_species_checksum_invalid');
-    }
+    const alternateName = String(input.alternateName || '').trim();
+    const ncbiTaxonomyId = String(input.ncbiTaxonomyId || '').trim()
+        ? normalizeVetChainNcbiTaxonomyId(String(input.ncbiTaxonomyId))
+        : '';
+    const cardDidWeb = String(input.cardDidWeb || '').trim();
+    if (cardDidWeb && !ncbiTaxonomyId)
+        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 legalName = String(input.legalName || '').trim();
@@ -45,12 +46,16 @@ export function buildVetChainAnimalOnboardingClaims(input) {
         '@context': 'org.schema',
         [claim.identifierValue]: subjectId,
         [claim.additionalType]: 'animal',
-        [claim.alternateName]: alternateName,
+        ...(alternateName ? {
+            [claim.alternateName]: alternateName,
+            [claim.memberName]: alternateName,
+        } : {}),
         ...(legalName ? { [claim.legalName]: legalName } : {}),
-        [claim.sameAs]: card.did,
-        [claim.memberName]: alternateName,
-        [claim.memberAdditionalType]: `http://purl.obolibrary.org/obo/NCBITaxon_${ncbiTaxonomyId}`,
-        [claim.memberRole]: 'RESPRSN',
+        ...(cardDidWeb ? { [claim.sameAs]: cardDidWeb } : {}),
+        ...(ncbiTaxonomyId ? {
+            [claim.memberAdditionalType]: `http://purl.obolibrary.org/obo/NCBITaxon_${ncbiTaxonomyId}`,
+        } : {}),
+        [claim.memberRole]: VetChainAnimalMemberRoles.Self,
         ...(birthDate ? { [claim.memberBirthDate]: birthDate } : {}),
         ...(gender ? { [claim.memberGender]: gender } : {}),
         [claim.ownerEmail]: String(input.controllerEmail || '').trim(),
@@ -58,6 +63,50 @@ export function buildVetChainAnimalOnboardingClaims(input) {
         [claim.serviceCategory]: String(input.sector || '').trim() || 'animal-care',
     });
 }
+/** Reports whether an animal draft can be activated and issued a public Card. */
+export function readVetChainAnimalOnboardingReadiness(claims) {
+    const claim = VetChainAnimalOnboardingClaimNames;
+    const missing = [];
+    if (!String(claims[claim.alternateName] || '').trim())
+        missing.push('alternateName');
+    if (!/^http:\/\/purl\.obolibrary\.org\/obo\/NCBITaxon_[1-9]\d*$/.test(String(claims[claim.memberAdditionalType] || '').trim())) {
+        missing.push('species');
+    }
+    if (!String(claims[claim.sameAs] || '').trim())
+        missing.push('card');
+    return Object.freeze({ ready: missing.length === 0, missing: Object.freeze(missing) });
+}
+/**
+ * Projects one controller-authorized animal to the GW Organization envelope.
+ *
+ * The animal is the envelope's first member and therefore has the HL7
+ * `ONESELF` relationship. The authenticated human that creates it is kept in
+ * `Organization.owner`; controller authority such as `RESPRSN` is never
+ * copied into `Organization.member.role`.
+ *
+ * Species remains separate governed metadata. It validates the Damm digit with
+ * jurisdiction and animalNumericId15 but is never decoded from cardNumber21.
+ */
+export function buildVetChainAnimalOnboardingClaims(input) {
+    const alternateName = required(input.alternateName, 'vet_animal_name_invalid');
+    const ncbiTaxonomyId = normalizeVetChainNcbiTaxonomyId(input.ncbiTaxonomyId);
+    const claims = buildVetChainAnimalDraftClaims({ ...input, alternateName, ncbiTaxonomyId });
+    const readiness = readVetChainAnimalOnboardingReadiness(claims);
+    if (!readiness.ready)
+        throw new TypeError(`vet_animal_onboarding_incomplete:${readiness.missing.join(',')}`);
+    return claims;
+}
+function assertCardSpecies(cardDidWeb, ncbiTaxonomyId) {
+    const card = parseVetChainAnimalCardDid(cardDidWeb);
+    const expectedAnimalId16 = buildAnimalIdentifier16({
+        speciesId7: buildSpeciesId7(ncbiTaxonomyId),
+        jurisdictionCode5: card.jurisdictionCode5,
+        animalNumericId15: card.animalNumericId15,
+    });
+    if (expectedAnimalId16 !== card.animalId16) {
+        throw new TypeError('vet_animal_card_species_checksum_invalid');
+    }
+}
 function required(value, error) {
     const normalized = String(value || '').trim();
     if (!normalized)

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

@@ -0,0 +1,37 @@
+# Animal Individual Organization onboarding 101
+
+The animal and the human controller are two different identities:
+
+- `Organization.member` is the indexed animal itself. Its relationship is
+  `ONESELF`.
+- `Organization.owner` is the authenticated human that creates and controls
+  the Individual Organization by default. Controller authority may be
+  represented as `RESPRSN`, but that value never becomes the animal's member
+  role.
+
+```ts
+import {
+  buildVetChainAnimalDraftClaims,
+  readVetChainAnimalOnboardingReadiness,
+} from 'vet-sdk-core-ts/animal-onboarding'
+
+// Step 1. The controller starts a private draft using a verified contact.
+const draft = buildVetChainAnimalDraftClaims({
+  subjectId: crypto.randomUUID(),
+  controllerTelephone: '+12365162385',
+})
+
+// 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
+
+// Step 3. Do not issue or display a Card while required data is missing.
+readVetChainAnimalOnboardingReadiness(draft)
+// { ready: false, missing: ['alternateName', 'species', 'card'] }
+```
+
+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
+separate document lifecycle.

package/package.json

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