sos-sdk-node-ts 0.1.12 → 0.1.13

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## Unreleased
+## 0.1.13 - 2026-10-21
+
+- Add the trusted-BFF host organization directory client. It submits and polls
+  the canonical host `org.schema/Organization/_search` route, reads a
+  DIDComm-wrapped paginated Bundle, preserves opaque cursors and surfaces
+  Bundle `OperationOutcome` failures without accepting browser-selected host
+  authority. The same client performs status, suspend, reactivate and purge
+  operations and reads their authoritative Bundle results.
 
 ## 0.1.12 - 2026-10-21
 

package/README.md

@@ -69,6 +69,13 @@ BFF. It matches exact aliases inside `Organization.sameAs` CSV values and
 rejects removed animal-card DID layouts before UI mapping. See
 [the authorized subject directory contract](docs/AUTHORIZED_SUBJECT_DIRECTORY.md).
 
+`sos-sdk-node-ts/host-organization-directory-client` is the separate trusted-
+BFF client for a host operator's organization directory. It sends the
+canonical `org.schema/Organization/_search` request, polls the matching
+response route and returns the privacy-minimized, paginated Bundle projection.
+The host jurisdiction and network come from trusted server configuration;
+they are never browser-selected authority.
+
 ## Secure-message CSPRNG adapter
 
 `sos-sdk-node-ts/secure-message-crypto` exports `NodeSecureRandomSource` and

package/dist/host-organization-directory-client.d.ts

@@ -0,0 +1,78 @@
+export type HostOrganizationDirectoryRoute = Readonly<{
+    jurisdiction: string;
+    network: 'test' | 'local-network' | 'test-network' | 'network';
+}>;
+export type HostOrganizationDirectoryFilters = Readonly<{
+    jurisdiction?: string;
+    sector?: string;
+    status?: 'active' | 'suspended' | 'revoked';
+    identifierType?: string;
+    identifierValue?: string;
+    legalName?: string;
+    name?: string;
+}>;
+export type HostOrganizationDirectoryEntry = Readonly<{
+    id: string;
+    legalName: string;
+    name: string;
+    identifierType: string;
+    identifierValue: string;
+    jurisdiction: string;
+    sector: string;
+    status: 'active' | 'suspended' | 'revoked';
+    sameAs?: string;
+    claims: Readonly<Record<string, unknown>>;
+}>;
+export type HostOrganizationDirectoryPage = Readonly<{
+    total: number;
+    pageSize: number;
+    returned: number;
+    hasNext: boolean;
+    nextCursor?: string;
+    organizations: readonly HostOrganizationDirectoryEntry[];
+}>;
+export type HostOrganizationDirectorySearch = Readonly<{
+    filters?: HostOrganizationDirectoryFilters;
+    pageSize?: number;
+    cursor?: string;
+    requestThid?: string;
+    pollOptions?: Readonly<{
+        timeoutMs?: number;
+        intervalMs?: number;
+    }>;
+}>;
+export type HostOrganizationLifecycleAction = '_status' | '_disable' | '_enable' | '_purge';
+export type HostOrganizationLifecycleTarget = Readonly<{
+    identifierType: string;
+    identifierValue: string;
+    sameAs?: string;
+}>;
+export type HostOrganizationLifecycleResult = Readonly<{
+    status: 'active' | 'suspended' | 'revoked';
+    disposition?: string;
+    organizationId?: string;
+}>;
+export type SosGatewayHostOrganizationDirectoryClientOptions = Readonly<{
+    baseUrl: string;
+    bearerToken?: string;
+    appId?: string;
+    appVersion?: string;
+    defaultHeaders?: Readonly<Record<string, string>>;
+    requestTimeoutMs?: number;
+    fetchImpl?: typeof fetch;
+}>;
+/** Trusted-BFF transport for the host-only Organization registry directory. */
+export declare class SosGatewayHostOrganizationDirectoryClient {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly requestTimeoutMs;
+    private readonly fetchImpl;
+    constructor(options: SosGatewayHostOrganizationDirectoryClientOptions);
+    search(route: HostOrganizationDirectoryRoute, input?: HostOrganizationDirectorySearch): Promise<HostOrganizationDirectoryPage>;
+    lifecycle(route: HostOrganizationDirectoryRoute, action: HostOrganizationLifecycleAction, target: HostOrganizationLifecycleTarget, options?: Readonly<{
+        timeoutMs?: number;
+        intervalMs?: number;
+    }>): Promise<HostOrganizationLifecycleResult>;
+    private submitAndPoll;
+    private post;
+}

