uhc-sdk-front-ts 0.3.0

package/README.md

@@ -0,0 +1,51 @@
+# uhc-sdk-front-ts
+
+Frontend/runtime extension for UHC/UNID applications.
+
+This package extends:
+
+- `uhc-sdk-core-ts`
+- `gdc-sdk-front-ts`
+
+Use it when a frontend, Expo app, or web portal needs:
+
+- the standard GDC frontend SDK
+- UHC extension contracts/examples
+- a stable place for future phone-first and notification-driven UX helpers
+- one package that extends the GDC frontend surface without forcing callers to
+  import `uhc-sdk-core-ts` directly
+
+## Current exports
+
+- everything from `gdc-sdk-front-ts`
+- explicit UHC extension exports bridged from `uhc-sdk-core-ts`
+- `createUhcFrontSdkDescriptor(...)`
+
+The frontend package mirrors the node-side rule: it only bridges additive UHC
+symbols and does not re-export the full `uhc-sdk-core-ts` barrel, because the
+base frontend SDK already re-exports the shared GDC core surface.
+
+## Pending
+
+- controller permission-request UX helpers
+- phone verification UI helpers
+- profile/session helpers for UHC-specific contact routing
+
+## Current UHC bridge exports
+
+- `UhcConsentTargetKinds`
+- `createUhcConsentTargetDescriptor(...)`
+- `createUhcMissingPermissionRequest(...)`
+- `createUhcPhoneVerifyStartInput(...)`
+- `createUhcPhoneVerifyConfirmInput(...)`
+- `createUhcFamilyContactRegistrationInput(...)`
+- `buildUhcPermissionRequestNotificationExample(...)`
+- `buildUhcMissingPermissionRequestExample(...)`
+- `buildUhcPhoneVerifyStartInputExample(...)`
+- `buildUhcPhoneVerifyConfirmInputExample(...)`
+- `buildUhcFamilyMultiEmailRegistrationInputExample(...)`
+- `buildUhcFamilyMultiPhoneRegistrationInputExample(...)`
+
+See also:
+
+- [101-SDK_INTEGRATION.md](101-SDK_INTEGRATION.md)

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * UHC frontend SDK surface.
+ *
+ * This package extends the GDC frontend SDK with UHC-specific contracts and
+ * reusable examples without re-exporting the full UHC core barrel, avoiding the
+ * duplicate runtime-neutral exports already provided by `gdc-sdk-front-ts`.
+ */
+export * from 'gdc-sdk-front-ts';
+export * from './runtime-descriptor.js';
+export * from './uhc-core-extensions.js';
+export * from './uhc-front-clinical-runtime-client.js';

package/dist/index.js

@@ -0,0 +1,12 @@
+// Copyright 2025 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+/**
+ * UHC frontend SDK surface.
+ *
+ * This package extends the GDC frontend SDK with UHC-specific contracts and
+ * reusable examples without re-exporting the full UHC core barrel, avoiding the
+ * duplicate runtime-neutral exports already provided by `gdc-sdk-front-ts`.
+ */
+export * from 'gdc-sdk-front-ts';
+export * from './runtime-descriptor.js';
+export * from './uhc-core-extensions.js';
+export * from './uhc-front-clinical-runtime-client.js';

package/dist/runtime-descriptor.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Lightweight descriptor for UHC frontend runtime consumers.
+ */
+export type UhcFrontSdkDescriptor = Readonly<{
+    runtime: 'front';
+    family: 'uhc';
+    packageName: 'uhc-sdk-front-ts';
+}>;
+/**
+ * Returns the canonical runtime descriptor for UHC frontend apps.
+ */
+export declare function createUhcFrontSdkDescriptor(): UhcFrontSdkDescriptor;

package/dist/runtime-descriptor.js

@@ -0,0 +1,11 @@
+// Copyright 2025 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+/**
+ * Returns the canonical runtime descriptor for UHC frontend apps.
+ */
+export function createUhcFrontSdkDescriptor() {
+    return {
+        runtime: 'front',
+        family: 'uhc',
+        packageName: 'uhc-sdk-front-ts',
+    };
+}

