gdc-sdk-node-ts 0.1.1

package/dist/individual-start.d.ts

@@ -0,0 +1,87 @@
+import type { PollOptions, SubmitAndPollResult } from './orchestration/client-port.js';
+import type { RouteContext } from './individual-onboarding.js';
+export type IndividualOrganizationBootstrapInput = {
+    /**
+     * Preferred route identifier for the selected personal indexing service provider.
+     *
+     * This is not the tax ID of a professional organization. In the individual
+     * indexing journey it should identify the selected service provider that will
+     * host or activate the individual's index.
+     */
+    serviceProviderDid?: string;
+    /**
+     * @deprecated Use `serviceProviderDid`.
+     */
+    tenantId?: string;
+    jurisdiction?: string;
+    sector?: string;
+    /**
+     * Friendly alias/nickname shown in the frontend for the individual profile.
+     *
+     * This is not the technical subject identifier. It is the nearby name the
+     * controller uses to refer to the person in the UI, for example `Charly`.
+     */
+    alternateName: string;
+    /**
+     * CORE-canonical controller contact channel for individual bootstrap.
+     *
+     * In the individual/family bootstrap flow the contact channel is published
+     * as `org.schema.Organization.owner.email`, because the person is acting as
+     * owner/controller of a subject index organization.
+     *
+     * This differs from legal-organization activation, where the human
+     * representative is modeled as a `Person` member/representative of the legal
+     * organization and the VC/policy contract uses `credentialSubject.memberOf`
+     * plus `credentialSubject.hasOccupation`.
+     *
+     * Prefer email in shared examples and docs. It is stable as a general CORE
+     * GW identifier and does not assume a phone-notification extension.
+     */
+    controllerEmail?: string;
+    /**
+     * Compatibility/extension field.
+     *
+     * In the individual/family bootstrap flow this maps to
+     * `org.schema.Organization.owner.telephone`.
+     *
+     * Telephone-driven onboarding is not required by CORE GW. Keep this only for
+     * deployments that add phone-first notification or consent extensions such as
+     * UNID GW.
+     */
+    controllerTelephone?: string;
+    controllerRole?: string;
+    additionalClaims?: Record<string, unknown>;
+    timeoutSeconds?: number;
+    intervalSeconds?: number;
+};
+export type OfferPreview = {
+    offerId?: string;
+    amount?: string;
+    currency?: string;
+    seats?: number | undefined;
+    planName?: string;
+    sku?: string;
+    paymentMethod?: string;
+    checkoutUrl?: string;
+};
+export type IndividualOrganizationStartResult = {
+    registration: SubmitAndPollResult;
+    offerId: string;
+    offerPreview: OfferPreview;
+};
+type StartIndividualOrganizationDeps = {
+    input: IndividualOrganizationBootstrapInput;
+    routeCtx: RouteContext;
+    defaultTimeoutMs?: number;
+    defaultIntervalMs?: number;
+    individualFamilyOrganizationBatchPath: (ctx: RouteContext) => string;
+    individualFamilyOrganizationPollPath: (ctx: RouteContext) => string;
+    submitAndPoll: (submitPath: string, pollPath: string, payload: {
+        thid?: string;
+    } & Record<string, unknown>, options?: PollOptions) => Promise<SubmitAndPollResult>;
+    assertFirstDidcommEntrySuccess?: (result: SubmitAndPollResult, contextLabel: string) => void;
+    getOfferIdFromResponse: (result: SubmitAndPollResult) => string | undefined;
+    getOfferPreviewFromResponse: (result: SubmitAndPollResult) => OfferPreview;
+};
+export declare function startIndividualOrganizationWithDeps(deps: StartIndividualOrganizationDeps): Promise<IndividualOrganizationStartResult>;
+export {};

package/dist/individual-start.js