package/dist/host-organization-directory-client.js

@@ -0,0 +1,248 @@
+import { randomUUID } from 'node:crypto';
+import { buildGatewayApplicationHeaders } from 'sos-data-utils-ts/gateway-application-identity';
+const CLAIM_LEGAL_NAME = 'org.schema.Organization.legalName';
+const CLAIM_NAME = 'org.schema.Organization.name';
+const CLAIM_IDENTIFIER_TYPE = 'org.schema.Organization.identifier.additionalType';
+const CLAIM_IDENTIFIER_VALUE = 'org.schema.Organization.identifier.value';
+const CLAIM_JURISDICTION = 'org.schema.Organization.address.addressCountry';
+const CLAIM_SAME_AS = 'org.schema.Organization.sameAs';
+const CLAIM_SECTOR = 'org.schema.Service.category';
+const CLAIM_STATUS = 'org.schema.Action.tenantAuthorization.status';
+/** Trusted-BFF transport for the host-only Organization registry directory. */
+export class SosGatewayHostOrganizationDirectoryClient {
+    baseUrl;
+    headers;
+    requestTimeoutMs;
+    fetchImpl;
+    constructor(options) {
+        this.baseUrl = normalizeBaseUrl(options.baseUrl);
+        this.requestTimeoutMs = positiveInteger(options.requestTimeoutMs ?? 15_000, 'request_timeout_invalid');
+        this.fetchImpl = options.fetchImpl ?? fetch;
+        const bearerToken = optional(options.bearerToken);
+        const appId = optional(options.appId);
+        this.headers = Object.freeze({
+            'Content-Type': 'application/didcomm-plain+json',
+            Accept: 'application/didcomm-plain+json',
+            ...(bearerToken ? { Authorization: `Bearer ${bearerToken}` } : {}),
+            ...(appId ? buildGatewayApplicationHeaders({ appId, appVersion: options.appVersion }) : {}),
+            ...(options.defaultHeaders ?? {}),
+        });
+    }
+    async search(route, input = {}) {
+        const context = normalizeRoute(route);
+        const thid = optional(input.requestThid) || `host-organization-directory-${randomUUID()}`;
+        const claims = filterClaims(input.filters);
+        const body = {
+            resourceType: 'Bundle',
+            type: 'searchset',
+            data: [{
+                    type: 'Organization-search-v1.0',
+                    request: { method: 'GET', url: 'Organization/_search' },
+                    resource: { resourceType: 'Organization', meta: { claims } },
+                }],
+            meta: { pagination: {
+                    ...(input.pageSize === undefined ? {} : { pageSize: positiveInteger(input.pageSize, 'page_size_invalid') }),
+                    ...(optional(input.cursor) ? { cursor: optional(input.cursor) } : {}),
+                } },
+        };
+        const prefix = `/host/cds-${encodeURIComponent(context.jurisdiction)}/v1/${encodeURIComponent(context.network)}/registry/org.schema/Organization`;
+        const response = await this.submitAndPoll(`${prefix}/_search`, `${prefix}/_search-response`, { thid, body }, input.pollOptions);
+        return readPage(response.body);
+    }
+    async lifecycle(route, action, target, options) {
+        const context = normalizeRoute(route);
+        const identifierType = required(target.identifierType, 'host_lifecycle_identifier_type_required');
+        const identifierValue = required(target.identifierValue, 'host_lifecycle_identifier_value_required');
+        const thid = `host-organization-lifecycle-${randomUUID()}`;
+        const claims = {
+            [CLAIM_IDENTIFIER_TYPE]: identifierType,
+            [CLAIM_IDENTIFIER_VALUE]: identifierValue,
+            ...(optional(target.sameAs) ? { [CLAIM_SAME_AS]: optional(target.sameAs) } : {}),
+        };
+        const body = {
+            resourceType: 'Bundle',
+            type: 'batch',
+            data: [{
+                    type: `Organization-${action.slice(1)}-request-v1.0`,
+                    request: { method: 'POST', url: `Organization/${action}` },
+                    resource: { resourceType: 'Organization', meta: { claims } },
+                }],
+        };
+        const prefix = `/host/cds-${encodeURIComponent(context.jurisdiction)}/v1/${encodeURIComponent(context.network)}/registry/org.schema/Organization`;
+        const response = await this.submitAndPoll(`${prefix}/${action}`, `${prefix}/${action}-response`, { thid, body }, options);
+        return readLifecycleResult(response.body);
+    }
+    async submitAndPoll(submitPath, pollPath, payload, options) {
+        const submit = await this.post(submitPath, payload);
+        requireSuccessfulResponse(submit, 'gateway_submit_failed');
+        const timeoutMs = positiveInteger(options?.timeoutMs ?? 30_000, 'poll_timeout_invalid');
+        const intervalMs = positiveInteger(options?.intervalMs ?? 250, 'poll_interval_invalid');
+        const started = Date.now();
+        for (;;) {
+            const poll = await this.post(pollPath, { thid: payload.thid });
+            if (poll.status !== 202) {
+                requireSuccessfulResponse(poll, 'gateway_poll_failed');
+                return poll;
+            }
+            if (Date.now() - started >= timeoutMs)
+                throw new Error('gateway_poll_timeout');
+            await new Promise(resolve => setTimeout(resolve, intervalMs));
+        }
+    }
+    async post(path, payload) {
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), this.requestTimeoutMs);
+        try {
+            const response = await this.fetchImpl(`${this.baseUrl}${path}`, {
+                method: 'POST', headers: this.headers, body: JSON.stringify(payload), signal: controller.signal,
+            });
+            const raw = await response.text();
+            let body = {};
+            if (raw) {
+                try {
+                    body = JSON.parse(raw);
+                }
+                catch {
+                    body = raw;
+                }
+            }
+            return { status: response.status, body };
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+}
+function normalizeRoute(value) {
+    const keys = Object.keys(value);
+    if (keys.some(key => key !== 'jurisdiction' && key !== 'network'))
+        throw new Error('route_context_invalid');
+    const jurisdiction = segment(value.jurisdiction);
+    const network = segment(value.network);
+    if (!['test', 'local-network', 'test-network', 'network'].includes(network))
+        throw new Error('route_context_invalid');
+    return Object.freeze({ jurisdiction, network: network });
+}
+function filterClaims(filters = {}) {
+    return Object.freeze(Object.fromEntries([
+        [CLAIM_JURISDICTION, filters.jurisdiction],
+        [CLAIM_SECTOR, filters.sector],
+        [CLAIM_STATUS, filters.status],
+        [CLAIM_IDENTIFIER_TYPE, filters.identifierType],
+        [CLAIM_IDENTIFIER_VALUE, filters.identifierValue],
+        [CLAIM_LEGAL_NAME, filters.legalName],
+        [CLAIM_NAME, filters.name],
+    ].flatMap(([key, value]) => optional(value) ? [[key, optional(value)]] : [])));
+}
+function readPage(value) {
+    const root = record(value);
+    const bundle = record(root.body || root);
+    const data = Array.isArray(bundle.data) ? bundle.data : [];
+    const outcome = data.flatMap((entry) => {
+        const response = record(record(entry).response);
+        const result = record(response.outcome);
+        return result.resourceType === 'OperationOutcome' && Array.isArray(result.issue) ? result.issue : [];
+    }).map(record).find(issue => ['fatal', 'error'].includes(String(issue.severity || '').toLowerCase()));
+    if (outcome)
+        throw new Error(`host_directory_failed:${String(outcome.diagnostics || outcome.code || 'operation_outcome')}`);
+    if (bundle.resourceType !== 'Bundle' || bundle.type !== 'searchset')
+        throw new Error('host_directory_bundle_invalid');
+    const organizations = data.flatMap((entry) => {
+        const row = record(entry);
+        const response = record(row.response);
+        const resource = record(row.resource);
+        const claims = Object.freeze({ ...record(record(resource.meta).claims) });
+        if (resource.resourceType !== 'Organization' || !String(response.status || '').startsWith('2'))
+            return [];
+        const status = String(claims[CLAIM_STATUS] || '');
+        if (!['active', 'suspended', 'revoked'].includes(status))
+            throw new Error('host_directory_status_invalid');
+        return [Object.freeze({
+                id: String(resource.id || row.id || ''),
+                legalName: String(claims[CLAIM_LEGAL_NAME] || ''),
+                name: String(claims[CLAIM_NAME] || claims[CLAIM_LEGAL_NAME] || ''),
+                identifierType: String(claims[CLAIM_IDENTIFIER_TYPE] || ''),
+                identifierValue: String(claims[CLAIM_IDENTIFIER_VALUE] || ''),
+                jurisdiction: String(claims[CLAIM_JURISDICTION] || ''),
+                sector: String(claims[CLAIM_SECTOR] || ''),
+                status: status,
+                ...(optional(claims[CLAIM_SAME_AS]) ? { sameAs: optional(claims[CLAIM_SAME_AS]) } : {}),
+                claims,
+            })];
+    });
+    const pagination = record(record(bundle.meta).pagination);
+    return Object.freeze({
+        total: nonNegativeInteger(bundle.total, 'host_directory_total_invalid'),
+        pageSize: positiveInteger(pagination.pageSize, 'host_directory_page_size_invalid'),
+        returned: nonNegativeInteger(pagination.returned, 'host_directory_returned_invalid'),
+        hasNext: pagination.hasNext === true,
+        ...(optional(pagination.nextCursor) ? { nextCursor: optional(pagination.nextCursor) } : {}),
+        organizations: Object.freeze(organizations),
+    });
+}
+function readLifecycleResult(value) {
+    const root = record(value);
+    const bundle = record(root.body || root);
+    const data = Array.isArray(bundle.data) ? bundle.data : [];
+    const issue = data.flatMap((entry) => {
+        const outcome = record(record(record(entry).response).outcome);
+        return outcome.resourceType === 'OperationOutcome' && Array.isArray(outcome.issue) ? outcome.issue : [];
+    }).map(record).find(candidate => ['fatal', 'error'].includes(String(candidate.severity || '').toLowerCase()));
+    if (issue)
+        throw new Error(`host_lifecycle_failed:${String(issue.diagnostics || issue.code || 'operation_outcome')}`);
+    const entry = data.map(record).find(candidate => String(record(candidate.response).status || '').startsWith('2'));
+    if (!entry)
+        throw new Error('host_lifecycle_response_invalid');
+    const resource = record(entry.resource);
+    const claims = record(record(resource.meta).claims);
+    const status = String(claims[CLAIM_STATUS] || '');
+    if (!['active', 'suspended', 'revoked'].includes(status))
+        throw new Error('host_lifecycle_status_invalid');
+    return Object.freeze({
+        status: status,
+        ...(optional(claims['org.schema.Action.tenantAuthorization.lifecycleDisposition']) ? { disposition: optional(claims['org.schema.Action.tenantAuthorization.lifecycleDisposition']) } : {}),
+        ...(optional(resource.id) ? { organizationId: optional(resource.id) } : {}),
+    });
+}
+function requireSuccessfulResponse(response, code) {
+    if (response.status >= 200 && response.status < 300)
+        return;
+    throw new Error(`${code}:${response.status}`);
+}
+function normalizeBaseUrl(value) {
+    const url = new URL(value);
+    if (url.protocol !== 'https:' && url.hostname !== 'localhost' && url.hostname !== '127.0.0.1')
+        throw new Error('gateway_base_url_insecure');
+    return url.href.replace(/\/$/u, '');
+}
+function segment(value) {
+    const result = String(value ?? '').trim();
+    if (!result || result.includes('/') || result === '.' || result === '..')
+        throw new Error('route_context_invalid');
+    return result;
+}
+function record(value) {
+    return value && typeof value === 'object' && !Array.isArray(value) ? value : {};
+}
+function optional(value) {
+    const result = String(value ?? '').trim();
+    return result || undefined;
+}
+function required(value, code) {
+    const result = optional(value);
+    if (!result)
+        throw new Error(code);
+    return result;
+}
+function positiveInteger(value, code) {
+    const result = Number(value);
+    if (!Number.isInteger(result) || result < 1)
+        throw new Error(code);
+    return result;
+}
+function nonNegativeInteger(value, code) {
+    const result = Number(value);
+    if (!Number.isInteger(result) || result < 0)
+        throw new Error(code);
+    return result;
+}

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export * from './encounter-transfer-audience-service.js';
 export * from './bff-email-assertion.js';
 export * from './subject-card-directory-client.js';
 export * from './server-passkey-profile.js';
+export * from './host-organization-directory-client.js';

package/dist/index.js

@@ -8,3 +8,4 @@ export * from './encounter-transfer-audience-service.js';
 export * from './bff-email-assertion.js';
 export * from './subject-card-directory-client.js';
 export * from './server-passkey-profile.js';
+export * from './host-organization-directory-client.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sos-sdk-node-ts",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "Product-neutral Node adapters shared by SOSChain, Vet and UHC runtimes",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -47,6 +47,10 @@
     "./subject-card-directory-client": {
       "types": "./dist/subject-card-directory-client.d.ts",
       "default": "./dist/subject-card-directory-client.js"
+    },
+    "./host-organization-directory-client": {
+      "types": "./dist/host-organization-directory-client.d.ts",
+      "default": "./dist/host-organization-directory-client.js"
     }
   },
   "files": [