gdc-common-utils-ts 2.0.17 → 2.1.0

package/dist/examples/wallet-mem.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Reusable synthetic wallet fixtures for docs and tests.
+ *
+ * Rule:
+ * - wallet-related tests must import these values instead of re-hardcoding
+ *   queue ids, entity ids, thread ids, or payload strings inline
+ */
+export declare const EXAMPLE_WALLET_ENTITY_ID_SENDER: "wallet-entity-sender-001";
+export declare const EXAMPLE_WALLET_ENTITY_ID_RECIPIENT: "wallet-entity-recipient-001";
+export declare const EXAMPLE_WALLET_MESSAGE_ID_EMERGENCY: "wallet-message-emergency-001";
+export declare const EXAMPLE_WALLET_MESSAGE_ID_NORMAL: "wallet-message-normal-001";
+export declare const EXAMPLE_WALLET_THREAD_ID: "wallet-thread-001";
+export declare const EXAMPLE_WALLET_PAYLOAD_TYPE: "Communication-bundle-submit-v1.0";
+export declare const EXAMPLE_WALLET_CREATED_AT: "2026-06-30T10:00:00.000Z";
+export declare const EXAMPLE_WALLET_CONTENT_NOTE: "Medication bundle ready for DIDComm transport.";
+export declare const EXAMPLE_WALLET_FAILURE_MESSAGE: "Gateway temporary failure.";
+export declare const EXAMPLE_WALLET_PROTECTED_DOC_ID: "wallet-doc-001";
+export declare const EXAMPLE_WALLET_PRIORITY_EMERGENCY: "emergency";
+export declare const EXAMPLE_WALLET_PRIORITY_NORMAL: "normal";
+export declare const EXAMPLE_WALLET_MESSAGE_PAYLOAD: {
+    readonly iss: "did:web:sender.example.org";
+    readonly aud: "https://gw.example.org/submit";
+    readonly jti: "wallet-jti-001";
+    readonly thid: "wallet-thread-001";
+    readonly type: "Communication-bundle-submit-v1.0";
+    readonly body: {
+        readonly data: readonly [{
+            readonly id: "wallet-entry-001";
+            readonly type: "Communication-bundle-submit-v1.0";
+            readonly resource: {
+                readonly resourceType: "Communication";
+                readonly note: readonly [{
+                    readonly text: "Medication bundle ready for DIDComm transport.";
+                }];
+            };
+        }];
+    };
+};

package/dist/examples/wallet-mem.js

@@ -0,0 +1,40 @@
+// Copyright 2026 Conectate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+import { WalletMessagePriorities } from '../models/wallet.js';
+/**
+ * Reusable synthetic wallet fixtures for docs and tests.
+ *
+ * Rule:
+ * - wallet-related tests must import these values instead of re-hardcoding
+ *   queue ids, entity ids, thread ids, or payload strings inline
+ */
+export const EXAMPLE_WALLET_ENTITY_ID_SENDER = 'wallet-entity-sender-001';
+export const EXAMPLE_WALLET_ENTITY_ID_RECIPIENT = 'wallet-entity-recipient-001';
+export const EXAMPLE_WALLET_MESSAGE_ID_EMERGENCY = 'wallet-message-emergency-001';
+export const EXAMPLE_WALLET_MESSAGE_ID_NORMAL = 'wallet-message-normal-001';
+export const EXAMPLE_WALLET_THREAD_ID = 'wallet-thread-001';
+export const EXAMPLE_WALLET_PAYLOAD_TYPE = 'Communication-bundle-submit-v1.0';
+export const EXAMPLE_WALLET_CREATED_AT = '2026-06-30T10:00:00.000Z';
+export const EXAMPLE_WALLET_CONTENT_NOTE = 'Medication bundle ready for DIDComm transport.';
+export const EXAMPLE_WALLET_FAILURE_MESSAGE = 'Gateway temporary failure.';
+export const EXAMPLE_WALLET_PROTECTED_DOC_ID = 'wallet-doc-001';
+export const EXAMPLE_WALLET_PRIORITY_EMERGENCY = WalletMessagePriorities.Emergency;
+export const EXAMPLE_WALLET_PRIORITY_NORMAL = WalletMessagePriorities.Normal;
+export const EXAMPLE_WALLET_MESSAGE_PAYLOAD = {
+    iss: 'did:web:sender.example.org',
+    aud: 'https://gw.example.org/submit',
+    jti: 'wallet-jti-001',
+    thid: EXAMPLE_WALLET_THREAD_ID,
+    type: EXAMPLE_WALLET_PAYLOAD_TYPE,
+    body: {
+        data: [
+            {
+                id: 'wallet-entry-001',
+                type: EXAMPLE_WALLET_PAYLOAD_TYPE,
+                resource: {
+                    resourceType: 'Communication',
+                    note: [{ text: EXAMPLE_WALLET_CONTENT_NOTE }],
+                },
+            },
+        ],
+    },
+};

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './examples';
 export * from './hmac';
 export * from './i18n/clinical-sections.i18n';
 export * from './i18n/role-codes.i18n';
