sos-sdk-core-ts 0.1.5 → 0.2.0

package/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
-## Unreleased
-
-- Pin the first registry release to `uhc-sdk-core-ts@0.6.0` so SOSChain
-  consumers can remove the historical vendored package from staging builds.
+## 0.2.0
+
+- Redefine `sos-sdk-core-ts` as the runtime-neutral orchestration layer consumed
+  by SOSChain, Vet and UHC, above `sos-data-utils-ts` and below product SDKs.
+- Remove the accidental dependency on and root reexport of `uhc-sdk-core-ts`.
+- Add neutral `authorizeEmergencyAction` and `EmergencyDeliveryTarget` APIs;
+  retain the older `Soschain*` names as deprecated compatibility aliases.
+- Consume emergency evidence, Group/ServiceRequest and card-target contracts
+  from `sos-data-utils-ts@0.3.0` instead of maintaining SDK-local copies.
+- Preserve the existing SDK root and subpath exports as compatibility aliases.
 
 ## 0.1.5
 

package/README.md

@@ -1,10 +1,30 @@
-# SOSChain SDK Core
+# Shared SOS SDK Core
 
-Runtime-neutral SOSChain extension of `uhc-sdk-core-ts`.
+Runtime-neutral shared SDK for SOSChain, VetChain and UHC. Deterministic
+cross-product record types and builders come from `sos-data-utils-ts`; this SDK
+owns reusable authorization and orchestration without Node, browser, gateway or
+product-specific behavior.
 
-It consumes the exact published `uhc-sdk-core-ts` contract. Git, workspace,
-vendored and `file:` dependencies are forbidden in committed or deployed
-dependency state.
+The canonical architecture keeps both shared layers visible:
+
+```text
+gdc-* frozen
+    ↓
+sos-data-utils-ts
+    ↓
+sos-sdk-core-ts
+    ├──→ vet-sdk-core-ts
+    ├──→ uhc-sdk-core-ts
+    └──→ sos-sdk-node-ts
+```
+
+Vet and UHC may also depend directly on `sos-data-utils-ts` when they import or
+expose its types. `sos-sdk-core-ts` never depends on or reexports either product
+SDK. `sos-sdk-node-ts` owns SOSChain-specific Node transport, persistence and
+jobs; those adapters do not belong here.
+
+Git, workspace, vendored and `file:` dependencies are forbidden in committed
+or deployed dependency state.
 
 The emergency-group contract treats `emergencyGroupId`, `subjectId` and
 `callerId` as opaque business identifiers. A group assistance request is one
@@ -14,14 +34,17 @@ other resource is projected only at an integration boundary.
 Groups are named collections. A scanned card is attached to one selected group
 before that group's identifiers are projected into a single service request.
 
-`authorizeSoschainEmergencyAction` separately checks trusted evidence for every
+`authorizeEmergencyAction` separately checks trusted evidence for every
 member and for `sos:call` or `sos:request`. Identity verification alone never
 grants an emergency capability. Regional/local delivery is represented by
-`SoschainEmergencyDeliveryTarget`; transport and tenant routing stay outside FHIR.
+`EmergencyDeliveryTarget`; transport and tenant routing stay outside FHIR.
 The `incident-reporter` relationship represents a short-lived grant issued by
 a trusted scan resolver to an already verified person at the scene; it does
 not imply guardianship, control or professional status.
 
+The older `SoschainEmergency*` names remain deprecated compatibility aliases
+to the same types and implementation; they are not a second contract.
+
 `buildSoschainPlaceCardAssociationClaims` records a UHC/VetChain card link to
 a canonical SOSChain Place or vehicle without merging either identity.
 

package/dist/emergency-authorization.d.ts

