gdc-sdk-node-ts 2.1.1 → 2.2.2

package/README.md

@@ -7,7 +7,10 @@ execution adapters, or orchestration tests.
 Short rule:
 
 - `101` tests must read like executable tutorials
-- shared fixtures/types belong in `gdc-common-utils-ts`, not as local literals
+- `gdc-common-utils-ts` owns the canonical step-by-step editors/readers,
+  shared fixtures, and reusable payload examples
+- `gdc-sdk-node-ts` starts after that shared authoring step and at
+  `ProfileRuntime -> loadProfile(...) -> workspace/session -> actor facade`
   in node runtime tests
 
 Node runtime package for consuming the shared GDC SDK contracts against real
@@ -69,7 +72,8 @@ If you are integrating this package for the first time, open these in order:
 2. [docs/101-SDK_INTEGRATION.md](./docs/101-SDK_INTEGRATION.md)
    Real backend setup plus the public runtime entrypoints:
    `HostOnboardingSdk`, `OrganizationControllerSdk`,
-   `IndividualControllerSdk`, `ProfessionalSdk`, and route-context usage.
+   `IndividualControllerSdk`, `ProfessionalSdk`, route-context usage, and the
+   canonical `ProfileRuntime -> loadProfile(...) -> workspace/session -> actor facade -> submit/poll` shape.
 3. [tests/101-live-full-cycle-bff-runtime.e2e.test.mjs](./tests/101-live-full-cycle-bff-runtime.e2e.test.mjs)
    Canonical live backend/BFF walkthrough on a fresh local GW lifecycle:
    host/tenant activation, employee provisioning, individual bootstrap,
@@ -194,7 +198,8 @@ Current live `101` flow covered by the test suite:
 2. provision one professional employee through the organization controller
 3. load the individual-controller profile and bootstrap one hosted individual
 4. confirm the returned order and verify the invoice bundle projection
-5. ingest one IPS/clinical `Communication` through the individual controller
+5. ingest one IPS/clinical `Communication` whose attached payload is the
+   canonical document `Bundle` with `Composition` first entry
 6. grant professional consent for one patient-summary section
 7. load the professional profile and request one SMART token
 8. read the allowed IPS bundle as the professional actor
@@ -293,8 +298,9 @@ npm run test:e2e:live-gw
 
 Implementation note:
 
-- the public runtime contract is still `Bundle/_search`
-- `gdc-sdk-node-ts` submits that request as-is
+- the beginner search story stays on FHIR parameters such as
+  `Composition.section`
+- `gdc-sdk-node-ts` submits the search request through the runtime facade
 - GW CORE resolves it internally from indexed subject sections and returns the
   consolidated IPS bundle document
 

package/dist/backend-profile-workspace.d.ts