+export * from './interfaces';
 export * from './models';
 export * from './storage';
 export * from './utils';

package/dist/index.js

@@ -7,6 +7,7 @@ export * from './examples/index.js';
 export * from './hmac.js';
 export * from './i18n/clinical-sections.i18n.js';
 export * from './i18n/role-codes.i18n.js';
+export * from './interfaces/index.js';
 export * from './models/index.js';
 export * from './storage/index.js';
 export * from './utils/index.js';

package/dist/interfaces/IProfileOutboxRepository.d.ts

@@ -0,0 +1,36 @@
+import type { BackendMessageResponseRecord, ProfileOutboxMessageRecord } from '../models/profile-manager';
+/**
+ * Runtime-neutral repository for profile-scoped outbox history and decoded
+ * responses.
+ *
+ * Separation rule:
+ * - `IWalletQueue` controls ordering and mutable pending state
+ * - `IProfileOutboxRepository` preserves historical records and decoded
+ *   responses that the profile/runtime may want to inspect later
+ */
+export interface IProfileOutboxRepository {
+    /**
+     * Stores one immutable message history record.
+     */
+    putMessage(record: ProfileOutboxMessageRecord): Promise<ProfileOutboxMessageRecord>;
+    /**
+     * Returns one historical message record by id.
+     */
+    getMessage(messageId: string): Promise<ProfileOutboxMessageRecord | undefined>;
+    /**
+     * Lists all historical message records.
+     */
+    listMessages(): Promise<ProfileOutboxMessageRecord[]>;
+    /**
+     * Stores one decoded response record.
+     */
+    putResponse(record: BackendMessageResponseRecord): Promise<BackendMessageResponseRecord>;
+    /**
+     * Returns the latest decoded response for one thread id.
+     */
+    getLatestResponseByThreadId(thid: string): Promise<BackendMessageResponseRecord | undefined>;
+    /**
+     * Lists all decoded responses.
+     */
+    listResponses(): Promise<BackendMessageResponseRecord[]>;
+}

package/dist/interfaces/IProfileOutboxRepository.js

@@ -0,0 +1,2 @@
+// Copyright 2026 Conectate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+export {};

package/dist/interfaces/IWallet.d.ts

