vet-data-utils-ts 0.4.1 → 0.4.3

package/README.md

@@ -8,6 +8,34 @@ Current surfaces cover the canonical animal-card DID, veterinary summary
 sections, animal-only emergency data, pseudonymous DigitalTwin search input and
 veterinary assistant intents.
 
+## Active sector extension
+
+`vet-data-utils-ts/sectors` extends the frozen CORE catalog without changing
+`gdc-common-utils-ts` or GW CORE. It adds the product-neutral
+`public-safety` value used by explicitly governed portal allowlists. Sector
+selection classifies an organization service; it does not grant membership,
+an occupation, an index role or access to any person or animal.
+
+```ts
+import { ExtendedDataspaceSectors } from 'vet-data-utils-ts/sectors'
+
+// The portal chooses its exact subset. Do not expose the complete catalog as
+// an authorization decision or infer capabilities from this selection.
+const allowedSectors = [
+  ExtendedDataspaceSectors.PublicSafety,
+  ExtendedDataspaceSectors.AnimalCare,
+] as const
+```
+
+`vet-data-utils-ts/organization-application` is the product-neutral application
+value used by UHC UNID, VetChain and SOSChain adapters. The host supplies the
+allowed sector list and translated labels. The value contains one official
+identifier (`TAX`, `EIN` or `BN`), ISO country, optional matching ISO
+subdivision, optional official licence, legal representative, technical
+controller and six independent index participation roles. It rejects a second
+`taxId` and every PIN field: profile protection happens immediately after
+login, before any application screen.
+
 The financial surface defines provider-neutral flat claims for FHIR R5
 `Account`, `Invoice`, `PaymentNotice` and `PaymentReconciliation`. `Account`
 tracks charges and balances; the responsible party is represented through

package/dist/index.d.ts

@@ -4,4 +4,6 @@ export * from './digital-twin.js';
 export * from './emergency.js';
 export * from './financial.js';
 export * from './iso-jurisdictions.js';
+export * from './organization-application.js';
+export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/index.js

@@ -4,4 +4,6 @@ export * from './digital-twin.js';
 export * from './emergency.js';
 export * from './financial.js';
 export * from './iso-jurisdictions.js';
+export * from './organization-application.js';
+export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/organization-application.d.ts

@@ -0,0 +1,44 @@
+export declare const OrganizationOfficialIdTypes: Readonly<{
+    readonly Tax: "TAX";
+    readonly EmployerIdentificationNumber: "EIN";
+    readonly BusinessNumber: "BN";
+}>;
+export declare const OrganizationParticipationRoles: Readonly<{
+    readonly IndividualIndexServiceProvider: "individual-index-service-provider";
+    readonly IndividualIndexDataProvider: "individual-index-data-provider";
+    readonly IndividualIndexDataConsumer: "individual-index-data-consumer";
+    readonly DigitalTwinIndexServiceProvider: "digital-twin-index-service-provider";
+    readonly DigitalTwinDataProvider: "digital-twin-data-provider";
+    readonly DigitalTwinDataConsumer: "digital-twin-data-consumer";
+}>;
+export type OrganizationOfficialIdType = typeof OrganizationOfficialIdTypes[keyof typeof OrganizationOfficialIdTypes];
+export type OrganizationParticipationRole = typeof OrganizationParticipationRoles[keyof typeof OrganizationParticipationRoles];
+export type ReusableOrganizationApplication = Readonly<{
+    sector: string;
+    officialId: Readonly<{
+        type: OrganizationOfficialIdType;
+        value: string;
+    }>;
+    countryCode: string;
+    regionalId: boolean;
+    subdivisionCode?: string;
+    officialLicense?: string;
+    legalRepresentative: Readonly<{
+        name: string;
+        email: string;
+    }>;
+    technicalController: Readonly<{
+        email: string;
+        sameAsLegalRepresentative: boolean;
+    }>;
+    participationRoles: readonly OrganizationParticipationRole[];
+}>;
+/**
+ * Validates only reusable organization-application business data.
+ *
+ * Product adapters supply the sector allowlist and translated labels. Login,
+ * PIN/passkey protection, PDF rendering, delivery, activation-code exchange,
+ * DCR, wallet keys and gateway routing are deliberately outside this value
+ * object and remain inside the BFF/high-level Node runtime.
+ */
+export declare function parseReusableOrganizationApplication(input: unknown): ReusableOrganizationApplication;