@@ -0,0 +1,48 @@
+import type { ProfileLoadRequest, SubjectIndexCompositionRequest, SubjectIndexConnectionRequest, TrustedDeviceRegistrationRequest } from 'gdc-sdk-core-ts';
+import type { BackendLoadedActorProfile, BackendProfileRuntimeClient, BackendSubjectIndexCompositionResult, BackendSubjectIndexConnectionResult, BackendTrustedDeviceRegistrationResult } from './backend-profile-runtime.js';
+import { type OrganizationControllerProfileWorkspace, type ProfessionalProfileWorkspace } from './profile-workspace.js';
+import { HostOnboardingSdk } from './orchestration/host-onboarding-sdk.js';
+import { IndividualControllerSdk } from './orchestration/individual-controller-sdk.js';
+import { IndividualMemberSdk } from './orchestration/individual-member-sdk.js';
+import { OrganizationControllerSdk } from './orchestration/organization-controller-sdk.js';
+import { OrganizationEmployeeSdk } from './orchestration/organization-employee-sdk.js';
+import { ProfessionalSdk } from './orchestration/professional-sdk.js';
+/**
+ * Backend loaded-profile workspace that keeps the canonical
+ * `loadProfile -> workspace/session -> actor facade` story explicit.
+ */
+export declare class LoadedProfileWorkspace {
+    private readonly profileRuntime;
+    readonly profile: BackendLoadedActorProfile;
+    constructor(profileRuntime: BackendProfileRuntimeClient, profile: BackendLoadedActorProfile);
+    close(): Promise<void>;
+    registerTrustedDevice(input: TrustedDeviceRegistrationRequest): Promise<BackendTrustedDeviceRegistrationResult>;
+    connectToSubjectIndex(input: SubjectIndexConnectionRequest): Promise<BackendSubjectIndexConnectionResult>;
+    getSubjectIndexComposition(input: SubjectIndexCompositionRequest): Promise<BackendSubjectIndexCompositionResult>;
+    asHostOnboarding(): HostOnboardingSdk;
+    asOrganizationController(): OrganizationControllerSdk;
+    asOrganizationEmployee(): OrganizationEmployeeSdk;
+    asIndividualController(): IndividualControllerSdk;
+    asIndividualMember(): IndividualMemberSdk;
+    asProfessional(): ProfessionalSdk;
+    createOrganizationControllerWorkspace(): OrganizationControllerProfileWorkspace;
+    createProfessionalWorkspace(): ProfessionalProfileWorkspace;
+}
+export declare class ProfileRuntime {
+    private readonly profileRuntime;
+    constructor(profileRuntime: BackendProfileRuntimeClient);
+    loadProfile(input: ProfileLoadRequest): Promise<LoadedProfileWorkspace>;
+}
+export declare function createLoadedProfileWorkspace(profileRuntime: BackendProfileRuntimeClient, profile: BackendLoadedActorProfile): LoadedProfileWorkspace;
+/**
+ * @deprecated Prefer `LoadedProfileWorkspace`.
+ */
+export { LoadedProfileWorkspace as BackendProfileWorkspace };
+/**
+ * @deprecated Prefer `ProfileRuntime`.
+ */
+export { ProfileRuntime as BackendProfileWorkspaceRuntime };
+/**
+ * @deprecated Prefer `createLoadedProfileWorkspace`.
+ */
+export { createLoadedProfileWorkspace as createBackendProfileWorkspace };

package/dist/backend-profile-workspace.js

@@ -0,0 +1,91 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+import { ActorKinds } from 'gdc-common-utils-ts/constants/actor-session';
+import { closeBackendProfile, connectBackendToSubjectIndex, getBackendSubjectIndexComposition, registerBackendTrustedDevice, } from './backend-profile-runtime.js';
+import { createOrganizationControllerProfileWorkspace, createProfessionalProfileWorkspace, } from './profile-workspace.js';
+function requireActorSession(profile, actorKind) {
+    const session = profile.actorSessions.find((candidate) => candidate.actorKind === actorKind);
+    if (!session) {
+        throw new Error(`Loaded backend profile does not expose actor kind '${actorKind}'.`);
+    }
+    return session;
+}
+/**
+ * Backend loaded-profile workspace that keeps the canonical
+ * `loadProfile -> workspace/session -> actor facade` story explicit.
+ */
+export class LoadedProfileWorkspace {
+    constructor(profileRuntime, profile) {
+        this.profileRuntime = profileRuntime;
+        this.profile = profile;
+    }
+    close() {
+        return closeBackendProfile(this.profileRuntime, String(this.profile.descriptor.profileDid || this.profile.descriptor.profileId));
+    }
+    registerTrustedDevice(input) {
+        return registerBackendTrustedDevice(this.profileRuntime, input);
+    }
+    connectToSubjectIndex(input) {
+        return connectBackendToSubjectIndex(this.profileRuntime, input);
+    }
+    getSubjectIndexComposition(input) {
+        return getBackendSubjectIndexComposition(this.profileRuntime, input);
+    }
+    asHostOnboarding() {
+        return requireActorSession(this.profile, ActorKinds.HostOnboarding).asHostOnboarding();
+    }
+    asOrganizationController() {
+        return requireActorSession(this.profile, ActorKinds.OrganizationController).asOrganizationController();
+    }
+    asOrganizationEmployee() {
+        return requireActorSession(this.profile, ActorKinds.OrganizationEmployee).asOrganizationEmployee();
+    }
+    asIndividualController() {
+        return requireActorSession(this.profile, ActorKinds.IndividualController).asIndividualController();
+    }
+    asIndividualMember() {
+        return requireActorSession(this.profile, ActorKinds.IndividualMember).asIndividualMember();
+    }
+    asProfessional() {
+        return requireActorSession(this.profile, ActorKinds.Professional).asProfessional();
+    }
+    createOrganizationControllerWorkspace() {
+        const session = requireActorSession(this.profile, ActorKinds.OrganizationController);
+        return createOrganizationControllerProfileWorkspace({
+            profile: this.profile,
+            session,
+            sdk: this.asOrganizationController(),
+        });
+    }
+    createProfessionalWorkspace() {
+        const session = requireActorSession(this.profile, ActorKinds.Professional);
+        return createProfessionalProfileWorkspace({
+            profile: this.profile,
+            session,
+            sdk: this.asProfessional(),
+        });
+    }
+}
+export class ProfileRuntime {
+    constructor(profileRuntime) {
+        this.profileRuntime = profileRuntime;
+    }
+    async loadProfile(input) {
+        const profile = await this.profileRuntime.loadProfile(input);
+        return new LoadedProfileWorkspace(this.profileRuntime, profile);
+    }
+}
+export function createLoadedProfileWorkspace(profileRuntime, profile) {
+    return new LoadedProfileWorkspace(profileRuntime, profile);
+}
+/**
+ * @deprecated Prefer `LoadedProfileWorkspace`.
+ */
+export { LoadedProfileWorkspace as BackendProfileWorkspace };
+/**
+ * @deprecated Prefer `ProfileRuntime`.
+ */
+export { ProfileRuntime as BackendProfileWorkspaceRuntime };
+/**
+ * @deprecated Prefer `createLoadedProfileWorkspace`.
+ */
+export { createLoadedProfileWorkspace as createBackendProfileWorkspace };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './runtime-contracts.js';
 export * from './identity-bootstrap.js';
 export * from './async-polling.js';
 export * from './backend-profile-runtime.js';