package/dist/uhc-core-extensions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Explicit bridge exports from `uhc-sdk-core-ts` for frontend consumers.
+ *
+ * Frontend packages already receive GDC runtime-neutral exports from
+ * `gdc-sdk-front-ts`. This additive bridge only exposes the UHC-specific layer.
+ */
+export { createUhcClinicalAccessRequest, UhcConsentTargetKinds, createUhcChannelInvitationInput, createUhcChannelInvitationSummary, createUhcChannelOtpStartInput, createUhcChannelOtpConfirmInput, createUhcChannelOtpChallengeSummary, createUhcRelationshipPinPolicy, createUhcRelationshipPinSetInput, createUhcRelationshipPinVerifyInput, createUhcRelationshipLocalKeyEnvelope, UhcReminderActorKinds, UhcReminderChannels, UhcReminderEntityKinds, UhcReminderActions, createUhcConsentTargetDescriptor, createUhcMissingPermissionRequest, createUhcPhoneVerifyStartInput, createUhcPhoneVerifyConfirmInput, createUhcFamilyContactRegistrationInput, createUhcReminderPermissionBundle, encodeUhcReminderPermissionBundle, decodeUhcReminderPermissionBundle, evaluateUhcReminderRuntimeAccess, evaluateUhcReminderAccess, buildUhcReminderPermissionRequestCommunication, renderUhcCommMsgExtendedFhirR5Body, transformUhcCommunicationClaimsToResourceFhirR5, UhcCommunicationClinicalFormatRenderers, EXAMPLE_UHC_PERMISSION_REQUEST_NOTIFICATION, EXAMPLE_UHC_MISSING_PERMISSION_REQUEST, EXAMPLE_UHC_PHONE_VERIFY_START_INPUT, EXAMPLE_UHC_PHONE_VERIFY_CONFIRM_INPUT, EXAMPLE_UHC_PHONE_CHANNEL_INVITATION_INPUT, EXAMPLE_UHC_VETERINARY_PHONE_CHANNEL_INVITATION_INPUT, EXAMPLE_UHC_CHANNEL_INVITATION_SUMMARY, EXAMPLE_UHC_CHANNEL_OTP_START_INPUT, EXAMPLE_UHC_CHANNEL_OTP_CONFIRM_INPUT, EXAMPLE_UHC_CHANNEL_OTP_CHALLENGE_SUMMARY, EXAMPLE_UHC_RELATIONSHIP_PIN_POLICY, EXAMPLE_UHC_RELATIONSHIP_PIN_SET_INPUT, EXAMPLE_UHC_RELATIONSHIP_PIN_VERIFY_INPUT, EXAMPLE_UHC_RELATIONSHIP_LOCAL_KEY_ENVELOPE, EXAMPLE_UHC_FAMILY_MULTI_EMAIL_REGISTRATION_INPUT, EXAMPLE_UHC_FAMILY_MULTI_PHONE_REGISTRATION_INPUT, EXAMPLE_UHC_REMINDER_PERMISSION_BUNDLE, buildUhcPermissionRequestNotificationExample, buildUhcMissingPermissionRequestExample, buildUhcPhoneVerifyStartInputExample, buildUhcPhoneVerifyConfirmInputExample, buildUhcPhoneChannelInvitationInputExample, buildUhcVeterinaryPhoneChannelInvitationInputExample, buildUhcChannelInvitationSummaryExample, buildUhcChannelOtpStartInputExample, buildUhcChannelOtpConfirmInputExample, buildUhcChannelOtpChallengeSummaryExample, buildUhcRelationshipPinPolicyExample, buildUhcRelationshipPinSetInputExample, buildUhcRelationshipPinVerifyInputExample, buildUhcRelationshipLocalKeyEnvelopeExample, buildUhcFamilyMultiEmailRegistrationInputExample, buildUhcFamilyMultiPhoneRegistrationInputExample, buildUhcReminderPermissionBundleExample, type UhcConsentTargetDescriptor, type UhcClinicalAccessPort, type UhcClinicalResource, type UhcSmartAccessRequest, type UhcChannelEnrollmentChannel, type UhcSubjectKind, type UhcAccessActorKind, type UhcInvitationStatus, type UhcOtpDeliveryChannel, type UhcRelationshipPinKdf, type UhcMissingPermissionRequest, type UhcPhoneVerifyStartInput, type UhcPhoneVerifyConfirmInput, type UhcChannelInvitationInput, type UhcChannelInvitationSummary, type UhcChannelOtpStartInput, type UhcChannelOtpConfirmInput, type UhcChannelOtpChallengeSummary, type UhcRelationshipPinPolicy, type UhcRelationshipPinSetInput, type UhcRelationshipPinVerifyInput, type UhcRelationshipLocalKeyEnvelope, type UhcFamilyContactRegistrationInput, type UhcReminderActorKind, type UhcReminderChannel, type UhcReminderEntityKind, type UhcReminderAction, type UhcReminderPermissionBundle, type UhcReminderPermissionRule, type UhcReminderRuntimeAccessRequest, type UhcReminderRuntimeAccessEvaluation, type UhcReminderAccessRequest, type UhcReminderAccessEvaluation, } from 'uhc-sdk-core-ts';