package/dist/organization-application.js

@@ -0,0 +1,105 @@
+import { isIso3166CountryCode, isIso3166SubdivisionForCountry } from './iso-jurisdictions.js';
+export const OrganizationOfficialIdTypes = Object.freeze({
+    Tax: 'TAX',
+    EmployerIdentificationNumber: 'EIN',
+    BusinessNumber: 'BN',
+});
+export const OrganizationParticipationRoles = Object.freeze({
+    IndividualIndexServiceProvider: 'individual-index-service-provider',
+    IndividualIndexDataProvider: 'individual-index-data-provider',
+    IndividualIndexDataConsumer: 'individual-index-data-consumer',
+    DigitalTwinIndexServiceProvider: 'digital-twin-index-service-provider',
+    DigitalTwinDataProvider: 'digital-twin-data-provider',
+    DigitalTwinDataConsumer: 'digital-twin-data-consumer',
+});
+const officialIdTypes = new Set(Object.values(OrganizationOfficialIdTypes));
+const participationRoles = new Set(Object.values(OrganizationParticipationRoles));
+/**
+ * Validates only reusable organization-application business data.
+ *
+ * Product adapters supply the sector allowlist and translated labels. Login,
+ * PIN/passkey protection, PDF rendering, delivery, activation-code exchange,
+ * DCR, wallet keys and gateway routing are deliberately outside this value
+ * object and remain inside the BFF/high-level Node runtime.
+ */
+export function parseReusableOrganizationApplication(input) {
+    const value = record(input, 'organization_application_invalid');
+    forbid(value, ['taxId', 'profilePin', 'newProfilePin', 'repeatProfilePin']);
+    const allowedSectors = strings(value.allowedSectors);
+    const sector = required(value.sector, 'organization_sector_required');
+    if (!allowedSectors.includes(sector))
+        throw new TypeError('organization_sector_not_allowed');
+    const officialId = record(value.officialId, 'organization_official_id_required');
+    const officialIdType = required(officialId.type, 'organization_official_id_type_required');
+    if (!officialIdTypes.has(officialIdType))
+        throw new TypeError('organization_official_id_type_invalid');
+    const countryCode = required(value.countryCode, 'organization_country_required').toUpperCase();
+    if (!isIso3166CountryCode(countryCode))
+        throw new TypeError('organization_country_invalid');
+    const regionalId = value.regionalId === true;
+    const subdivisionCode = optional(value.subdivisionCode)?.toUpperCase();
+    if (regionalId && (!subdivisionCode || !isIso3166SubdivisionForCountry(subdivisionCode, countryCode))) {
+        throw new TypeError('organization_subdivision_invalid');
+    }
+    if (!regionalId && subdivisionCode)
+        throw new TypeError('organization_subdivision_without_regional_id');
+    const legalRepresentative = record(value.legalRepresentative, 'organization_legal_representative_required');
+    const legalEmail = email(legalRepresentative.email, 'organization_legal_representative_email_required');
+    const technicalController = record(value.technicalController, 'organization_technical_controller_required');
+    const sameAsLegalRepresentative = technicalController.sameAsLegalRepresentative === true;
+    const technicalEmail = sameAsLegalRepresentative
+        ? legalEmail
+        : email(technicalController.email, 'organization_technical_controller_email_required');
+    const selectedRoles = strings(value.participationRoles);
+    if (selectedRoles.some(role => !participationRoles.has(role))) {
+        throw new TypeError('organization_participation_role_invalid');
+    }
+    return Object.freeze({
+        sector,
+        officialId: Object.freeze({
+            type: officialIdType,
+            value: required(officialId.value, 'organization_official_id_value_required'),
+        }),
+        countryCode,
+        regionalId,
+        ...(subdivisionCode ? { subdivisionCode } : {}),
+        ...(optional(value.officialLicense) ? { officialLicense: optional(value.officialLicense) } : {}),
+        legalRepresentative: Object.freeze({
+            name: required(legalRepresentative.name, 'organization_legal_representative_name_required'),
+            email: legalEmail,
+        }),
+        technicalController: Object.freeze({ email: technicalEmail, sameAsLegalRepresentative }),
+        participationRoles: Object.freeze([...new Set(selectedRoles)]),
+    });
+}
+function record(value, error) {
+    if (!value || typeof value !== 'object' || Array.isArray(value))
+        throw new TypeError(error);
+    return value;
+}
+function strings(value) {
+    return Array.isArray(value) ? value.map(item => String(item).trim()).filter(Boolean) : [];
+}
+function required(value, error) {
+    const normalized = String(value ?? '').trim();
+    if (!normalized)
+        throw new TypeError(error);
+    return normalized;
+}
+function optional(value) {
+    const normalized = String(value ?? '').trim();
+    return normalized || undefined;
+}
+function email(value, error) {
+    const normalized = required(value, error).toLowerCase();
+    if (!/^[^@\s]+@[^@\s]+\.[^@\s]+$/.test(normalized))
+        throw new TypeError(error);
+    return normalized;
+}
+function forbid(value, names) {
+    for (const name of names) {
+        if (Object.prototype.hasOwnProperty.call(value, name)) {
+            throw new TypeError(name === 'taxId' ? 'organization_tax_id_forbidden' : 'organization_profile_pin_forbidden');
+        }
+    }
+}