+export * from './backend-profile-workspace.js';
 export * from './individual-controller-backend-runtime.js';
 export * from './organization-controller-backend-runtime.js';
 export * from './professional-backend-runtime.js';

package/dist/index.js

@@ -4,6 +4,7 @@ export * from './runtime-contracts.js';
 export * from './identity-bootstrap.js';
 export * from './async-polling.js';
 export * from './backend-profile-runtime.js';
+export * from './backend-profile-workspace.js';
 export * from './individual-controller-backend-runtime.js';
 export * from './organization-controller-backend-runtime.js';
 export * from './professional-backend-runtime.js';

package/dist/individual-controller-backend-runtime.d.ts

@@ -4,7 +4,7 @@ import type { IndividualOrganizationConfirmOrderInput, RouteContext } from './in
 import type { IndividualOrganizationBootstrapInput, IndividualOrganizationStartResult } from './individual-start.js';
 import type { EnsureFamilyOrganizationRegistrationInput, EnsureFamilyOrganizationRegistrationResult } from './family-organization-registration.js';
 import type { FamilyOrganizationSearchInput } from './family-organization-search.js';
-import type { ClinicalBundleSearchInput } from './resource-operations.js';
+import type { BlockchainArtifactRegistrationInput, ClinicalBundleSearchInput } from './resource-operations.js';
 import { type BackendIndividualControllerProfile, type BackendProfileRuntimeClient } from './backend-profile-runtime.js';
 import type { ProfileLoadRequest } from 'gdc-sdk-core-ts';
 /**
@@ -56,4 +56,9 @@ export declare class IndividualControllerBackendRuntime {
      * individual-controller facade.
      */
     getLatestIps(profile: BackendIndividualControllerProfile, ctx: RouteContext, input: Omit<ClinicalBundleSearchInput, 'includedTypes'>): Promise<SubmitAndPollResult>;
+    /**
+     * Registers one FHIR resource or raw artifact on blockchain before it is
+     * attached to a subject communication.
+     */
+    registerBlockchainArtifactAndUpdateIndex(profile: BackendIndividualControllerProfile, ctx: RouteContext, input: BlockchainArtifactRegistrationInput): Promise<SubmitAndPollResult>;
 }