@@ -0,0 +1,82 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+import { ClaimsOrganizationSchemaorg, ClaimsPersonSchemaorg, ClaimsServiceSchemaorg, } from 'gdc-common-utils-ts/constants';
+import { resolvePollOptionsFromSeconds } from './poll-options.js';
+export async function startIndividualOrganizationWithDeps(deps) {
+    /**
+     * Important semantic split:
+     *
+     * - individual/family bootstrap uses `Organization.owner.*` claims because the
+     *   human controller owns the subject-index organization
+     * - legal organization activation uses `Person.*` plus VC membership/role
+     *   semantics for the legal representative of an existing organization
+     *
+     * The node SDK keeps both `Organization.owner.*` and `Person.*` contact claims
+     * in the payload for compatibility, but the owner claims are the live GW
+     * routing/indexing contract for this flow.
+     */
+    const alternateName = String(deps.input.alternateName || '').trim();
+    if (!alternateName) {
+        throw new Error('bootstrapIndividualOrganization requires alternateName.');
+    }
+    const controllerEmail = String(deps.input.controllerEmail || '').trim();
+    const controllerTelephone = String(deps.input.controllerTelephone || '').trim();
+    if (!controllerEmail && !controllerTelephone) {
+        throw new Error('bootstrapIndividualOrganization requires controllerEmail, or controllerTelephone only for compatibility/extension flows.');
+    }
+    const controllerRole = String(deps.input.controllerRole || 'RESPRSN').trim();
+    const claims = {
+        '@context': 'org.schema',
+        [ClaimsOrganizationSchemaorg.alternateName]: alternateName,
+        [ClaimsServiceSchemaorg.category]: deps.routeCtx.sector,
+        [ClaimsPersonSchemaorg.hasOccupationalRoleValue]: controllerRole,
+        ...(controllerEmail
+            ? {
+                [ClaimsOrganizationSchemaorg.ownerEmail]: controllerEmail,
+                [ClaimsPersonSchemaorg.email]: controllerEmail,
+            }
+            : {}),
+        ...(controllerTelephone
+            ? {
+                [ClaimsOrganizationSchemaorg.ownerTelephone]: controllerTelephone,
+                [ClaimsPersonSchemaorg.telephone]: controllerTelephone,
+            }
+            : {}),
+        ...(deps.input.additionalClaims || {}),
+    };
+    const registrationPayload = {
+        jti: `jti-${createRuntimeUuid()}`,
+        iss: deps.routeCtx.tenantId,
+        aud: deps.routeCtx.tenantId,
+        type: 'application/didcomm-plain+json',
+        thid: `family-org-${createRuntimeUuid()}`,
+        body: {
+            data: [{
+                    type: 'SubjectOrg-registration-form-v1.0',
+                    meta: { claims },
+                    resource: { meta: { claims } },
+                }],
+        },
+    };
+    const pollOptions = resolvePollOptionsFromSeconds(deps.input.timeoutSeconds, deps.input.intervalSeconds, {
+        timeoutMs: deps.defaultTimeoutMs,
+        intervalMs: deps.defaultIntervalMs,
+    });
+    const registration = await deps.submitAndPoll(deps.individualFamilyOrganizationBatchPath(deps.routeCtx), deps.individualFamilyOrganizationPollPath(deps.routeCtx), registrationPayload, pollOptions);
+    deps.assertFirstDidcommEntrySuccess?.(registration, 'startIndividualOrganization.registration');
+    const offerId = deps.getOfferIdFromResponse(registration);
+    if (!offerId) {
+        throw new Error('startIndividualOrganization failed: missing offerId in registration response.');
+    }
+    return {
+        registration,
+        offerId,
+        offerPreview: deps.getOfferPreviewFromResponse(registration),
+    };
+}
+function createRuntimeUuid() {
+    const fromCrypto = globalThis.crypto?.randomUUID?.();
+    if (fromCrypto) {
+        return fromCrypto;
+    }
+    return `fallback-${Date.now()}-${Math.random().toString(16).slice(2)}`;
+}

package/dist/legacy-compat.d.ts