package/dist/uhc-core-extensions.js

@@ -0,0 +1,8 @@
+// Copyright 2025 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+/**
+ * Explicit bridge exports from `uhc-sdk-core-ts` for frontend consumers.
+ *
+ * Frontend packages already receive GDC runtime-neutral exports from
+ * `gdc-sdk-front-ts`. This additive bridge only exposes the UHC-specific layer.
+ */
+export { createUhcClinicalAccessRequest, UhcConsentTargetKinds, createUhcChannelInvitationInput, createUhcChannelInvitationSummary, createUhcChannelOtpStartInput, createUhcChannelOtpConfirmInput, createUhcChannelOtpChallengeSummary, createUhcRelationshipPinPolicy, createUhcRelationshipPinSetInput, createUhcRelationshipPinVerifyInput, createUhcRelationshipLocalKeyEnvelope, UhcReminderActorKinds, UhcReminderChannels, UhcReminderEntityKinds, UhcReminderActions, createUhcConsentTargetDescriptor, createUhcMissingPermissionRequest, createUhcPhoneVerifyStartInput, createUhcPhoneVerifyConfirmInput, createUhcFamilyContactRegistrationInput, createUhcReminderPermissionBundle, encodeUhcReminderPermissionBundle, decodeUhcReminderPermissionBundle, evaluateUhcReminderRuntimeAccess, evaluateUhcReminderAccess, buildUhcReminderPermissionRequestCommunication, renderUhcCommMsgExtendedFhirR5Body, transformUhcCommunicationClaimsToResourceFhirR5, UhcCommunicationClinicalFormatRenderers, EXAMPLE_UHC_PERMISSION_REQUEST_NOTIFICATION, EXAMPLE_UHC_MISSING_PERMISSION_REQUEST, EXAMPLE_UHC_PHONE_VERIFY_START_INPUT, EXAMPLE_UHC_PHONE_VERIFY_CONFIRM_INPUT, EXAMPLE_UHC_PHONE_CHANNEL_INVITATION_INPUT, EXAMPLE_UHC_VETERINARY_PHONE_CHANNEL_INVITATION_INPUT, EXAMPLE_UHC_CHANNEL_INVITATION_SUMMARY, EXAMPLE_UHC_CHANNEL_OTP_START_INPUT, EXAMPLE_UHC_CHANNEL_OTP_CONFIRM_INPUT, EXAMPLE_UHC_CHANNEL_OTP_CHALLENGE_SUMMARY, EXAMPLE_UHC_RELATIONSHIP_PIN_POLICY, EXAMPLE_UHC_RELATIONSHIP_PIN_SET_INPUT, EXAMPLE_UHC_RELATIONSHIP_PIN_VERIFY_INPUT, EXAMPLE_UHC_RELATIONSHIP_LOCAL_KEY_ENVELOPE, EXAMPLE_UHC_FAMILY_MULTI_EMAIL_REGISTRATION_INPUT, EXAMPLE_UHC_FAMILY_MULTI_PHONE_REGISTRATION_INPUT, EXAMPLE_UHC_REMINDER_PERMISSION_BUNDLE, buildUhcPermissionRequestNotificationExample, buildUhcMissingPermissionRequestExample, buildUhcPhoneVerifyStartInputExample, buildUhcPhoneVerifyConfirmInputExample, buildUhcPhoneChannelInvitationInputExample, buildUhcVeterinaryPhoneChannelInvitationInputExample, buildUhcChannelInvitationSummaryExample, buildUhcChannelOtpStartInputExample, buildUhcChannelOtpConfirmInputExample, buildUhcChannelOtpChallengeSummaryExample, buildUhcRelationshipPinPolicyExample, buildUhcRelationshipPinSetInputExample, buildUhcRelationshipPinVerifyInputExample, buildUhcRelationshipLocalKeyEnvelopeExample, buildUhcFamilyMultiEmailRegistrationInputExample, buildUhcFamilyMultiPhoneRegistrationInputExample, buildUhcReminderPermissionBundleExample, } from 'uhc-sdk-core-ts';