@@ -0,0 +1,74 @@
+import type { WalletEnqueueMessageInput, WalletManagedEntityDescriptor, WalletQueuedMessage } from '../models/wallet';
+import type { JWK, JwkSet } from '../models/jwk';
+/**
+ * Shared wallet contract reused by tests, apps, frontend adapters, and simple
+ * backend or BFF flows.
+ *
+ * Backward-compatibility rule:
+ * - the legacy methods (`provisionKeys`, `digest`,
+ *   `protectConfidentialData`, `unprotectConfidentialData`, `unpack`) remain
+ *   the stable minimum contract expected by older consumers
+ * - richer transport and queue helpers are optional so older platform-specific
+ *   adapters do not need to implement them immediately
+ */
+export interface IWallet {
+    /**
+     * Provisions or retrieves the wallet key set for one logical entity.
+     */
+    provisionKeys(entityId: string): Promise<JwkSet>;
+    /**
+     * Computes one digest string using the provided algorithm name.
+     */
+    digest(data: string, algorithm: string): Promise<string>;
+    /**
+     * Protects one local document for confidential at-rest storage.
+     */
+    protectConfidentialData(doc: unknown, entityId?: string): Promise<unknown>;
+    /**
+     * Unprotects one local confidential document.
+     */
+    unprotectConfidentialData(doc: unknown, entityId?: string): Promise<unknown>;
+    /**
+     * Unpacks one transport message into business content plus JOSE metadata.
+     */
+    unpack?(packedMessage: string, entityId?: string): Promise<{
+        content: unknown;
+        meta: Record<string, unknown>;
+    }>;
+    /**
+     * Packs one business payload for one recipient public key.
+     */
+    pack?(content: Record<string, unknown>, recipientJwk: JWK, entityId: string): Promise<string>;
+    /**
+     * Returns the public keys currently provisioned for one entity.
+     */
+    getPublicKeys?(entityId: string): Promise<WalletManagedEntityDescriptor>;
+    /**
+     * Signs one JSON payload into a compact JWS.
+     */
+    signCompactJws?(entityId: string, claims: Record<string, unknown>): Promise<string>;
+    /**
+     * Builds one compact JWE for the provided recipient.
+     */
+    buildCompactJwe?(entityId: string, plaintext: string | Uint8Array, recipientJwk: JWK, contentType?: string): Promise<string>;
+    /**
+     * Enqueues one local outbound message with an optional priority.
+     */
+    enqueueMessage?(input: WalletEnqueueMessageInput): Promise<WalletQueuedMessage>;
+    /**
+     * Returns the next pending message without mutating queue state.
+     */
+    peekNextMessage?(): Promise<WalletQueuedMessage | undefined>;
+    /**
+     * Marks one message as delivered.
+     */
+    markMessageDelivered?(messageId: string): Promise<WalletQueuedMessage>;
+    /**
+     * Marks one message as failed.
+     */
+    markMessageFailed?(messageId: string, errorMessage: string): Promise<WalletQueuedMessage>;
+    /**
+     * Lists all locally tracked queued messages.
+     */
+    listMessages?(): Promise<WalletQueuedMessage[]>;
+}

package/dist/interfaces/IWallet.js

@@ -0,0 +1,2 @@
+// Copyright 2026 Conectate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+export {};

package/dist/interfaces/IWalletQueue.d.ts

@@ -0,0 +1,30 @@
+import type { WalletEnqueueMessageInput, WalletQueuedMessage } from '../models/wallet';
+/**
+ * Runtime-neutral queue/outbox contract for low-level wallet-backed message
+ * scheduling.
+ *
+ * Design intent:
+ * - `common-utils` provides the contract plus one in-memory implementation
+ * - BFF/server runtimes may later plug Redis, Google, filesystem, or database
+ *   adapters without changing `WalletMem`
+ * - mobile/native runtimes may plug SQLite-backed outbox adapters
+ */
+export interface IWalletQueue {
+    /**
+     * Enqueues one outbound message and returns the stored queued record.
+     */
+    enqueue(input: WalletEnqueueMessageInput): Promise<WalletQueuedMessage>;
+    /**
+     * Returns the next pending message according to queue ordering rules without
+     * mutating queue state.
+     */
+    peekNextPending(): Promise<WalletQueuedMessage | undefined>;
+    /**
+     * Updates one queued message by identifier and returns the stored result.
+     */
+    update(messageId: string, patch: Partial<WalletQueuedMessage>): Promise<WalletQueuedMessage>;
+    /**
+     * Lists all queued messages in current processing order.
+     */
+    list(): Promise<WalletQueuedMessage[]>;
+}