@@ -0,0 +1,22 @@
+export { activateEmployeeDeviceWithActivationRequestWithDeps as activateEmployeeDeviceWithActivationCodeSimpleWithDeps, } from './device-activation.js';
+export { confirmLegalOrganizationOrderWithDeps as confirmLegalOrganizationOrderSimpleWithDeps, } from './host-onboarding.js';
+export { confirmIndividualOrganizationOrderWithDeps as confirmIndividualOrganizationOrderSimpleWithDeps, } from './individual-onboarding.js';
+export { requestSmartTokenWithDeps as requestSmartTokenSimpleWithDeps, } from './smart-token.js';
+export { startIndividualOrganizationWithDeps as startIndividualOrganizationSimpleWithDeps, } from './individual-start.js';
+export { grantProfessionalAccessWithDeps as grantProfessionalAccessSimpleWithDeps } from './resource-operations.js';
+export { resolvePollOptionsFromSeconds as resolveSimplePollOptions } from './poll-options.js';
+export type { EmployeeDeviceActivationRequestInput as EmployeeDeviceActivationSimpleInput, } from './device-activation.js';
+export type { LegalOrganizationOrderInput as LegalOrganizationOrderSimpleInput, } from './host-onboarding.js';
+export type { IndividualOrganizationConfirmOrderInput as IndividualOrganizationConfirmOrderSimpleInput, } from './individual-onboarding.js';
+export type { IndividualOrganizationBootstrapInput as IndividualOrganizationBootstrapSimpleInput, IndividualOrganizationStartResult as IndividualOrganizationStartSimpleResult, } from './individual-start.js';
+export type { SmartTokenRequestInput as SmartTokenRequestSimpleInput, } from './smart-token.js';
+export type { GrantProfessionalAccessInput as GrantProfessionalAccessSimpleInput, GrantProfessionalAccessResult as GrantProfessionalAccessSimpleResult, } from './resource-operations.js';
+export { HostOnboardingSdk as GdcHostOnboardingSdk, } from './orchestration/host-onboarding-sdk.js';
+export { OrganizationControllerSdk as GdcOrganizationControllerSdk, } from './orchestration/organization-controller-sdk.js';
+export { OrganizationEmployeeSdk as GdcOrganizationEmployeeSdk, } from './orchestration/organization-employee-sdk.js';
+export { IndividualControllerSdk as GdcIndividualControllerSdk, } from './orchestration/individual-controller-sdk.js';
+export { IndividualMemberSdk as GdcIndividualMemberSdk, } from './orchestration/individual-member-sdk.js';
+export { PersonalSdk as GdcPersonalSdk, } from './orchestration/personal-sdk.js';
+export { ProfessionalSdk as GdcProfessionalSdk, } from './orchestration/professional-sdk.js';
+export { NodeActorSession as GdcNodeActorSession } from './session.js';
+export { NodeHttpClient as GdcNodeHttpClient } from './node-runtime-client.js';

package/dist/legacy-compat.js

@@ -0,0 +1,18 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+// Temporary compatibility layer for downstream packages not yet migrated.
+export { activateEmployeeDeviceWithActivationRequestWithDeps as activateEmployeeDeviceWithActivationCodeSimpleWithDeps, } from './device-activation.js';
+export { confirmLegalOrganizationOrderWithDeps as confirmLegalOrganizationOrderSimpleWithDeps, } from './host-onboarding.js';
+export { confirmIndividualOrganizationOrderWithDeps as confirmIndividualOrganizationOrderSimpleWithDeps, } from './individual-onboarding.js';
+export { requestSmartTokenWithDeps as requestSmartTokenSimpleWithDeps, } from './smart-token.js';
+export { startIndividualOrganizationWithDeps as startIndividualOrganizationSimpleWithDeps, } from './individual-start.js';
+export { grantProfessionalAccessWithDeps as grantProfessionalAccessSimpleWithDeps } from './resource-operations.js';
+export { resolvePollOptionsFromSeconds as resolveSimplePollOptions } from './poll-options.js';
+export { HostOnboardingSdk as GdcHostOnboardingSdk, } from './orchestration/host-onboarding-sdk.js';
+export { OrganizationControllerSdk as GdcOrganizationControllerSdk, } from './orchestration/organization-controller-sdk.js';
+export { OrganizationEmployeeSdk as GdcOrganizationEmployeeSdk, } from './orchestration/organization-employee-sdk.js';
+export { IndividualControllerSdk as GdcIndividualControllerSdk, } from './orchestration/individual-controller-sdk.js';
+export { IndividualMemberSdk as GdcIndividualMemberSdk, } from './orchestration/individual-member-sdk.js';
+export { PersonalSdk as GdcPersonalSdk, } from './orchestration/personal-sdk.js';
+export { ProfessionalSdk as GdcProfessionalSdk, } from './orchestration/professional-sdk.js';
+export { NodeActorSession as GdcNodeActorSession } from './session.js';
+export { NodeHttpClient as GdcNodeHttpClient } from './node-runtime-client.js';

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

