vet-sdk-core-ts 0.4.1 → 0.4.2

package/dist/animal-onboarding.d.ts

@@ -0,0 +1,36 @@
+export type VetChainAnimalOnboardingInput = 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;
+}>;
+/** Canonical schema.org claim names for the VetChain animal registration. */
+export declare const VetChainAnimalOnboardingClaimNames: Readonly<{
+    readonly identifierValue: "org.schema.Organization.identifier.value";
+    readonly additionalType: "org.schema.Organization.additionalType";
+    readonly alternateName: "org.schema.Organization.alternateName";
+    readonly legalName: "org.schema.Organization.legalName";
+    readonly sameAs: "org.schema.Organization.sameAs";
+    readonly memberName: "org.schema.Organization.member.name";
+    readonly memberAdditionalType: "org.schema.Organization.member.additionalType";
+    readonly memberBirthDate: "org.schema.Organization.member.birthDate";
+    readonly memberGender: "org.schema.Organization.member.gender";
+    readonly memberRole: "org.schema.Organization.member.role";
+    readonly ownerEmail: "org.schema.Organization.owner.email";
+    readonly ownerTelephone: "org.schema.Organization.owner.telephone";
+    readonly serviceCategory: "org.schema.Service.category";
+}>;
+/**
+ * Projects one controller-authorized animal to the GW Organization envelope.
+ *
+ * Species remains separate governed metadata. It validates the Damm digit with
+ * jurisdiction and animalNumericId15 but is never decoded from cardNumber21.
+ */
+export declare function buildVetChainAnimalOnboardingClaims(input: VetChainAnimalOnboardingInput): Readonly<Record<string, string>>;

package/dist/animal-onboarding.js

@@ -0,0 +1,66 @@
+import { parseVetChainAnimalCardDid } from 'vet-data-utils-ts';
+import { buildAnimalIdentifier16, buildSpeciesId7 } from './animal-identity.js';
+import { normalizeVetChainNcbiTaxonomyId } from './card-issuance.js';
+/** Canonical schema.org claim names for the VetChain animal registration. */
+export const VetChainAnimalOnboardingClaimNames = Object.freeze({
+    identifierValue: 'org.schema.Organization.identifier.value',
+    additionalType: 'org.schema.Organization.additionalType',
+    alternateName: 'org.schema.Organization.alternateName',
+    legalName: 'org.schema.Organization.legalName',
+    sameAs: 'org.schema.Organization.sameAs',
+    memberName: 'org.schema.Organization.member.name',
+    memberAdditionalType: 'org.schema.Organization.member.additionalType',
+    memberBirthDate: 'org.schema.Organization.member.birthDate',
+    memberGender: 'org.schema.Organization.member.gender',
+    memberRole: 'org.schema.Organization.member.role',
+    ownerEmail: 'org.schema.Organization.owner.email',
+    ownerTelephone: 'org.schema.Organization.owner.telephone',
+    serviceCategory: 'org.schema.Service.category',
+});
+/**
+ * Projects one controller-authorized animal to the GW Organization envelope.
+ *
+ * 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 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 birthDate = String(input.birthDate || '').trim()
+        || (Number.isInteger(input.birthYear) ? String(input.birthYear) : '');
+    const legalName = String(input.legalName || '').trim();
+    const gender = input.gender && input.gender !== 'unknown' ? input.gender : '';
+    const claim = VetChainAnimalOnboardingClaimNames;
+    return Object.freeze({
+        '@context': 'org.schema',
+        [claim.identifierValue]: subjectId,
+        [claim.additionalType]: 'animal',
+        [claim.alternateName]: alternateName,
+        ...(legalName ? { [claim.legalName]: legalName } : {}),
+        [claim.sameAs]: card.did,
+        [claim.memberName]: alternateName,
+        [claim.memberAdditionalType]: `http://purl.obolibrary.org/obo/NCBITaxon_${ncbiTaxonomyId}`,
+        [claim.memberRole]: 'RESPRSN',
+        ...(birthDate ? { [claim.memberBirthDate]: birthDate } : {}),
+        ...(gender ? { [claim.memberGender]: gender } : {}),
+        [claim.ownerEmail]: String(input.controllerEmail || '').trim(),
+        [claim.ownerTelephone]: String(input.controllerTelephone || '').trim(),
+        [claim.serviceCategory]: String(input.sector || '').trim() || 'animal-care',
+    });
+}
+function required(value, error) {
+    const normalized = String(value || '').trim();
+    if (!normalized)
+        throw new TypeError(error);
+    return normalized;
+}

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export * from "./species.js";
 export * from "./animal-identity.js";
 export * from "./gateway-contract.js";
 export * from "./card-issuance.js";
+export * from "./animal-onboarding.js";
 export * from "vet-data-utils-ts";

package/dist/index.js

@@ -2,4 +2,5 @@ export * from "./species.js";
 export * from "./animal-identity.js";
 export * from "./gateway-contract.js";
 export * from "./card-issuance.js";
+export * from "./animal-onboarding.js";
 export * from "vet-data-utils-ts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-sdk-core-ts",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Browser-safe VetChain core contracts and governed animal species identifiers",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -27,6 +27,10 @@
     "./card-issuance": {
       "types": "./dist/card-issuance.d.ts",
       "default": "./dist/card-issuance.js"
+    },
+    "./animal-onboarding": {
+      "types": "./dist/animal-onboarding.d.ts",
+      "default": "./dist/animal-onboarding.js"
     }
   },
   "files": [