package/dist/interfaces/IWalletQueue.js

@@ -0,0 +1,2 @@
+// Copyright 2026 Conectate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+export {};

package/dist/interfaces/index.d.ts

@@ -0,0 +1,8 @@
+export * from './ICryptoHelper';
+export * from './ICryptography';
+export * from './IWallet';
+export * from './IProfileOutboxRepository';
+export * from './IWalletQueue';
+export * from './MlDsa';
+export * from './MlKem';
+export * from './Cryptography.types';

package/dist/interfaces/index.js

@@ -0,0 +1,8 @@
+export * from './ICryptoHelper.js';
+export * from './ICryptography.js';
+export * from './IWallet.js';
+export * from './IProfileOutboxRepository.js';
+export * from './IWalletQueue.js';
+export * from './MlDsa.js';
+export * from './MlKem.js';
+export * from './Cryptography.types.js';

package/dist/models/communication-attached-bundle-session.d.ts

@@ -0,0 +1,193 @@
+import type { HealthcareCanonicalSectionFamily, HealthcareRoleFamily } from '../constants/healthcare';
+import type { BundleEntry, BundleJsonApi, BundleRequest } from './bundle';
+/**
+ * Runtime strictness used by `CommunicationAttachedBundleSession`.
+ */
+export type CommunicationAttachedBundleSessionMode = 'strict' | 'normalize';
+/**
+ * Constructor options for `CommunicationAttachedBundleSession`.
+ */
+export type CommunicationAttachedBundleSessionOptions = Readonly<{
+    communicationClaims?: Record<string, unknown>;
+    initialBundle?: BundleJsonApi<BundleEntry>;
+    mode?: CommunicationAttachedBundleSessionMode;
+}>;
+/**
+ * Canonical `@context` for outer `Communication` claim payloads.
+ *
+ * Rationale:
+ * - the outer container is materialized as one FHIR `Communication` resource
+ * - the inner `resource.meta.claims` rows stay version-agnostic and therefore
+ *   use `FHIR_API`
+ */
+export declare const CommunicationAttachmentClaimsContext: "org.hl7.fhir.r4";
+/**
+ * Canonical `@context` for bundle entry `resource.meta.claims`.
+ *
+ * These claims are intended to stay version-agnostic across FHIR releases.
+ */
+export declare const BundleEntryClaimsContext: "org.hl7.fhir.api";
+/**
+ * Selector for reopening one active bundle entry.
+ *
+ * Prefer `position` for bundle-array addressing. `index` is kept only as a
+ * backward-compatible alias during migration.
+ */
+export type ActiveEntrySelection = Readonly<{
+    position?: number;
+    /** @deprecated Prefer `position`. */
+    index?: number;
+    fullUrl?: string;
+}>;
+/**
+ * Generic upsert contract for one bundle entry stored in memory.
+ */
+export type UpsertEntryInput = Readonly<{
+    resourceType: string;
+    claims: Record<string, unknown>;
+    type?: string;
+    fullUrl?: string;
+    request?: BundleRequest;
+}>;
+/**
+ * Reusable resource-specific upsert contract used by typed session helpers.
+ */
+export type UpsertClaimsResourceEntryInput<TClaims extends object = Record<string, unknown>> = Readonly<{
+    claims: TClaims;
+    type?: string;
+    fullUrl?: string;
+    request?: BundleRequest;
+}>;
+/**
+ * Input for adding one linked `DocumentReference` to the current active entry.
+ */
+export type AddContainedDocumentToActiveEntryInput = Readonly<{
+    identifier?: string;
+    fullUrl?: string;
+    claims?: Record<string, unknown>;
+    attachmentContentType?: string;
+    attachmentDataBase64?: string;
+    attachmentUrl?: string;
+    description?: string;
+    date?: string;
+    language?: string;
+}>;
+/**
+ * Canonical target kinds for consent access editing.
+ */
+export declare const ConsentEditorTargetKinds: Readonly<{
+    readonly Section: "section";
+    readonly ResourceType: "resource-type";
+}>;
+export type ConsentEditorTargetKind = typeof ConsentEditorTargetKinds[keyof typeof ConsentEditorTargetKinds];
+/**
+ * Canonical operation scope codes for consent access editing.
+ */
+export declare const ConsentEditorScopeCodes: Readonly<{
+    readonly Search: "s";
+    readonly Read: "r";
+    readonly Create: "c";
+    readonly Update: "u";
+    readonly Delete: "d";
+}>;
+export type ConsentEditorScopeCode = typeof ConsentEditorScopeCodes[keyof typeof ConsentEditorScopeCodes];
+/**
+ * One classified scope attached to a consent target.
+ */
+export type ConsentEditorClassifiedScope = Readonly<{
+    code: ConsentEditorScopeCode;
+    display?: string;
+}>;
+/**
+ * One classified target entry shown to consent-editing callers.
+ */
+export type ConsentEditorClassifiedTarget = Readonly<{
+    target: Readonly<{
+        kind: ConsentEditorTargetKind;
+        code: string;
+        display?: string;
+        sectionFamily?: HealthcareCanonicalSectionFamily;
+    }>;
+    scopes: readonly ConsentEditorClassifiedScope[];
+}>;
+/**
+ * Classified actor role resolved from canonical healthcare role catalogs.
+ */
+export type ConsentEditorClassifiedActorRole = Readonly<{
+    codingSystem: string;
+    code: string;
+    display?: string;
+}>;
+/**
+ * Role kind used in consent role classification.
+ *
+ * The underlying catalog still comes from `HealthcareRoleFamily`, but this
+ * editor-level view intentionally names the field `kind` instead of `family`
+ * to avoid leaking `individual-organization` terminology into generic consent
+ * editing flows.
+ */
+export type ConsentEditorClassifiedRoleKind = HealthcareRoleFamily;
+/**
+ * Classified role entry exposed by the consent editor.
+ */
+export type ConsentEditorClassifiedRole = Readonly<{
+    kind?: ConsentEditorClassifiedRoleKind;
+    codingSystem: string;
+    code: string;
+    display?: string;
+    definition?: string;
+}>;
+/**
+ * Role buckets exposed by the consent editor.
+ */
+export type ConsentEditorClassifiedRoles = Readonly<{
+    professional: readonly ConsentEditorClassifiedRole[];
+    relationship: readonly ConsentEditorClassifiedRole[];
+    legalRepresentative: readonly ConsentEditorClassifiedRole[];
+    other: readonly ConsentEditorClassifiedRole[];
+}>;
+export type ConsentEditorClassifiedDepartment = Readonly<{
+    code: string;
+    display?: string;
+}>;
+export type ConsentEditorClassifiedLocation = Readonly<{
+    code: string;
+    display?: string;
+}>;
+export type ConsentEditorClassifiedOrganization = Readonly<{
+    domain: string;
+    display?: string;
+    departments: readonly ConsentEditorClassifiedDepartment[];
+    locations: readonly ConsentEditorClassifiedLocation[];
+}>;
+export type ConsentEditorClassifiedJurisdiction = Readonly<{
+    code: string;
+    display?: string;
+}>;
+export type ConsentEditorClassifiedUser = Readonly<{
+    email?: string;
+    phone?: string;
+    role?: ConsentEditorClassifiedActorRole;
+}>;
+export type ConsentEditorClassifiedActors = Readonly<{
+    jurisdictions: readonly ConsentEditorClassifiedJurisdiction[];
+    organizations: readonly ConsentEditorClassifiedOrganization[];
+    users: readonly ConsentEditorClassifiedUser[];
+}>;
+export type ConsentEditorClassifiedPurpose = Readonly<{
+    code: string;
+    display?: string;
+}>;
+/**
+ * Normalized consent view model exposed by the editor.
+ */
+export type ConsentViewModel = Readonly<{
+    fullUrl?: string;
+    identifier: string;
+    subject: string;
+    decision: string;
+    classifiedActors: ConsentEditorClassifiedActors;
+    classifiedRoles: ConsentEditorClassifiedRoles;
+    classifiedPurposes: readonly ConsentEditorClassifiedPurpose[];
+    classifiedTargets: readonly ConsentEditorClassifiedTarget[];
+}>;