package/dist/individual-controller-backend-runtime.js

@@ -64,4 +64,11 @@ export class IndividualControllerBackendRuntime {
     getLatestIps(profile, ctx, input) {
         return profile.sdk.getLatestIps(ctx, input);
     }
+    /**
+     * Registers one FHIR resource or raw artifact on blockchain before it is
+     * attached to a subject communication.
+     */
+    registerBlockchainArtifactAndUpdateIndex(profile, ctx, input) {
+        return profile.sdk.registerBlockchainArtifactAndUpdateIndex(ctx, input);
+    }
 }

package/dist/node-runtime-client.d.ts

@@ -1,5 +1,6 @@
 import type { OrganizationDidBindingInput } from 'gdc-sdk-core-ts';
 import type { AppInfo } from 'gdc-sdk-core-ts';
+import type { IndividualOrganizationLifecycleInput } from 'gdc-sdk-core-ts';
 import { type ResolvedAppInfo } from 'gdc-sdk-core-ts';
 import { type HostRouteContext, type HostedTenantLifecycleInput } from './host-onboarding.js';
 import type { NodeLegalOrganizationVerificationTransactionInput, NodeOrganizationDidBindingInput, NodeOrganizationActivationInput } from './orchestration/client-port.js';
@@ -9,7 +10,7 @@ import { type FamilyOrganizationSearchInput } from './family-organization-search
 import { type SmartTokenRequestInput } from './smart-token.js';
 import { type OrganizationLicenseOrderConfirmInput } from './organization-license-order.js';
 import { type IndividualOrganizationBootstrapInput, type IndividualOrganizationStartResult } from './individual-start.js';
-import { type CommunicationIngestionInput, type CommunicationParticipantRuntimeSearchInput, type ClinicalBundleSearchInput, type GrantProfessionalAccessInput, type GrantProfessionalAccessResult, type IndividualMemberLifecycleInput, type IndividualOrganizationLifecycleInput, type LicenseListRuntimeSearchInput, type LicenseOfferRuntimeSearchInput, type LicenseOrderRuntimeSearchInput, type OrganizationEmployeeCreationInput, type OrganizationEmployeeLifecycleInput, type OrganizationEmployeeSearchInput, type RevokeProfessionalAccessInput, type RevokeProfessionalAccessResult, type RelatedPersonUpsertInput } from './resource-operations.js';
+import { type CommunicationIngestionInput, type BlockchainArtifactRegistrationInput, type VitalSignBatchCommunicationFromSearchResponseInput, type CommunicationParticipantRuntimeSearchInput, type ClinicalBundleSearchInput, type GrantProfessionalAccessInput, type GrantProfessionalAccessResult, type IndividualMemberLifecycleInput, type LicenseListRuntimeSearchInput, type LicenseOfferRuntimeSearchInput, type LicenseOrderRuntimeSearchInput, type OrganizationEmployeeCreationInput, type OrganizationEmployeeLifecycleInput, type OrganizationEmployeeSearchInput, type RevokeProfessionalAccessInput, type RevokeProfessionalAccessResult, type RelatedPersonUpsertInput } from './resource-operations.js';
 import type { LegalOrganizationOrderInput } from './host-onboarding.js';
 import type { SmartTokenExchangeResult } from './smart-token.js';
 import type { NodeRuntimeClient, PollOptions, PollResult, SubmitAndPollResult, SubmitPayload, SubmitResponse } from './orchestration/client-port.js';
@@ -70,7 +71,8 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
     private readonly requestTimeoutMs;
     private readonly httpTraceFile?;
     private readonly tokenCache;