@@ -1,18 +1,7 @@
-export type SoschainEmergencyCapability = 'sos:call' | 'sos:request';
-export type SoschainEvidenceDomain = 'SOS' | 'Health' | 'TrainingAndEducation';
-/** A verified evidence reference; the source VC/PDF stays outside call and audit logs. */
-export type SoschainEmergencyAuthorizationEvidence = Readonly<{
-    evidenceId: string;
-    issuerId: string;
-    holderId: string;
-    subjectIds: readonly string[];
-    capabilities: readonly SoschainEmergencyCapability[];
-    domains: readonly SoschainEvidenceDomain[];
-    relationship: 'self' | 'guardian' | 'professional' | 'institution' | 'incident-reporter';
-    verifiedAt: string;
-    validUntil?: string;
-}>;
-export type SoschainEmergencyDeliveryTarget = Readonly<{
+import type { EmergencyAuthorizationEvidence, EmergencyCapability, EvidenceDomain } from 'sos-data-utils-ts/emergency-evidence';
+export type { EmergencyAuthorizationEvidence, EmergencyCapability, EvidenceDomain, } from 'sos-data-utils-ts/emergency-evidence';
+/** Runtime-neutral endpoint selected after authorization succeeds. */
+export type EmergencyDeliveryTarget = Readonly<{
     tenantId: string;
     jurisdiction: string;
     locality?: string;
@@ -22,10 +11,20 @@ export type SoschainEmergencyDeliveryTarget = Readonly<{
  * Requires current trusted evidence for every affected subject and capability.
  * Identifier syntax and the legal meaning of each issuer remain policy concerns.
  */
-export declare function authorizeSoschainEmergencyAction(input: Readonly<{
+export declare function authorizeEmergencyAction(input: Readonly<{
     callerId: string;
     memberSubjectIds: readonly string[];
-    capability: SoschainEmergencyCapability;
-    evidence: readonly SoschainEmergencyAuthorizationEvidence[];
+    capability: EmergencyCapability;
+    evidence: readonly EmergencyAuthorizationEvidence[];
     now?: string;
 }>): readonly string[];
+/** @deprecated Use `EmergencyDeliveryTarget`. */
+export type SoschainEmergencyDeliveryTarget = EmergencyDeliveryTarget;
+/** @deprecated Import `EmergencyAuthorizationEvidence` from this module. */
+export type SoschainEmergencyAuthorizationEvidence = EmergencyAuthorizationEvidence;
+/** @deprecated Import `EmergencyCapability` from this module. */
+export type SoschainEmergencyCapability = EmergencyCapability;
+/** @deprecated Import `EvidenceDomain` from this module. */
+export type SoschainEvidenceDomain = EvidenceDomain;
+/** @deprecated Use `authorizeEmergencyAction`. */
+export declare const authorizeSoschainEmergencyAction: typeof authorizeEmergencyAction;

package/dist/emergency-authorization.js

@@ -2,7 +2,7 @@
  * Requires current trusted evidence for every affected subject and capability.
  * Identifier syntax and the legal meaning of each issuer remain policy concerns.
  */
-export function authorizeSoschainEmergencyAction(input) {
+export function authorizeEmergencyAction(input) {
     const at = Date.parse(input.now ?? new Date().toISOString());
     const evidenceIds = new Set();
     for (const subjectId of input.memberSubjectIds) {
@@ -17,3 +17,5 @@ export function authorizeSoschainEmergencyAction(input) {
     }
     return [...evidenceIds];
 }
+/** @deprecated Use `authorizeEmergencyAction`. */
+export const authorizeSoschainEmergencyAction = authorizeEmergencyAction;

package/dist/emergency-group.d.ts

@@ -1,46 +1,2 @@
-export declare const SOSCHAIN_FHIR_CLAIMS_CONTEXT: "org.hl7.fhir.api";
-export declare const SOSCHAIN_EMERGENCY_ASSISTANCE_CODE_SYSTEM = "https://soschain.org/fhir/CodeSystem/emergency-assistance";
-/** Canonical claims-first group record stored under resource.meta.claims. */
-export type SoschainEmergencyGroupClaims = Readonly<{
-    '@context': typeof SOSCHAIN_FHIR_CLAIMS_CONTEXT;
-    'Group.identifier': string;
-    'Group.name': string;
-    'Group.member-subject': readonly string[];
-    'Group.soschain-caller': string;
-    'Group.period-start': string;
-}>;
-/** Canonical claims-first request; FHIR version projection happens later. */
-export type SoschainEmergencyServiceRequestClaims = Readonly<{
-    '@context': typeof SOSCHAIN_FHIR_CLAIMS_CONTEXT;
-    'ServiceRequest.identifier': string;
-    'ServiceRequest.status': 'active';
-    'ServiceRequest.intent': 'order';
-    'ServiceRequest.code': string;
-    'ServiceRequest.code-system': typeof SOSCHAIN_EMERGENCY_ASSISTANCE_CODE_SYSTEM;
-    'ServiceRequest.code-display'?: string;
-    'ServiceRequest.subject': string;
-    'ServiceRequest.subject-type': 'Group';
-    'ServiceRequest.requester': string;
-    'ServiceRequest.authored-on': string;
-    'ServiceRequest.soschain-member-subject': readonly string[];
-}>;
-/** Builds flat, version-neutral FHIR claims without interpreting identifier syntax. */
-export declare function buildSoschainEmergencyGroupClaims(input: Readonly<{
-    emergencyGroupId: string;
-    displayName: string;
-    memberSubjectIds: readonly string[];
-    callerId: string;
-    createdAt?: string;
-}>): SoschainEmergencyGroupClaims;
-/**
- * Builds one flat ServiceRequest claim set for all members of one emergency
- * group. It deliberately does not construct a FHIR R5/R6 resource.
- */
-export declare function buildSoschainEmergencyServiceRequestClaims(input: Readonly<{
-    requestId: string;
-    groupClaims: SoschainEmergencyGroupClaims;
-    assistanceCode?: string;
-    assistanceDisplay?: string;
-    authoredOn?: string;
-}>): SoschainEmergencyServiceRequestClaims;
-export declare function readSoschainEmergencySubjectIds(claims: SoschainEmergencyServiceRequestClaims): readonly string[];
+/** Compatibility subpath for the canonical shared emergency record contracts. */
+export * from 'sos-data-utils-ts/emergency-group';

package/dist/emergency-group.js

@@ -1,48 +1,2 @@
-export const SOSCHAIN_FHIR_CLAIMS_CONTEXT = 'org.hl7.fhir.api';
-export const SOSCHAIN_EMERGENCY_ASSISTANCE_CODE_SYSTEM = 'https://soschain.org/fhir/CodeSystem/emergency-assistance';
-function requiredIdentifier(value, name) {
-    const normalized = String(value).trim();
-    if (!normalized)
-        throw new TypeError(`${name} is required.`);
-    return normalized;
-}
-function uniqueIdentifiers(values) {
-    const identifiers = [...new Set(values.map((value) => requiredIdentifier(value, 'memberSubjectId')))];
-    if (identifiers.length === 0)
-        throw new TypeError('At least one memberSubjectId is required.');
-    return identifiers;
-}
-/** Builds flat, version-neutral FHIR claims without interpreting identifier syntax. */
-export function buildSoschainEmergencyGroupClaims(input) {
-    return {
-        '@context': SOSCHAIN_FHIR_CLAIMS_CONTEXT,
-        'Group.identifier': requiredIdentifier(input.emergencyGroupId, 'emergencyGroupId'),
-        'Group.name': requiredIdentifier(input.displayName, 'displayName'),
-        'Group.member-subject': uniqueIdentifiers(input.memberSubjectIds),
-        'Group.soschain-caller': requiredIdentifier(input.callerId, 'callerId'),
-        'Group.period-start': input.createdAt ?? new Date().toISOString(),
-    };
-}
-/**
- * Builds one flat ServiceRequest claim set for all members of one emergency
- * group. It deliberately does not construct a FHIR R5/R6 resource.
- */
-export function buildSoschainEmergencyServiceRequestClaims(input) {
-    return {
-        '@context': SOSCHAIN_FHIR_CLAIMS_CONTEXT,
-        'ServiceRequest.identifier': requiredIdentifier(input.requestId, 'requestId'),
-        'ServiceRequest.status': 'active',
-        'ServiceRequest.intent': 'order',
-        'ServiceRequest.code': input.assistanceCode?.trim() || 'emergency-assistance',
-        'ServiceRequest.code-system': SOSCHAIN_EMERGENCY_ASSISTANCE_CODE_SYSTEM,
-        ...(input.assistanceDisplay ? { 'ServiceRequest.code-display': input.assistanceDisplay } : {}),
-        'ServiceRequest.subject': input.groupClaims['Group.identifier'],
-        'ServiceRequest.subject-type': 'Group',
-        'ServiceRequest.requester': input.groupClaims['Group.soschain-caller'],
-        'ServiceRequest.authored-on': input.authoredOn ?? new Date().toISOString(),
-        'ServiceRequest.soschain-member-subject': uniqueIdentifiers(input.groupClaims['Group.member-subject']),
-    };
-}
-export function readSoschainEmergencySubjectIds(claims) {
-    return claims['ServiceRequest.soschain-member-subject'];
-}
+/** Compatibility subpath for the canonical shared emergency record contracts. */
+export * from 'sos-data-utils-ts/emergency-group';

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-/** SOSChain extends UHC without moving product-specific contracts into UHC. */
-export * from 'uhc-sdk-core-ts';
+/** Shared runtime-neutral orchestration remains independent from product SDKs. */
+export { EmergencyCapabilities, EvidenceDomains, EvidenceRelationships, SoschainEmergencyCapabilities, SoschainEvidenceDomains, SoschainEvidenceRelationships, } from 'sos-data-utils-ts/emergency-evidence';
+export type { EvidenceRelationship, SoschainEvidenceRelationship, } from 'sos-data-utils-ts/emergency-evidence';
 export * from './emergency-group.js';
 export * from './emergency-authorization.js';
 export * from './place-card-association.js';

package/dist/index.js

@@ -1,5 +1,5 @@
-/** SOSChain extends UHC without moving product-specific contracts into UHC. */
-export * from 'uhc-sdk-core-ts';
+/** Shared runtime-neutral orchestration remains independent from product SDKs. */
+export { EmergencyCapabilities, EvidenceDomains, EvidenceRelationships, SoschainEmergencyCapabilities, SoschainEvidenceDomains, SoschainEvidenceRelationships, } from 'sos-data-utils-ts/emergency-evidence';
 export * from './emergency-group.js';
 export * from './emergency-authorization.js';
 export * from './place-card-association.js';

package/dist/place-card-association.d.ts

@@ -1,35 +1,2 @@
-import { SOSCHAIN_FHIR_CLAIMS_CONTEXT } from './emergency-group.js';
-export type SoschainAssociationTargetType = 'Place' | 'Vehicle';
-export type SoschainAssociationRole = 'controller' | 'occupant' | 'employee' | 'guardian';
-/** Flat association record stored under resource.meta.claims. */
-export type SoschainPlaceCardAssociationClaims = Readonly<{
-    '@context': typeof SOSCHAIN_FHIR_CLAIMS_CONTEXT;
-    'Basic.identifier': string;
-    'Basic.code': 'soschain-card-target-association';
-    'Basic.subject': string;
-    'Basic.soschain-target': string;
-    'Basic.soschain-target-hash': string;
-    'Basic.soschain-target-type': SoschainAssociationTargetType;
-    'Basic.soschain-role': SoschainAssociationRole;
-    'Basic.period-start': string;
-}>;
-export type SoschainCanonicalTargetMatch = Readonly<{
-    status: 'created' | 'existing';
-    canonicalTargetId: string;
-    targetType: SoschainAssociationTargetType;
-}>;
-export declare function buildSoschainPlaceCardAssociationClaims(input: Readonly<{
-    associationId: string;
-    cardId: string;
-    canonicalTargetId: string;
-    canonicalTargetHash: string;
-    targetType: SoschainAssociationTargetType;
-    role: SoschainAssociationRole;
-    createdAt?: string;
-}>): SoschainPlaceCardAssociationClaims;
-/** Public deterministic SHA3-384/CID lookup key for smart-contract deduplication. */
-export declare function buildSoschainCanonicalTargetHash(input: Readonly<{
-    targetType: SoschainAssociationTargetType;
-    countryCode: string;
-    canonicalValue: string;
-}>): string;
+/** Compatibility subpath for the canonical shared card-target contracts. */
+export * from 'sos-data-utils-ts/place-card-association';

package/dist/place-card-association.js

@@ -1,30 +1,2 @@
-import { SOSCHAIN_FHIR_CLAIMS_CONTEXT } from './emergency-group.js';
-import { buildRawCidV1FromUtf8String } from 'gdc-common-utils-ts/utils/multiformat-profile';
-function required(value, name) {
-    const normalized = String(value).trim();
-    if (!normalized)
-        throw new TypeError(`${name} is required.`);
-    return normalized;
-}
-export function buildSoschainPlaceCardAssociationClaims(input) {
-    return {
-        '@context': SOSCHAIN_FHIR_CLAIMS_CONTEXT,
-        'Basic.identifier': required(input.associationId, 'associationId'),
-        'Basic.code': 'soschain-card-target-association',
-        'Basic.subject': required(input.cardId, 'cardId'),
-        'Basic.soschain-target': required(input.canonicalTargetId, 'canonicalTargetId'),
-        'Basic.soschain-target-hash': required(input.canonicalTargetHash, 'canonicalTargetHash'),
-        'Basic.soschain-target-type': input.targetType,
-        'Basic.soschain-role': input.role,
-        'Basic.period-start': input.createdAt ?? new Date().toISOString(),
-    };
-}
-/** Public deterministic SHA3-384/CID lookup key for smart-contract deduplication. */
-export function buildSoschainCanonicalTargetHash(input) {
-    const canonical = [
-        input.targetType,
-        required(input.countryCode, 'countryCode').toUpperCase(),
-        required(input.canonicalValue, 'canonicalValue').normalize('NFC').trim().replace(/\s+/g, ' ').toLowerCase(),
-    ].join('|');
-    return buildRawCidV1FromUtf8String(canonical);
-}
+/** Compatibility subpath for the canonical shared card-target contracts. */
+export * from 'sos-data-utils-ts/place-card-association';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sos-sdk-core-ts",
-  "version": "0.1.5",
-  "description": "Runtime-neutral SOSChain contracts extending uhc-sdk-core-ts",
+  "version": "0.2.0",
+  "description": "Runtime-neutral shared orchestration for SOS, Vet and UHC products",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
   "repository": {
@@ -39,8 +39,7 @@
     "prepack": "npm run check"
   },
   "dependencies": {
-    "gdc-common-utils-ts": "^2.3.28",
-    "uhc-sdk-core-ts": "0.6.0"
+    "sos-data-utils-ts": "0.3.2"
   },
   "devDependencies": {
     "@types/node": "^22.5.0",