package/dist/models/communication-attached-bundle-session.js

@@ -0,0 +1,34 @@
+// Copyright 2026 Conectate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+import { Format } from '../constants/Schemas.js';
+/**
+ * Canonical `@context` for outer `Communication` claim payloads.
+ *
+ * Rationale:
+ * - the outer container is materialized as one FHIR `Communication` resource
+ * - the inner `resource.meta.claims` rows stay version-agnostic and therefore
+ *   use `FHIR_API`
+ */
+export const CommunicationAttachmentClaimsContext = Format.FHIR_R4;
+/**
+ * Canonical `@context` for bundle entry `resource.meta.claims`.
+ *
+ * These claims are intended to stay version-agnostic across FHIR releases.
+ */
+export const BundleEntryClaimsContext = Format.FHIR_API;
+/**
+ * Canonical target kinds for consent access editing.
+ */
+export const ConsentEditorTargetKinds = Object.freeze({
+    Section: 'section',
+    ResourceType: 'resource-type',
+});
+/**
+ * Canonical operation scope codes for consent access editing.
+ */
+export const ConsentEditorScopeCodes = Object.freeze({
+    Search: 's',
+    Read: 'r',
+    Create: 'c',
+    Update: 'u',
+    Delete: 'd',
+});

package/dist/models/index.d.ts