package/dist/uhc-front-clinical-runtime-client.d.ts

@@ -0,0 +1,7 @@
+import { FrontClinicalRuntimeClient } from 'gdc-sdk-front-ts';
+import type { FrontClinicalRuntimeClientOptions, FrontCommunicationIngestionInput, FrontRouteContext, SubmitAndPollResult } from 'gdc-sdk-front-ts';
+/** Browser/mobile clinical runtime with UHC-owned formats such as FHIR R5. */
+export declare class UhcFrontClinicalRuntimeClient extends FrontClinicalRuntimeClient {
+    constructor(options: FrontClinicalRuntimeClientOptions);
+    ingestCommunicationAndUpdateIndex(ctx: FrontRouteContext, input: FrontCommunicationIngestionInput): Promise<SubmitAndPollResult>;
+}

package/dist/uhc-front-clinical-runtime-client.js

@@ -0,0 +1,24 @@
+// Copyright 2026 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+import { FrontClinicalRuntimeClient } from 'gdc-sdk-front-ts';
+import { UhcCommunicationClinicalFormatRenderers } from 'uhc-sdk-core-ts';
+/** Browser/mobile clinical runtime with UHC-owned formats such as FHIR R5. */
+export class UhcFrontClinicalRuntimeClient extends FrontClinicalRuntimeClient {
+    constructor(options) {
+        super({
+            ...options,
+            communicationFormatRenderers: {
+                ...UhcCommunicationClinicalFormatRenderers,
+                ...(options.communicationFormatRenderers || {}),
+            },
+        });
+    }
+    ingestCommunicationAndUpdateIndex(ctx, input) {
+        return super.ingestCommunicationAndUpdateIndex(ctx, {
+            ...input,
+            clinicalFormat: normalizeUhcClinicalFormat(input.clinicalFormat),
+        });
+    }
+}
+function normalizeUhcClinicalFormat(format) {
+    return format === 'r5' || format === 'fhir.r5' ? 'org.hl7.fhir.r5' : format;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "uhc-sdk-front-ts",
+  "version": "0.3.0",
+  "description": "UHC/UNID frontend SDK extension built on top of gdc-sdk-front-ts and uhc-sdk-core-ts",
+  "license": "Apache-2.0",
+  "author": "Connecting Solution & Applications Ltd",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "type-check": "tsc -p tsconfig.json --noEmit",
+    "test": "npm run build && node --test tests/*.test.mjs"
+  },
+  "dependencies": {
+    "gdc-sdk-front-ts": "^2.3.0",
+    "uhc-sdk-core-ts": "^0.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.10",
+    "typescript": "^5.5.4"
+  }
+}