gdc-sdk-front-ts 0.10.1 → 2.0.3

package/README.md

@@ -1,5 +1,15 @@
 # gdc-sdk-front-ts
 
+See [ARCHITECTURE.md](./ARCHITECTURE.md) and
+[CONTRIBUTING.md](./CONTRIBUTING.md) before adding frontend facades,
+profile/session runtime logic, or orchestration tests.
+
+Short rule:
+
+- `101` tests must stay didactic and step by step
+- reusable fixtures/types must come from `gdc-common-utils-ts` instead of
+  being repeated as frontend-local literals
+
 Frontend runtime package for consuming the shared GDC SDK contracts in web or
 mobile apps.
 
@@ -28,6 +38,13 @@ If you are integrating this package for the first time, open these in order:
 1. [gdc-sdk-core-ts/docs/101-SDK_PACKAGE_BOUNDARIES.md](https://github.com/Global-DataCare/gdc-sdk-core-ts/blob/main/docs/101-SDK_PACKAGE_BOUNDARIES.md)
    Why `core`, `node`, and `front` are separate packages, what each one owns,
    and why frontend facades should mirror backend actor boundaries.
+1. [tests/101-frontend-profile-runtime.test.mjs](./tests/101-frontend-profile-runtime.test.mjs)
+   Minimal frontend-generic walkthrough for loading one actor profile,
+   registering one trusted device/runtime context, connecting to one subject
+   index, and reading one subject index composition.
+1. [tests/101-individual-controller-frontend-runtime.test.mjs](./tests/101-individual-controller-frontend-runtime.test.mjs)
+   First pragmatic frontend wrapper over the generic profile runtime for the
+   current individual-controller baseline.
 1. [docs/101-SDK_INTEGRATION.md](./docs/101-SDK_INTEGRATION.md)
   Real frontend/native setup, imports, `new ClientSDK(...)`,
   `initializeCommunicationIdentity(...)`, provider discovery, and
@@ -637,6 +654,15 @@ const otpStartInput: RelationshipChannelOtpStartInput = {
 const otpStart = createRelationshipChannelOtpStartInput(otpStartInput);
 ```
 
+Route naming rule:
+
+- the example above is tenant-scoped, so `jurisdiction + sector` belongs to the
+  tenant route context
+- host onboarding is different: host routes use `host coverage jurisdiction +
+  hostNetwork`
+- if you later call a host route like `/host/cds-EU/v1/test/...`, that `test`
+  is the host runtime/network segment, not the tenant sector
+
 ### Build permission-request communication
 
 ```ts

package/dist/frontend-profile-runtime.d.ts

@@ -0,0 +1,63 @@
+import type { LoadedActorProfile, ProfileLoadRequest, SubjectIndexCompositionRequest, SubjectIndexConnectionRequest, TrustedDeviceRegistrationRequest } from 'gdc-sdk-core-ts';
+/**
+ * Result of registering one trusted frontend device/runtime context.
+ */
+export type FrontendTrustedDeviceRegistrationResult = {
+    trustedDeviceId: string;
+    status: 'registered' | 'already-trusted';
+};
+/**
+ * Result of connecting one loaded actor profile to one subject index from a
+ * frontend runtime.
+ */
+export type FrontendSubjectIndexConnectionResult = {
+    subjectId: string;
+    userId: string;
+    userRoleCode: string;
+    status: 'connected' | 'already-connected';
+};
+/**
+ * Result of reading one subject index composition from a frontend runtime.
+ */
+export type FrontendSubjectIndexCompositionResult = {
+    subjectId: string;
+    userId: string;
+    userRoleCode: string;
+    composition: unknown;
+};
+/**
+ * Canonical frontend runtime contract for:
+ * - loading one actor profile,
+ * - registering one trusted device/runtime context,
+ * - connecting one actor to one subject index, and
+ * - reading the resulting subject index composition.
+ */
+export type FrontendProfileRuntimeClient = {
+    loadProfile?: (input: ProfileLoadRequest) => Promise<LoadedActorProfile>;
+    registerTrustedDevice?: (input: TrustedDeviceRegistrationRequest) => Promise<FrontendTrustedDeviceRegistrationResult>;
+    connectToSubjectIndex?: (input: SubjectIndexConnectionRequest) => Promise<FrontendSubjectIndexConnectionResult>;
+    getSubjectIndexComposition?: (input: SubjectIndexCompositionRequest) => Promise<FrontendSubjectIndexCompositionResult>;
+};
+export type FrontendProfileRuntimeAdapters = {
+    loadProfile(input: ProfileLoadRequest): Promise<LoadedActorProfile>;
+    registerTrustedDevice(input: TrustedDeviceRegistrationRequest): Promise<FrontendTrustedDeviceRegistrationResult>;
+    connectToSubjectIndex(input: SubjectIndexConnectionRequest): Promise<FrontendSubjectIndexConnectionResult>;
+    getSubjectIndexComposition(input: SubjectIndexCompositionRequest): Promise<FrontendSubjectIndexCompositionResult>;
+};
+/**
+ * Default frontend-generic profile runtime implementation backed by injected
+ * adapters.
+ */
+export declare class FrontendProfileRuntime implements FrontendProfileRuntimeClient {
+    private readonly adapters;
+    constructor(adapters: FrontendProfileRuntimeAdapters);
+    loadProfile(input: ProfileLoadRequest): Promise<LoadedActorProfile>;
+    registerTrustedDevice(input: TrustedDeviceRegistrationRequest): Promise<FrontendTrustedDeviceRegistrationResult>;
+    connectToSubjectIndex(input: SubjectIndexConnectionRequest): Promise<FrontendSubjectIndexConnectionResult>;
+    getSubjectIndexComposition(input: SubjectIndexCompositionRequest): Promise<FrontendSubjectIndexCompositionResult>;
+}
+export declare function requireFrontendProfileRuntimeMethod<T extends keyof FrontendProfileRuntimeClient>(client: FrontendProfileRuntimeClient, method: T): NonNullable<FrontendProfileRuntimeClient[T]>;
+export declare function loadFrontendProfile(client: FrontendProfileRuntimeClient, input: ProfileLoadRequest): Promise<LoadedActorProfile>;
+export declare function registerFrontendTrustedDevice(client: FrontendProfileRuntimeClient, input: TrustedDeviceRegistrationRequest): Promise<FrontendTrustedDeviceRegistrationResult>;
+export declare function connectFrontendToSubjectIndex(client: FrontendProfileRuntimeClient, input: SubjectIndexConnectionRequest): Promise<FrontendSubjectIndexConnectionResult>;
+export declare function getFrontendSubjectIndexComposition(client: FrontendProfileRuntimeClient, input: SubjectIndexCompositionRequest): Promise<FrontendSubjectIndexCompositionResult>;

package/dist/frontend-profile-runtime.js

@@ -0,0 +1,41 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+/**
+ * Default frontend-generic profile runtime implementation backed by injected
+ * adapters.
+ */
+export class FrontendProfileRuntime {
+    constructor(adapters) {
+        this.adapters = adapters;
+    }
+    async loadProfile(input) {
+        return this.adapters.loadProfile(input);
+    }
+    async registerTrustedDevice(input) {
+        return this.adapters.registerTrustedDevice(input);
+    }
+    async connectToSubjectIndex(input) {
+        return this.adapters.connectToSubjectIndex(input);
+    }
+    async getSubjectIndexComposition(input) {
+        return this.adapters.getSubjectIndexComposition(input);
+    }
+}
+export function requireFrontendProfileRuntimeMethod(client, method) {
+    const candidate = client[method];
+    if (typeof candidate !== 'function') {
+        throw new Error(`FrontendProfileRuntimeClient does not implement '${String(method)}'.`);
+    }
+    return candidate.bind(client);
+}
+export async function loadFrontendProfile(client, input) {
+    return requireFrontendProfileRuntimeMethod(client, 'loadProfile')(input);
+}
+export async function registerFrontendTrustedDevice(client, input) {
+    return requireFrontendProfileRuntimeMethod(client, 'registerTrustedDevice')(input);
+}
+export async function connectFrontendToSubjectIndex(client, input) {
+    return requireFrontendProfileRuntimeMethod(client, 'connectToSubjectIndex')(input);
+}
+export async function getFrontendSubjectIndexComposition(client, input) {
+    return requireFrontendProfileRuntimeMethod(client, 'getSubjectIndexComposition')(input);
+}

package/dist/gdc-common-utils-ts/src/utils/didcomm-submit.d.ts

@@ -29,7 +29,7 @@ export type DidcommSubmitResult = {
     location?: string;
     body: unknown;
     submitKind: 'plain' | 'encrypted';
-    contentType: 'application/didcomm-plaintext+json' | 'application/didcomm-encrypted+json';
+    contentType: 'application/didcomm-plain+json' | 'application/didcomm-encrypted+json';
 };
 /**
  * Submits a DIDComm payload using either plaintext or encrypted transport,

package/dist/index.d.ts

@@ -11,6 +11,8 @@ export * from './VerifierService.js';
 export * from './ProfileManager.js';
 export * from './ProfileRegistry.js';
 export * from './ClientSDK.js';
+export * from './frontend-profile-runtime.js';
+export * from './individual-controller-frontend-runtime.js';
 export * from './discovery/index.js';
 export * from './orchestration/client-port.js';
 export * from './orchestration/host-onboarding-sdk.js';

package/dist/index.js

@@ -12,6 +12,8 @@ export * from './VerifierService.js';
 export * from './ProfileManager.js';
 export * from './ProfileRegistry.js';
 export * from './ClientSDK.js';
+export * from './frontend-profile-runtime.js';
+export * from './individual-controller-frontend-runtime.js';
 export * from './discovery/index.js';
 export * from './orchestration/client-port.js';
 export * from './orchestration/host-onboarding-sdk.js';

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

@@ -0,0 +1,50 @@
+import type { SubmitAndPollResult } from 'gdc-sdk-core-ts';
+import type { ProfileLoadRequest } from 'gdc-sdk-core-ts';
+import { type FrontendProfileRuntimeClient } from './frontend-profile-runtime.js';
+import { IndividualControllerSdk } from './orchestration/individual-controller-sdk.js';
+import type { FrontClinicalBundleSearchInput, FrontIndividualOrganizationBootstrapInput, FrontIndividualOrganizationConfirmOrderInput, FrontIndividualOrganizationStartResult, FrontRouteContext, FrontRuntimeClient } from './orchestration/client-port.js';
+import type { LoadedActorProfile } from 'gdc-sdk-core-ts';
+export type FrontendIndividualControllerProfile = {
+    profile: LoadedActorProfile;
+    sdk: IndividualControllerSdk;
+};
+/**
+ * First pragmatic frontend use-case wrapper on top of the generic v2 profile
+ * runtime.
+ *
+ * It keeps the generic `loadProfile(...)` contract intact while giving portal
+ * or app code one narrower surface for the current individual-controller
+ * baseline.
+ */
+export declare class IndividualControllerFrontendRuntime {
+    private readonly profileRuntime;
+    private readonly facadeClient;
+    constructor(profileRuntime: FrontendProfileRuntimeClient, facadeClient: FrontRuntimeClient);
+    /**
+     * Loads one frontend profile and ensures it exposes the individual-controller
+     * actor capability before materializing the facade.
+     */
+    loadProfile(input: ProfileLoadRequest): Promise<FrontendIndividualControllerProfile>;
+    /**
+     * Starts the current individual/family bootstrap flow from frontend code.
+     */
+    startIndividualOrganization(profile: FrontendIndividualControllerProfile, ctx: FrontRouteContext, input: FrontIndividualOrganizationBootstrapInput): Promise<FrontIndividualOrganizationStartResult>;
+    /**
+     * Confirms the order returned by the frontend bootstrap flow.
+     */
+    confirmIndividualOrganizationOrder(profile: FrontendIndividualControllerProfile, ctx: FrontRouteContext, input: FrontIndividualOrganizationConfirmOrderInput): Promise<SubmitAndPollResult>;
+    /**
+     * Searches the subject clinical index from the frontend individual-controller
+     * facade.
+     */
+    searchClinicalBundle(profile: FrontendIndividualControllerProfile, ctx: FrontRouteContext, input: FrontClinicalBundleSearchInput): Promise<{
+        thid: string;
+    }>;
+    /**
+     * Reads the latest IPS-oriented bundle from the frontend individual-controller
+     * facade.
+     */
+    getLatestIps(profile: FrontendIndividualControllerProfile, ctx: FrontRouteContext, subject: string): Promise<{
+        thid: string;
+    }>;
+}

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

@@ -0,0 +1,58 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+import { ActorKinds } from 'gdc-common-utils-ts/constants/actor-session';
+import { loadFrontendProfile, } from './frontend-profile-runtime.js';
+import { IndividualControllerSdk } from './orchestration/individual-controller-sdk.js';
+/**
+ * First pragmatic frontend use-case wrapper on top of the generic v2 profile
+ * runtime.
+ *
+ * It keeps the generic `loadProfile(...)` contract intact while giving portal
+ * or app code one narrower surface for the current individual-controller
+ * baseline.
+ */
+export class IndividualControllerFrontendRuntime {
+    constructor(profileRuntime, facadeClient) {
+        this.profileRuntime = profileRuntime;
+        this.facadeClient = facadeClient;
+    }
+    /**
+     * Loads one frontend profile and ensures it exposes the individual-controller
+     * actor capability before materializing the facade.
+     */
+    async loadProfile(input) {
+        const profile = await loadFrontendProfile(this.profileRuntime, input);
+        if (!profile.session.actorKinds.includes(ActorKinds.IndividualController)) {
+            throw new Error('Loaded frontend profile does not expose actor kind \'individual_controller\'.');
+        }
+        return {
+            profile,
+            sdk: new IndividualControllerSdk(this.facadeClient),
+        };
+    }
+    /**
+     * Starts the current individual/family bootstrap flow from frontend code.
+     */
+    startIndividualOrganization(profile, ctx, input) {
+        return profile.sdk.startIndividualOrganization(ctx, input);
+    }
+    /**
+     * Confirms the order returned by the frontend bootstrap flow.
+     */
+    confirmIndividualOrganizationOrder(profile, ctx, input) {
+        return profile.sdk.confirmIndividualOrganizationOrder(ctx, input);
+    }
+    /**
+     * Searches the subject clinical index from the frontend individual-controller
+     * facade.
+     */
+    searchClinicalBundle(profile, ctx, input) {
+        return profile.sdk.searchClinicalBundle(ctx, input);
+    }
+    /**
+     * Reads the latest IPS-oriented bundle from the frontend individual-controller
+     * facade.
+     */
+    getLatestIps(profile, ctx, subject) {
+        return profile.sdk.getLatestIps(ctx, subject);
+    }
+}

package/dist/orchestration/client-port.d.ts

@@ -1,7 +1,8 @@
 import type { DeviceAppType, DeviceUserClass } from 'gdc-common-utils-ts/constants';
-import type { LicenseListSearchDraft, LicenseOfferSearchDraft, LicenseOrderSearchDraft } from 'gdc-common-utils-ts';
+import type { LicenseListSearchState } from 'gdc-common-utils-ts/utils/license-list-search';
+import type { LicenseOfferSearchState, LicenseOrderSearchState } from 'gdc-common-utils-ts/utils/license-commercial-search';
 import type { IndividualOnboardingDraftInput, IndividualOnboardingDraftResult } from 'gdc-common-utils-ts/models/individual-onboarding';
-import type { BundleSearchQuery, CommunicationInput, EmployeeSearchValue, HostLifecycleInput, HostRouteContext, HostedTenantLifecycleInput, LegalOrganizationOrderInput, PollOptions, SubmitAndPollResult, SubmitPayload } from 'gdc-sdk-core-ts';
+import type { BundleSearchQuery, CommunicationInput, EmployeeSearchValue, HostLifecycleInput, HostRouteContext, HostedTenantLifecycleInput, OrganizationDidBindingInput, LegalOrganizationOrderInput, PollOptions, SubmitAndPollResult, SubmitPayload } from 'gdc-sdk-core-ts';
 export type FrontRouteContext = {
     providerDid: string;
     idToken: string;
@@ -22,6 +23,7 @@ export type FrontOrganizationActivationInput = {
     service?: Record<string, unknown>;
     additionalClaims?: Record<string, unknown>;
 };
+export type FrontOrganizationDidBindingInput = OrganizationDidBindingInput;
 export type FrontLegalOrganizationOrderInput = {
     offerId: string;
     orderClaims?: Record<string, unknown>;
@@ -46,7 +48,7 @@ export type FrontOrganizationEmployeeSearchInput = {
  * Frontend/runtime search/list input for license seats.
  */
 export type FrontLicenseListSearchInput = {
-    licenseQuery?: Partial<LicenseListSearchDraft>;
+    licenseQuery?: Partial<LicenseListSearchState>;
     requestThid?: string;
     pollOptions?: PollOptions;
 };
@@ -54,7 +56,7 @@ export type FrontLicenseListSearchInput = {
  * Frontend/runtime search/list input for commercial offer read-models.
  */
 export type FrontLicenseOfferSearchInput = {
-    offerQuery?: Partial<LicenseOfferSearchDraft>;
+    offerQuery?: Partial<LicenseOfferSearchState>;
     requestThid?: string;
     pollOptions?: PollOptions;
 };
@@ -62,7 +64,7 @@ export type FrontLicenseOfferSearchInput = {
  * Frontend/runtime search/list input for commercial order/payment read-models.
  */
 export type FrontLicenseOrderSearchInput = {
-    orderQuery?: Partial<LicenseOrderSearchDraft>;
+    orderQuery?: Partial<LicenseOrderSearchState>;
     requestThid?: string;
     pollOptions?: PollOptions;
 };
@@ -169,6 +171,7 @@ export type FrontRuntimeClient = {
     disableHost?: (hostCtx: HostRouteContext, input: HostLifecycleInput, pollOptions?: PollOptions) => Promise<SubmitAndPollResult>;
     purgeHost?: (hostCtx: HostRouteContext, input: HostLifecycleInput, pollOptions?: PollOptions) => Promise<SubmitAndPollResult>;
     createOrganizationEmployee?: (ctx: FrontRouteContext, input: FrontOrganizationEmployeeCreationInput, pollOptions?: PollOptions) => Promise<SubmitAndPollResult>;
+    submitOrganizationDidBinding?: (ctx: FrontRouteContext, input: FrontOrganizationDidBindingInput, pollOptions?: PollOptions) => Promise<SubmitAndPollResult>;
     disableEmployee?: (ctx: FrontRouteContext, input: FrontOrganizationEmployeeLifecycleInput, pollOptions?: PollOptions) => Promise<SubmitAndPollResult>;
     searchOrganizationEmployees?: (ctx: FrontRouteContext, input: FrontOrganizationEmployeeSearchInput) => Promise<SubmitAndPollResult>;
     searchOrganizationLicenses?: (ctx: FrontRouteContext, input: FrontLicenseListSearchInput) => Promise<SubmitAndPollResult>;

package/dist/orchestration/organization-controller-sdk.d.ts

@@ -1,8 +1,21 @@
 import type { HostRouteContext, HostedTenantLifecycleInput, PollOptions, SubmitAndPollResult } from 'gdc-sdk-core-ts';
-import { type FrontEmployeeDeviceActivationRequestInput, type FrontLicenseListSearchInput, type FrontLicenseOfferSearchInput, type FrontLicenseOrderSearchInput, type FrontOrganizationEmployeeCreationInput, type FrontOrganizationEmployeeLifecycleInput, type FrontOrganizationEmployeeSearchInput, type FrontRouteContext, type FrontRuntimeClient, type FrontSmartTokenExchangeResult, type FrontSmartTokenRequestInput } from './client-port.js';
+import { type FrontEmployeeDeviceActivationRequestInput, type FrontLicenseListSearchInput, type FrontLicenseOfferSearchInput, type FrontLicenseOrderSearchInput, type FrontOrganizationDidBindingInput, type FrontOrganizationEmployeeCreationInput, type FrontOrganizationEmployeeLifecycleInput, type FrontOrganizationEmployeeSearchInput, type FrontRouteContext, type FrontRuntimeClient, type FrontSmartTokenExchangeResult, type FrontSmartTokenRequestInput } from './client-port.js';
 export declare class OrganizationControllerSdk {
     private readonly client;
     constructor(client: FrontRuntimeClient);
+    /**
+     * Binds the current tenant organization DID document to one public alias
+     * view.
+     *
+     * Alias contract:
+     * - the current tenant path identifies the organization
+     * - `organization.url` carries the public alias/domain list
+     * - `controller.sameAs` is optional corroborating identity evidence
+     *
+     * Current version limits:
+     * - this binding flow does not accept new organization public keys
+     */
+    submitOrganizationDidBinding(ctx: FrontRouteContext, input: FrontOrganizationDidBindingInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
     createOrganizationEmployee(ctx: FrontRouteContext, input: FrontOrganizationEmployeeCreationInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
     disableEmployee(ctx: FrontRouteContext, input: FrontOrganizationEmployeeLifecycleInput, pollOptions?: PollOptions): Promise<SubmitAndPollResult>;
     searchOrganizationEmployees(ctx: FrontRouteContext, input: FrontOrganizationEmployeeSearchInput): Promise<SubmitAndPollResult>;

package/dist/orchestration/organization-controller-sdk.js

@@ -4,6 +4,21 @@ export class OrganizationControllerSdk {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Binds the current tenant organization DID document to one public alias
+     * view.
+     *
+     * Alias contract:
+     * - the current tenant path identifies the organization
+     * - `organization.url` carries the public alias/domain list
+     * - `controller.sameAs` is optional corroborating identity evidence
+     *
+     * Current version limits:
+     * - this binding flow does not accept new organization public keys
+     */
+    submitOrganizationDidBinding(ctx, input, pollOptions) {
+        return requireClientMethod(this.client, 'submitOrganizationDidBinding')(ctx, input, pollOptions);
+    }
     createOrganizationEmployee(ctx, input, pollOptions) {
         return requireClientMethod(this.client, 'createOrganizationEmployee')(ctx, input, pollOptions);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdc-sdk-front-ts",
-  "version": "0.10.1",
+  "version": "2.0.3",
   "description": "Next-generation frontend runtime package for the GDC SDK family",
   "license": "Apache-2.0",
   "author": "Antifraud Services Inc.",
@@ -17,8 +17,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.28.4",
-    "gdc-common-utils-ts": "^1.24.1",
-    "gdc-sdk-core-ts": "^0.11.1"
+    "gdc-common-utils-ts": "^2.0.6",
+    "gdc-sdk-core-ts": "^2.0.4"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",