@@ -6,6 +6,7 @@ export * from './comm';
 export * from './clinical-sections';
 export * from './clinical-sections.en';
 export * from './clinical-workbook-summary';
+export * from './communication-attached-bundle-session';
 export * from './confidential-job';
 export * from './confidential-message';
 export * from './confidential-storage';
@@ -22,6 +23,7 @@ export * from './interoperable-claims';
 export * from './indexing';
 export * from './identity-bootstrap';
 export * from './individual-onboarding';
+export * from './inter-tenant-access-contract';
 export * from './issue';
 export * from './jsonapi';
 export * from './jwe';
@@ -35,6 +37,7 @@ export * from './oidc4ida.electronicRecord.model';
 export * from './oidc4ida.evidence.model';
 export * from './openid-device';
 export * from './permission-templates';
+export * from './profile-manager';
 export * from './operation-outcome';
 export * from './params';
 export * from './permission-templates';
@@ -43,3 +46,4 @@ export * from './relationship-access';
 export * from './response';
 export * from './urlPath';
 export * from './verifiable-credential';
+export * from './wallet';

package/dist/models/index.js

@@ -6,6 +6,7 @@ export * from './comm.js';
 export * from './clinical-sections.js';
 export * from './clinical-sections.en.js';
 export * from './clinical-workbook-summary.js';
+export * from './communication-attached-bundle-session.js';
 export * from './confidential-job.js';
 export * from './confidential-message.js';
 export * from './confidential-storage.js';
@@ -22,6 +23,7 @@ export * from './interoperable-claims.js';
 export * from './indexing.js';
 export * from './identity-bootstrap.js';
 export * from './individual-onboarding.js';
+export * from './inter-tenant-access-contract.js';
 export * from './issue.js';
 export * from './jsonapi.js';
 export * from './jwe.js';
@@ -35,6 +37,7 @@ export * from './oidc4ida.electronicRecord.model.js';
 export * from './oidc4ida.evidence.model.js';
 export * from './openid-device.js';
 export * from './permission-templates.js';
+export * from './profile-manager.js';
 export * from './operation-outcome.js';
 export * from './params.js';
 export * from './permission-templates.js';
@@ -43,3 +46,4 @@ export * from './relationship-access.js';
 export * from './response.js';
 export * from './urlPath.js';
 export * from './verifiable-credential.js';
