gdc-common-utils-ts 1.14.13 → 1.14.15

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

@@ -0,0 +1,191 @@
+import { BundleEntry, BundleJsonApi, BundleRequest } from '../models/bundle';
+import { type BundleResourceIdFilters } from './bundle-query';
+import { type MedicationStatementClaimsFlat } from '../models/interoperable-claims/medication-statement-claims';
+export type CommunicationAttachedBundleSessionMode = 'strict' | 'normalize';
+export type CommunicationAttachedBundleSessionOptions = Readonly<{
+    communicationClaims?: Record<string, unknown>;
+    initialBundle?: BundleJsonApi<BundleEntry>;
+    mode?: CommunicationAttachedBundleSessionMode;
+}>;
+export type ActiveEntrySelection = Readonly<{
+    index?: number;
+    fullUrl?: string;
+}>;
+export type UpsertEntryInput = Readonly<{
+    resourceType: string;
+    claims: Record<string, unknown>;
+    type?: string;
+    fullUrl?: string;
+    request?: BundleRequest;
+}>;
+export type AddContainedDocumentToActiveEntryInput = Readonly<{
+    identifier?: string;
+    fullUrl?: string;
+    claims?: Record<string, unknown>;
+    attachmentContentType?: string;
+    attachmentDataBase64?: string;
+    attachmentUrl?: string;
+    description?: string;
+    date?: string;
+    language?: string;
+}>;
+/**
+ * Communication editing session with bundle-in-memory as source of truth.
+ *
+ * Design contract:
+ * - `activeEntry` is the real editing unit (not only `activeResource`), because
+ *   it can include `fullUrl`, `request`, and entry-level context.
+ * - `Communication.content-attachment-data` is always derived from the
+ *   in-memory bundle after each committed update.
+ * - saving can release active entry memory via `saveAndReleaseActiveEntry()`.
+ */
+export declare class CommunicationAttachedBundleSession {
+    private communicationClaims;
+    private bundleInMemory;
+    private activeEntryIndex;
+    private mode;
+    constructor(options?: CommunicationAttachedBundleSessionOptions);
+    /** Returns a deep copy of communication claims. */
+    getCommunicationClaims(): Record<string, unknown>;
+    /** Returns a deep copy of the current in-memory bundle. */
+    getBundleInMemory(): BundleJsonApi<BundleEntry>;
+    /** Returns the active entry index, or null when no entry is selected. */
+    getActiveEntryIndex(): number | null;
+    /** Returns a deep copy of the active entry when selected. */
+    getActiveEntry(): BundleEntry | null;
+    /** Selects an active entry by index or fullUrl. */
+    selectActiveEntry(selection: ActiveEntrySelection): this;
+    /** Clears active entry selection from memory. */
+    clearActiveEntry(): this;
+    /**
+     * Upserts an entry in bundle memory and marks it as active.
+     * Matching priority: `fullUrl` if present, then resource claim identifier.
+     */
+    upsertActiveEntry(input: UpsertEntryInput): this;
+    /**
+     * Consent-first helper for developer onboarding.
+     *
+     * Expected keys should come from `ClaimConsent` in caller code.
+     */
+    upsertActiveConsentEntry(input: Readonly<{
+        claims: Record<string, unknown>;
+        fullUrl?: string;
+        type?: string;
+        request?: BundleRequest;
+    }>): this;
+    /**
+     * MedicationStatement helper for IPS-in-Communication use cases.
+     *
+     * Expected keys should come from MedicationStatement claims constants.
+     */
+    upsertActiveMedicationStatementEntry(input: Readonly<{
+        claims: MedicationStatementClaimsFlat | Record<string, unknown>;
+        fullUrl?: string;
+        type?: string;
+        request?: BundleRequest;
+    }>): this;
+    /**
+     * DocumentReference helper for bundle-contained attachments linked from
+     * other clinical resources through `*.contained-documents`.
+     */
+    upsertActiveDocumentReferenceEntry(input: Readonly<{
+        claims: Record<string, unknown>;
+        fullUrl?: string;
+        type?: string;
+        request?: BundleRequest;
+    }>): this;
+    /**
+     * Condition helper for IPS-in-Communication use cases.
+     *
+     * Expected keys should come from Condition claims constants.
+     */
+    upsertActiveConditionEntry(input: Readonly<{
+        claims: Record<string, unknown>;
+        fullUrl?: string;
+        type?: string;
+        request?: BundleRequest;
+    }>): this;
+    /**
+     * AllergyIntolerance helper for IPS-in-Communication use cases.
+     *
+     * Expected keys should come from AllergyIntolerance claims constants.
+     */
+    upsertActiveAllergyIntoleranceEntry(input: Readonly<{
+        claims: Record<string, unknown>;
+        fullUrl?: string;
+        type?: string;
+        request?: BundleRequest;
+    }>): this;
+    /**
+     * TODO(ips-next):
+     * Add `upsertActiveDiagnosticReportEntry(...)` once the shared claim helpers
+     * for `DiagnosticReport` are in place.
+     *
+     * Expected shape should mirror the existing resource helpers:
+     * - `claims` authored with `@context = org.hl7.fhir.api`
+     * - matching priority by `DiagnosticReport.identifier`
+     * - support for linked `DocumentReference` ids through
+     *   `DiagnosticReport.contained-documents`
+     *
+     * Intentionally not implemented in this pass:
+     * - IPS authoring already works for the currently documented resources
+     * - GW Core can already consume bundle-contained `DocumentReference` rows
+     * - adding the DiagnosticReport editing surface now would expand the IPS
+     *   contract further than intended for this release slice
+     */
+    /**
+     * Creates or updates a linked `DocumentReference` entry and stores its
+     * identifier under the active resource `*.contained-documents` claim.
+     */
+    addContainedDocumentToActiveEntry(input: AddContainedDocumentToActiveEntryInput): this;
+    /**
+     * Patches active entry `resource.meta.claims` and synchronizes attachment data.
+     */
+    patchActiveEntryClaims(claimPatch: Record<string, unknown>): this;
+    /**
+     * Persists current memory state into communication claims attachment.
+     * No-op for active entry pointer.
+     */
+    saveActiveEntry(): this;
+    /**
+     * Persists and releases active entry memory pointer.
+     * This is the recommended step after a successful save operation.
+     */
+    saveAndReleaseActiveEntry(): this;
+    /**
+     * Returns stable resource IDs from bundle entries with optional filters.
+     */
+    getResourceIds(filters?: BundleResourceIdFilters): string[];
+    /**
+     * Returns bundle entries matching resource IDs produced by `getResourceIds`.
+     */
+    getResourceEntriesByIds(resourceIds: readonly string[]): BundleEntry[];
+    /**
+     * Resolves the entry URL (`fullUrl`) for a given entry/resource identifier.
+     */
+    getEntryUrl(entryId: string): string | undefined;
+    private decodeBundleFromClaims;
+    private syncAttachmentFromBundle;
+    private resolveCurrentSubject;
+    private findUpsertIndex;
+    private resolveEntryIdentifier;
+    private createBundleEntry;
+    private resolveEntryCanonicalIdValue;
+    private assertEntryIndex;
+}
+/**
+ * High-level consent-access editor alias for onboarding and app-facing code.
+ *
+ * This keeps the business intent explicit for developers who are editing
+ * Consent access rules inside a Communication-carried bundle and should not
+ * need to start from the lower-level generic session name.
+ */
+export declare class ConsentAccessEditor extends CommunicationAttachedBundleSession {
+}
+/**
+ * High-level factory for consent-access editing.
+ *
+ * Prefer this name in onboarding docs when the developer intent is:
+ * "edit a Consent access bundle carried by a Communication".
+ */
+export declare function createConsentAccessEditor(options?: CommunicationAttachedBundleSessionOptions): ConsentAccessEditor;