gdc-common-utils-ts 2.3.18 → 2.3.20

package/dist/constants/schemaorg.d.ts

@@ -38,6 +38,8 @@ export declare enum ClaimsSoftwareApplicationSchemaorg {
  * based on Schema.org vocabulary.
  */
 export declare enum ClaimsOrganizationSchemaorg {
+    /** Schema.org type discriminator for the indexed organization/member profile. */
+    additionalType = "org.schema.Organization.additionalType",
     /** Public aliases used for exact organization or individual resolution. */
     sameAs = "org.schema.Organization.sameAs",
     /** ISO 3166-1 alpha-2 (two-letter country code). The jurisdiction could be the country or the region (county, province or state) */
@@ -88,6 +90,16 @@ export declare enum ClaimsOrganizationSchemaorg {
     ownerIdentifierValue = "org.schema.Organization.owner.identifier.value",
     /** Individual/family indexed member friendly name used by onboarding draft helpers. */
     memberAlternateName = "org.schema.Organization.member.alternateName",
+    /** Public display name of the indexed member. */
+    memberName = "org.schema.Organization.member.name",
+    /**
+     * Semantic type of the indexed member.
+     *
+     * Animal onboarding uses the canonical NCBI Taxonomy OBO URI here. This
+     * distinguishes an animal without inferring species from a FHIR resource
+     * name or from an application-local flag.
+     */
+    memberAdditionalType = "org.schema.Organization.member.additionalType",
     memberGivenName = "org.schema.Organization.member.givenName",
     memberFamilyName = "org.schema.Organization.member.familyName",
     memberBirthDate = "org.schema.Organization.member.birthDate",

package/dist/constants/schemaorg.js

@@ -42,6 +42,8 @@ export var ClaimsSoftwareApplicationSchemaorg;
  */
 export var ClaimsOrganizationSchemaorg;
 (function (ClaimsOrganizationSchemaorg) {
+    /** Schema.org type discriminator for the indexed organization/member profile. */
+    ClaimsOrganizationSchemaorg["additionalType"] = "org.schema.Organization.additionalType";
     /** Public aliases used for exact organization or individual resolution. */
     ClaimsOrganizationSchemaorg["sameAs"] = "org.schema.Organization.sameAs";
     /** ISO 3166-1 alpha-2 (two-letter country code). The jurisdiction could be the country or the region (county, province or state) */
@@ -92,6 +94,16 @@ export var ClaimsOrganizationSchemaorg;
     ClaimsOrganizationSchemaorg["ownerIdentifierValue"] = "org.schema.Organization.owner.identifier.value";
     /** Individual/family indexed member friendly name used by onboarding draft helpers. */
     ClaimsOrganizationSchemaorg["memberAlternateName"] = "org.schema.Organization.member.alternateName";
+    /** Public display name of the indexed member. */
+    ClaimsOrganizationSchemaorg["memberName"] = "org.schema.Organization.member.name";
+    /**
+     * Semantic type of the indexed member.
+     *
+     * Animal onboarding uses the canonical NCBI Taxonomy OBO URI here. This
+     * distinguishes an animal without inferring species from a FHIR resource
+     * name or from an application-local flag.
+     */
+    ClaimsOrganizationSchemaorg["memberAdditionalType"] = "org.schema.Organization.member.additionalType";
     ClaimsOrganizationSchemaorg["memberGivenName"] = "org.schema.Organization.member.givenName";
     ClaimsOrganizationSchemaorg["memberFamilyName"] = "org.schema.Organization.member.familyName";
     ClaimsOrganizationSchemaorg["memberBirthDate"] = "org.schema.Organization.member.birthDate";

package/dist/models/animal-onboarding.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @deprecated Animal-card vocabulary is owned by the consuming product SDK.
+ * Retained only so consumers of 2.3.x can migrate without a breaking removal.
+ */
+export declare const AnimalSubjectKinds: Readonly<{
+    readonly Animal: "animal";
+}>;
+/**
+ * @deprecated Use the species registry from the consuming product SDK.
+ * NCBI Taxonomy identifiers are external identifiers and are not a GDC model.
+ */
+export declare const NcbiTaxonomy: Readonly<{
+    readonly Dog: "9615";
+    readonly Cat: "9685";
+    readonly Horse: "9796";
+}>;
+/** @deprecated Import the taxonomy identifier type from the product SDK. */
+export type NcbiTaxonomyId = string;
+/** @deprecated Import the animal onboarding input from the product SDK. */
+export type AnimalOnboardingInput = Readonly<{
+    subjectId: string;
+    cardDidWeb: string;
+    alternateName: string;
+    legalName?: string;
+    birthDate?: string;
+    birthYear?: number;
+    gender?: 'female' | 'male' | 'other' | 'unknown';
+    ncbiTaxonomyId: NcbiTaxonomyId;
+    controllerEmail?: string;
+    controllerTelephone?: string;
+    sector?: string;
+}>;
+/** @deprecated Import the animal onboarding claims type from the product SDK. */
+export type AnimalOnboardingClaims = Readonly<Record<string, string>>;
+/**
+ * @deprecated Use the taxonomy URI builder from the product SDK.
+ *
+ * Builds the canonical OBO URI for one NCBI Taxonomy numeric identifier.
+ *
+ * The URI is public taxonomy metadata, not an animal identifier. Callers must
+ * keep microchip, registry and controller identifiers in their separately
+ * typed confidential/index contracts.
+ */
+export declare function buildNcbiTaxonomyUri(id: NcbiTaxonomyId): string;
+/**
+ * @deprecated Use the animal onboarding builder from the product SDK. This
+ * compatibility implementation will be removed in the next major release.
+ *
+ * Projects one controller-authorized animal card request to the existing
+ * schema.org individual-organization claim envelope.
+ *
+ * The indexed subject is always an animal and its human actor is always a
+ * responsible controller. Login identity proves only the application session;
+ * GW must still verify the enrollment grant before accepting the request. A
+ * card must not be shown as active until the authoritative GW transaction
+ * returns success.
+ */
+export declare function buildAnimalOnboardingClaims(input: AnimalOnboardingInput): AnimalOnboardingClaims;

package/dist/models/animal-onboarding.js

@@ -0,0 +1,78 @@
+import { ClaimsOrganizationSchemaorg, ClaimsServiceSchemaorg } from '../constants/schemaorg.js';
+import { DataspaceSectors } from '../constants/sectors.js';
+/**
+ * @deprecated Animal-card vocabulary is owned by the consuming product SDK.
+ * Retained only so consumers of 2.3.x can migrate without a breaking removal.
+ */
+export const AnimalSubjectKinds = Object.freeze({
+    Animal: 'animal',
+});
+/**
+ * @deprecated Use the species registry from the consuming product SDK.
+ * NCBI Taxonomy identifiers are external identifiers and are not a GDC model.
+ */
+export const NcbiTaxonomy = Object.freeze({
+    Dog: '9615',
+    Cat: '9685',
+    Horse: '9796',
+});
+/**
+ * @deprecated Use the taxonomy URI builder from the product SDK.
+ *
+ * Builds the canonical OBO URI for one NCBI Taxonomy numeric identifier.
+ *
+ * The URI is public taxonomy metadata, not an animal identifier. Callers must
+ * keep microchip, registry and controller identifiers in their separately
+ * typed confidential/index contracts.
+ */
+export function buildNcbiTaxonomyUri(id) {
+    const normalized = id.trim();
+    if (!/^[1-9]\d*$/.test(normalized)) {
+        throw new TypeError('ncbiTaxonomyId must be a positive numeric NCBI Taxonomy identifier.');
+    }
+    if (normalized === '9606') {
+        throw new TypeError('Human NCBI Taxonomy 9606 is not valid for animal onboarding.');
+    }
+    return `http://purl.obolibrary.org/obo/NCBITaxon_${normalized}`;
+}
+/**
+ * @deprecated Use the animal onboarding builder from the product SDK. This
+ * compatibility implementation will be removed in the next major release.
+ *
+ * Projects one controller-authorized animal card request to the existing
+ * schema.org individual-organization claim envelope.
+ *
+ * The indexed subject is always an animal and its human actor is always a
+ * responsible controller. Login identity proves only the application session;
+ * GW must still verify the enrollment grant before accepting the request. A
+ * card must not be shown as active until the authoritative GW transaction
+ * returns success.
+ */
+export function buildAnimalOnboardingClaims(input) {
+    const subjectId = input.subjectId.trim();
+    const cardDidWeb = input.cardDidWeb.trim();
+    const alternateName = input.alternateName.trim();
+    if (!subjectId || !cardDidWeb || !alternateName) {
+        throw new TypeError('subjectId, cardDidWeb and alternateName are required.');
+    }
+    const birthDate = input.birthDate?.trim()
+        || (Number.isInteger(input.birthYear) ? String(input.birthYear) : '');
+    const legalName = input.legalName?.trim();
+    const gender = input.gender && input.gender !== 'unknown' ? input.gender : '';
+    return Object.freeze({
+        '@context': 'org.schema',
+        [ClaimsOrganizationSchemaorg.identifierValue]: subjectId,
+        [ClaimsOrganizationSchemaorg.additionalType]: AnimalSubjectKinds.Animal,
+        [ClaimsOrganizationSchemaorg.alternateName]: alternateName,
+        ...(legalName ? { [ClaimsOrganizationSchemaorg.legalName]: legalName } : {}),
+        [ClaimsOrganizationSchemaorg.sameAs]: cardDidWeb,
+        [ClaimsOrganizationSchemaorg.memberName]: alternateName,
+        [ClaimsOrganizationSchemaorg.memberAdditionalType]: buildNcbiTaxonomyUri(input.ncbiTaxonomyId),
+        [ClaimsOrganizationSchemaorg.memberRole]: 'RESPRSN',
+        ...(birthDate ? { [ClaimsOrganizationSchemaorg.memberBirthDate]: birthDate } : {}),
+        ...(gender ? { [ClaimsOrganizationSchemaorg.memberGender]: gender } : {}),
+        [ClaimsOrganizationSchemaorg.ownerEmail]: input.controllerEmail?.trim() || '',
+        [ClaimsOrganizationSchemaorg.ownerTelephone]: input.controllerTelephone?.trim() || '',
+        [ClaimsServiceSchemaorg.category]: input.sector?.trim() || DataspaceSectors.AnimalCare,
+    });
+}

package/dist/models/index.d.ts

@@ -26,6 +26,7 @@ export * from './interoperable-claims';
 export * from './indexing';
 export * from './identity-bootstrap';
 export * from './individual-onboarding';
+export * from './animal-onboarding';
 export * from './inter-tenant-access-contract';
 export * from './issue';
 export * from './jsonapi';

package/dist/models/index.js

@@ -26,6 +26,7 @@ export * from './interoperable-claims.js';
 export * from './indexing.js';
 export * from './identity-bootstrap.js';
 export * from './individual-onboarding.js';
+export * from './animal-onboarding.js';
 export * from './inter-tenant-access-contract.js';
 export * from './issue.js';
 export * from './jsonapi.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdc-common-utils-ts",
-  "version": "2.3.18",
+  "version": "2.3.20",
   "publishConfig": {
     "access": "public"
   },