@@ -0,0 +1,195 @@
+import type { ControllerBindingInput } from 'gdc-common-utils-ts/models';
+import { type HostRouteContext } from './host-onboarding.js';
+import { type IndividualOrganizationConfirmOrderInput, type RouteContext } from './individual-onboarding.js';
+import { type SmartTokenRequestInput } from './smart-token.js';
+import { type IndividualOrganizationBootstrapInput, type IndividualOrganizationStartResult } from './individual-start.js';
+import { type CommunicationIngestionInput, type ClinicalBundleSearchInput, type GrantProfessionalAccessInput, type GrantProfessionalAccessResult, type OrganizationEmployeeCreationInput, 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';
+export type HttpRuntimeClientOptions = {
+    baseUrl: string;
+    bearerToken?: string;
+    /**
+     * Optional default tenant route context reused by methods such as
+     * `requestSmartToken(...)` when callers do not want to repeat
+     * tenant/jurisdiction/sector on every call.
+     */
+    ctx?: RouteContext;
+    defaultHeaders?: Record<string, string>;
+    requestTimeoutMs?: number;
+};
+/**
+ * @deprecated Prefer `HttpRuntimeClientOptions`.
+ */
+export type NodeHttpClientOptions = HttpRuntimeClientOptions;
+/**
+ * Runtime-oriented HTTP client for Node backends, BFFs, and workers that need
+ * to submit GDC gateway requests and poll asynchronous responses.
+ *
+ * This class is intentionally transport-focused. It does not try to be the
+ * high-level editor of FHIR documents; that role belongs to the shared helpers
+ * re-exported from `gdc-sdk-core-ts`.
+ */
+export declare class HttpRuntimeClient implements NodeRuntimeClient {
+    private readonly baseUrl;
+    private readonly bearerToken?;
+    private readonly ctx?;
+    private readonly defaultHeaders;
+    private readonly requestTimeoutMs;
+    private readonly httpTraceFile?;
+    private readonly tokenCache;
+    /**
+     * @param options.baseUrl Gateway base URL without trailing slash.
+     * @param options.interopMode Optional runtime interoperability mode from the SDK config layer (`demo`, `compat`, `strict`).
+     * @param options.bearerToken Optional bearer token reused for direct HTTP calls.
+     * @param options.ctx Optional default route context.
+     * @param options.defaultHeaders Optional static headers appended to every request.
+     * @param options.requestTimeoutMs Optional per-request timeout in milliseconds.
+     */
+    constructor(options: HttpRuntimeClientOptions);
+    /**
+     * Builds a canonical GDC v1 resource/action path from a route context.
+     */
+    v1Path(ctx: RouteContext | undefined, section: string, format: string, resourceType: string, action: string): string;
+    /**
+     * Submits a batch payload to a gateway batch endpoint.
+     */
+    submitBatch(path: string, payload: SubmitPayload): Promise<SubmitResponse>;
+    /**
+     * Polls a batch-response endpoint until the GW reports a terminal state.
+     */
+    pollUntilComplete(pollPath: string, request: {
+        thid: string;
+    }, pollOptions?: PollOptions): Promise<PollResult>;
+    /**
+     * Convenience wrapper that performs submit and poll in sequence.
+     */
+    submitAndPoll(submitPath: string, pollPath: string, payload: SubmitPayload, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
+    /**
+     * Activates a legal organization in the gateway host registry using an ICA
+     * proof token already obtained by the caller.
+     */
+    activateOrganizationInGatewayFromIcaProof(hostCtx: HostRouteContext, input: {
+        vpToken: string;
+        controller?: ControllerBindingInput;
+        additionalClaims?: Record<string, unknown>;
+    }, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
+    /**
+     * Confirms a host-side legal organization order after the initial activation.
+     */
+    confirmLegalOrganizationOrder(hostCtx: HostRouteContext, input: LegalOrganizationOrderInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
+    /**
+     * Creates an employee or professional entry under an existing organization tenant.
+     */
+    createOrganizationEmployee(ctx: RouteContext, input: OrganizationEmployeeCreationInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
+    /**
+     * Starts the onboarding flow for an individual-oriented tenant or index.
+     */
+    startIndividualOrganization(input: IndividualOrganizationBootstrapInput): Promise<IndividualOrganizationStartResult>;
+    /**
+     * Confirms the order returned by `startIndividualOrganization(...)`.
+     */
+    confirmIndividualOrganizationOrder(input: IndividualOrganizationConfirmOrderInput): Promise<SubmitAndPollResult>;
+    /**
+     * Creates and submits a consent-oriented access grant for a professional actor.
+     */
+    grantProfessionalAccess(ctx: RouteContext, input: GrantProfessionalAccessInput): Promise<GrantProfessionalAccessResult>;
+    /**
+     * Requests SMART/OpenID token material through the gateway.
+     *
+     * The business inputs are typically the actor DID plus requested scopes.
+     * Route details are resolved either from `input` compatibility fields
+     * (`tenantId` / `jurisdiction` / `sector`) or from
+     * the default client route context configured in the constructor.
+     */
+    requestSmartToken(input: SmartTokenRequestInput): Promise<SmartTokenExchangeResult>;
+    /**
+     * Creates or updates a `RelatedPerson` for non-employee family/caregiver
+     * roles such as a grandfather, guardian, or external caregiver.
+     */
+    upsertRelatedPersonAndPoll(ctx: RouteContext, input: RelatedPersonUpsertInput): Promise<SubmitAndPollResult>;
+    /**
+     * Submits a FHIR `Communication` ingestion request and polls until the
+     * GW has persisted the audit record and related projections.
+     *
+     * @param ctx Route context containing tenant/jurisdiction/sector.
+     * @param input Communication payload plus route/format options.
+     */
+    ingestCommunicationAndUpdateIndex(ctx: RouteContext, input: CommunicationIngestionInput): Promise<SubmitAndPollResult>;
+    /**
+     * Alias for `ingestCommunicationAndUpdateIndex(...)`.
+     *
+     * @param ctx Route context containing tenant/jurisdiction/sector.
+     * @param input Communication payload plus route/format options.
+     */
+    submitCommunicationAndPoll(ctx: RouteContext, input: CommunicationIngestionInput): Promise<SubmitAndPollResult>;
+    /**
+     * Executes a clinical `Bundle/_search` through the converged runtime.
+     *
+     * @param ctx Route context containing tenant/jurisdiction/sector.
+     * @param input Search parameters such as subject, section, date and included resource types.
+     */
+    searchClinicalBundle(ctx: RouteContext, input: ClinicalBundleSearchInput): Promise<SubmitAndPollResult>;
+    /**
+     * Searches the latest IPS-oriented document view for a subject.
+     *
+     * Defaults the section to the IPS patient summary document and includes
+     * `Composition` plus `DocumentReference`.
+     *
+     * @param ctx Route context containing tenant/jurisdiction/sector.
+     * @param input Subject-scoped search parameters.
+     */
+    searchLatestIps(ctx: RouteContext, input: Omit<ClinicalBundleSearchInput, 'includedTypes'>): Promise<SubmitAndPollResult>;
+    /**
+     * Searches a communication/document thread using `thid` and returns the
+     * indexed communication/document projections.
+     */
+    listCommunicationThread(ctx: RouteContext, input: {
+        subject: string;
+        thid: string;
+        pollOptions?: PollOptions;
+    }): Promise<SubmitAndPollResult>;
+    private buildConsentClaimsWithCid;
+    private pollBatchResponse;
+    private postJson;
+    private buildHeaders;
+    private fetchWithTimeout;
+    private parseResponseBody;
+    private requireRouteContext;
+    private routeCtxFromInput;
+    private hostRegistryPath;
+    private requireHostRouteContext;
+    hostRegistryOrganizationActivatePath(ctx?: HostRouteContext): string;
+    hostRegistryOrganizationActivatePollPath(ctx?: HostRouteContext): string;
+    hostRegistryOrderBatchPath(ctx?: HostRouteContext): string;
+    hostRegistryOrderPollPath(ctx?: HostRouteContext): string;
+    employeeBatchPath(ctx?: RouteContext): string;
+    employeePollPath(ctx?: RouteContext): string;
+    individualFamilyOrganizationBatchPath(ctx?: RouteContext): string;
+    individualFamilyOrganizationPollPath(ctx?: RouteContext): string;
+    individualFamilyOrderBatchPath(ctx?: RouteContext): string;
+    individualFamilyOrderPollPath(ctx?: RouteContext): string;
+    individualRelatedPersonBatchPath(ctx?: RouteContext): string;
+    individualRelatedPersonPollPath(ctx?: RouteContext): string;
+    individualConsentR4BatchPath(ctx: RouteContext): string;
+    individualConsentR4PollPath(ctx: RouteContext): string;
+    individualCommunicationBatchPath(ctx: RouteContext, format: 'org.hl7.fhir.api' | 'org.hl7.fhir.r4'): string;
+    individualCommunicationPollPath(ctx: RouteContext, format: 'org.hl7.fhir.api' | 'org.hl7.fhir.r4'): string;
+    individualBundleSearchPath(ctx: RouteContext): string;
+    individualBundleSearchPollPath(ctx: RouteContext): string;
+    identityTokenExchangePath(ctx: RouteContext): string;
+    identityTokenExchangePollPath(ctx: RouteContext): string;
+    identityOpenIdSmartTokenPath(ctx: RouteContext): string;
+    identityOpenIdSmartTokenPollPath(ctx: RouteContext): string;
+    private extractOfferId;
+    private appendHttpTrace;
+    private parseTraceBody;
+    private parseTraceRawText;
+    private redactTraceValue;
+}
+/**
+ * @deprecated Prefer `HttpRuntimeClient`.
+ */
+export declare class NodeHttpClient extends HttpRuntimeClient {
+}