package/dist/sectors.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Active product extension of the frozen CORE sector vocabulary.
+ *
+ * CORE remains unchanged. Public safety is product-neutral and may be selected
+ * only by a consuming portal that explicitly includes it in its own allowlist;
+ * the value grants no organization role, membership or data capability.
+ */
+export declare const ExtendedDataspaceSectors: Readonly<{
+    readonly PublicSafety: "public-safety";
+    readonly HealthCare: "health-care";
+    readonly HealthResearch: "health-research";
+    readonly HealthTech: "health-tech";
+    readonly HealthInsurance: "health-insurance";
+    readonly AnimalCare: "animal-care";
+    readonly AnimalResearch: "animal-research";
+    readonly AnimalInsurance: "animal-insurance";
+    readonly AnimalTech: "animal-tech";
+    readonly OneHealthResearch: "onehealth-research";
+    readonly OneHealthTech: "onehealth-tech";
+}>;
+export type ExtendedDataspaceSector = typeof ExtendedDataspaceSectors[keyof typeof ExtendedDataspaceSectors];

package/dist/sectors.js

@@ -0,0 +1,12 @@
+import { DataspaceSectors } from 'gdc-common-utils-ts/constants/sectors';
+/**
+ * Active product extension of the frozen CORE sector vocabulary.
+ *
+ * CORE remains unchanged. Public safety is product-neutral and may be selected
+ * only by a consuming portal that explicitly includes it in its own allowlist;
+ * the value grants no organization role, membership or data capability.
+ */
+export const ExtendedDataspaceSectors = Object.freeze({
+    ...DataspaceSectors,
+    PublicSafety: 'public-safety',
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Browser-safe governed VetChain data contracts",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -32,6 +32,14 @@
       "types": "./dist/iso-jurisdictions.d.ts",
       "default": "./dist/iso-jurisdictions.js"
     },
+    "./organization-application": {
+      "types": "./dist/organization-application.d.ts",
+      "default": "./dist/organization-application.js"
+    },
+    "./sectors": {
+      "types": "./dist/sectors.d.ts",
+      "default": "./dist/sectors.js"
+    },
     "./veterinary-sections": {
       "types": "./dist/veterinary-sections.d.ts",
       "default": "./dist/veterinary-sections.js"
@@ -59,6 +67,9 @@
     "@types/node": "^22.0.0",
     "typescript": "^5.5.4"
   },
+  "dependencies": {
+    "gdc-common-utils-ts": "2.5.21"
+  },
   "engines": {
     "node": ">=20"
   }