+export * from './wallet.js';

package/dist/models/inter-tenant-access-contract.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Canonical flat claim keys used when a frontend captures an inter-tenant
+ * access contract form and sends it to a backend before the final FHIR
+ * `Contract` resource is assembled.
+ *
+ * Notes:
+ * - these keys are claims-first transport helpers, not the legal source of
+ *   truth
+ * - the canonical legal payload is the FHIR `Contract` placed in
+ *   `credentialSubject` of the emitted VC
+ * - custom flat keys are used only where base FHIR does not define a simple
+ *   one-claim scalar path suitable for UI transport
+ */
+export declare enum ClaimInterTenantAccessContract {
+    /** Stable business identifier of the agreement/contract. */
+    identifier = "Contract.identifier",
+    /** FHIR Contract lifecycle status, for example `executed` or `amended`. */
+    status = "Contract.status",
+    /** When the agreement was formally issued. */
+    issued = "Contract.issued",
+    /** Agreement validity start date/time. */
+    appliesStart = "Contract.applies-start",
+    /** Agreement validity end date/time. */
+    appliesEnd = "Contract.applies-end",
+    /**
+     * Provider organization DID.
+     *
+     * Meaning for programmers:
+     * - this is the tenant that owns/exposes the protected data
+     * - in the current example this is `did:web:api.acme.org`
+     */
+    providerOrganization = "Contract.provider-organization",
+    /**
+     * Consumer organization DID.
+     *
+     * Meaning for programmers:
+     * - this is the foreign tenant requesting access under the agreement
+     * - in the current example this is `did:web:api.lab.org`
+     */
+    consumerOrganization = "Contract.consumer-organization",
+    /**
+     * DID of the controller who signed on behalf of the provider organization.
+     */
+    providerController = "Contract.provider-controller",
+    /**
+     * DID of the controller who signed on behalf of the consumer organization.
+     */
+    consumerController = "Contract.consumer-controller",
+    /**
+     * Allowed operational capability, expressed with the same vocabulary used by
+     * GW service capabilities and SMART-like root scopes.
+     *
+     * Example:
+     * - `organization/Composition.rs`
+     */
+    capability = "Contract.security-label",
+    /**
+     * Allowed business/legal purpose for the access.
+     *
+     * Example:
+     * - `RESEARCH`
+     */
+    purpose = "Contract.term-type",
+    /**
+     * External instantiated artifact for the agreement, typically the signed PDF
+     * or CID/URL of the contract itself plus direct contractual annexes.
+     *
+     * Canonical FHIR field:
+     * - `Contract.instantiatesUri`
+     *
+     * Flat claim rule in this stack:
+     * - use FHIR-style `instantiates-uri` in claims, then map it to
+     *   `instantiatesUri` in the actual FHIR resource object
+     */
+    instantiatesUri = "Contract.instantiates-uri"
+}
+export type InterTenantAccessContractClaims = Partial<Record<ClaimInterTenantAccessContract, string>>;
+export type InterTenantAccessContractSummary = Readonly<{
+    identifier?: string;
+    status?: string;
+    issued?: string;
+    appliesStart?: string;
+    appliesEnd?: string;
+    providerOrganizationDid?: string;
+    consumerOrganizationDid?: string;
+    providerControllerDid?: string;
+    consumerControllerDid?: string;
+    capabilities: readonly string[];
+    purposes: readonly string[];
+}>;
+export type InterTenantAccessContractMatchCriteria = Readonly<{
+    providerOrganizationDid: string;
+    consumerOrganizationDid: string;
+    requiredCapabilities?: readonly string[];
+    purpose?: string;
+    now?: string | Date;
+}>;
+export type InterTenantContractAuthorizationConsentCriteria = Readonly<{
+    consumerOrganizationDid: string;
+    actorIdentifier: string;
+    actorRole?: string;
+    requiredCapabilities?: readonly string[];
+    purpose?: string;
+    now?: string | Date;
+}>;