-    private warnedDefaultHostNetwork;
+    private readonly paths;
+    private get transportConfig();
     /**
      * @param options.baseUrl Gateway base URL without trailing slash.
      * @param options.interopMode Optional runtime interoperability mode from the SDK config layer (`demo`, `compat`, `strict`).
@@ -339,10 +341,8 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
     searchIndividualLicenseOrders(ctx: RouteContext, input: LicenseOrderRuntimeSearchInput): Promise<SubmitAndPollResult>;
     listIndividualLicenseOrders(ctx: RouteContext, input?: LicenseOrderRuntimeSearchInput): Promise<SubmitAndPollResult>;
     /**
-     * Placeholder for a future GW CORE member/caregiver lifecycle contract.
-     *
-     * Current GW CORE does not yet expose a stable lifecycle route for
-     * `RelatedPerson` / individual-member purge.
+     * Purges one previously disabled `RelatedPerson` membership/contact through
+     * the explicit public purge path.
      */
     purgeIndividualMember(ctx: RouteContext, input: IndividualMemberLifecycleInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
     /**
@@ -376,6 +376,16 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
      * @param input Communication payload plus route/format options.
      */
     ingestCommunicationAndUpdateIndex(ctx: RouteContext, input: CommunicationIngestionInput): Promise<SubmitAndPollResult>;
+    /**
+     * Registers one FHIR resource or raw artifact on blockchain and waits until
+     * GW has indexed the resulting DocumentReference projection.
+     */
+    registerBlockchainArtifactAndUpdateIndex(ctx: RouteContext, input: BlockchainArtifactRegistrationInput): Promise<SubmitAndPollResult>;
+    /**
+     * Builds and submits a Communication carrying the selected vital-sign day
+     * batch artifacts from a paginated search response.
+     */
+    submitVitalSignBatchCommunicationFromSearchResponse(ctx: RouteContext, input: VitalSignBatchCommunicationFromSearchResponseInput): Promise<SubmitAndPollResult>;
     /**
      * Searches communication channel records by subject and participant
      * identifiers through `Communication/_search`.
@@ -424,28 +434,11 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
     private buildHeaders;
     private fetchWithTimeout;
     private parseResponseBody;
-    private requireRouteContext;
-    private routeCtxFromInput;
     /**
      * Reuses the shared bundle business contract while keeping attachment
      * transport fields at the DIDComm/plaintext message layer expected by GW.
      */
     private wrapBundleAsGatewayTransactionMessage;
-    private hostRegistryPath;
-    /**
-     * Resolves the host route segment without allowing tenant-route `sector`
-     * semantics to leak into host onboarding.
-     *
-     * Step by step:
-     * - host routes use `/host/cds-{jurisdiction}/v1/{host-network}`
-     * - tenant routes use `/{tenantId}/cds-{jurisdiction}/v1/{tenant-sector}`
-     * - passing the host segment under `sector` is rejected because that name is
-     *   reserved for tenant business sectors such as `health-care`
-     * - compatibility code may still pass `hostNetworkOrTenantSector`, but the
-     *   value must still be one of the allowed host runtime/network selectors
-     */
-    private requireHostRouteContext;
-    private isSupportedHostNetwork;
     hostRegistryOrganizationTransactionPath(ctx?: HostRouteContext): string;
     hostRegistryOrganizationTransactionPollPath(ctx?: HostRouteContext): string;
     hostRegistryOrganizationIssuePath(ctx?: HostRouteContext): string;
@@ -500,6 +493,8 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
     individualCommunicationPollPath(ctx: RouteContext, format: 'org.hl7.fhir.api' | 'org.hl7.fhir.r4'): string;
     individualCommunicationSearchPath(ctx: RouteContext): string;
     individualCommunicationSearchPollPath(ctx: RouteContext): string;
+    individualDocumentReferenceBatchPath(ctx: RouteContext): string;
+    individualDocumentReferencePollPath(ctx: RouteContext): string;
     individualBundleSearchPath(ctx: RouteContext): string;
     individualBundleSearchPollPath(ctx: RouteContext): string;
     identityTokenExchangePath(ctx: RouteContext): string;
@@ -508,10 +503,6 @@ export declare class HttpRuntimeClient implements NodeRuntimeClient {
     identityDeviceDcrPollPath(ctx: RouteContext): string;
     identityOpenIdSmartTokenPath(ctx: RouteContext): string;
     identityOpenIdSmartTokenPollPath(ctx: RouteContext): string;
-    private appendHttpTrace;
-    private parseTraceBody;
-    private parseTraceRawText;
-    private redactTraceValue;
 }
 /**
  * @deprecated Prefer `HttpRuntimeClient`.