@fhirfly-io/shl 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,765 @@
+import { S as SHLOptions, a as SHLResult, b as SHLStorage, M as Manifest, c as ManifestEntry, d as SHLAttachment, e as SHLMetadata } from './types-yk0mDByJ.cjs';
+import { L as LocalStorage, a as LocalStorageConfig, S as S3Storage, b as S3StorageConfig } from './storage-CHi9vLD_.cjs';
+
+/**
+ * Shared FHIR R4 datatypes used across IPS bundle construction.
+ *
+ * These types cover the subset of R4 datatypes needed for Patient resources
+ * and IPS document generation. All coded fields use string literal unions.
+ */
+/** FHIR Coding element — a code from a terminology system. */
+interface Coding {
+    system?: string;
+    version?: string;
+    code?: string;
+    display?: string;
+}
+/** FHIR CodeableConcept — a set of codes with optional text. */
+interface CodeableConcept {
+    coding?: Coding[];
+    text?: string;
+}
+/** FHIR HumanName — a name of a person. */
+interface HumanName {
+    use?: "usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden";
+    text?: string;
+    family?: string;
+    given?: string[];
+    prefix?: string[];
+    suffix?: string[];
+}
+/** FHIR Address — a postal/physical address. */
+interface Address {
+    use?: "home" | "work" | "temp" | "old" | "billing";
+    type?: "postal" | "physical" | "both";
+    text?: string;
+    line?: string[];
+    city?: string;
+    district?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+/** FHIR ContactPoint — phone, email, or other contact mechanism. */
+interface ContactPoint {
+    system?: "phone" | "fax" | "email" | "pager" | "url" | "sms" | "other";
+    value?: string;
+    use?: "home" | "work" | "temp" | "old" | "mobile";
+    rank?: number;
+}
+/** FHIR Identifier — a business identifier for an entity. */
+interface Identifier {
+    use?: "usual" | "official" | "temp" | "secondary" | "old";
+    system?: string;
+    value?: string;
+}
+/** FHIR Reference — a reference to another resource. */
+interface Reference {
+    reference?: string;
+    display?: string;
+}
+/** FHIR Period — a time range. */
+interface Period {
+    start?: string;
+    end?: string;
+}
+/** FHIR R4 administrative gender values. */
+type AdministrativeGender = "male" | "female" | "other" | "unknown";
+
+/**
+ * Shorthand patient input for simple cases (90% of use).
+ *
+ * Use `given` + `family` for structured name, or `name` as a text string.
+ *
+ * @example
+ * ```ts
+ * new IPS.Bundle({
+ *   given: "Jane",
+ *   family: "Doe",
+ *   birthDate: "1990-01-15",
+ *   gender: "female",
+ * });
+ * ```
+ */
+interface PatientShorthand {
+    /** Given (first) name — mutually exclusive with `name` */
+    given?: string;
+    /** Family (last) name — mutually exclusive with `name` */
+    family?: string;
+    /** Full name as text (e.g., "Dr. Jane Q. Doe III") — mutually exclusive with given/family */
+    name?: string;
+    /** Date of birth in YYYY-MM-DD format (required for IPS) */
+    birthDate: string;
+    /** Administrative gender */
+    gender?: AdministrativeGender;
+    /** Phone number */
+    phone?: string;
+    /** Email address */
+    email?: string;
+    /** Patient identifier — plain string or { system, value } */
+    identifier?: string | {
+        system: string;
+        value: string;
+    };
+}
+/**
+ * Full FHIR-shaped patient input for complex cases.
+ *
+ * Arrays for all 0..* fields. Discriminated from shorthand by
+ * `Array.isArray(input.name)`.
+ *
+ * @example
+ * ```ts
+ * new IPS.Bundle({
+ *   name: [{ use: "official", given: ["Jane"], family: "Doe" }],
+ *   birthDate: "1990-01-15",
+ *   gender: "female",
+ * });
+ * ```
+ */
+interface PatientFull {
+    /** Patient name(s) — array of HumanName (discriminant: Array.isArray) */
+    name: HumanName[];
+    /** Date of birth in YYYY-MM-DD format (required for IPS) */
+    birthDate: string;
+    /** Administrative gender */
+    gender?: AdministrativeGender;
+    /** Patient identifier(s) */
+    identifier?: Identifier[];
+    /** Contact information */
+    telecom?: ContactPoint[];
+    /** Address(es) */
+    address?: Address[];
+    /** Whether this patient record is active */
+    active?: boolean;
+    /** Deceased indicator — boolean or dateTime string */
+    deceased?: boolean | string;
+    /** Marital status */
+    maritalStatus?: CodeableConcept;
+    /** General practitioner(s) */
+    generalPractitioner?: Reference[];
+    /** Communication preferences */
+    communication?: PatientCommunication[];
+    /** Contact parties (next of kin, emergency contacts) */
+    contact?: PatientContact[];
+}
+/** Patient communication preference. */
+interface PatientCommunication {
+    /** Language as a CodeableConcept (e.g., BCP-47 coding) */
+    language: CodeableConcept;
+    /** Whether this is the preferred language */
+    preferred?: boolean;
+}
+/** Patient contact party (next of kin, emergency contact). */
+interface PatientContact {
+    /** Relationship to the patient */
+    relationship?: CodeableConcept[];
+    /** Contact name */
+    name?: HumanName;
+    /** Contact information */
+    telecom?: ContactPoint[];
+    /** Contact address */
+    address?: Address;
+    /** Administrative gender of the contact */
+    gender?: AdministrativeGender;
+}
+/**
+ * Union type for patient input — accepts shorthand or full FHIR-shaped input.
+ *
+ * Discriminant: `Array.isArray(input.name)` — shorthand has `name?: string`,
+ * full has `name: HumanName[]`.
+ */
+type PatientDemographics = PatientShorthand | PatientFull;
+/**
+ * Options for building an IPS bundle.
+ */
+interface BuildOptions {
+    /** FHIR profile to validate against */
+    profile: "ips" | "r4";
+    /** Bundle identifier (auto-generated if not provided) */
+    bundleId?: string;
+    /** Composition date (defaults to now) */
+    compositionDate?: string;
+}
+/**
+ * Result of IPS bundle validation.
+ */
+interface ValidationResult {
+    /** Whether the bundle is valid */
+    valid: boolean;
+    /** Validation issues found */
+    issues: ValidationIssue[];
+}
+/**
+ * A single validation issue.
+ */
+interface ValidationIssue {
+    /** Severity of the issue */
+    severity: "error" | "warning" | "information";
+    /** Human-readable description */
+    message: string;
+    /** FHIRPath expression to the element */
+    path?: string;
+}
+/**
+ * Duck-typed interface for a FHIRfly API client.
+ *
+ * Any object matching this shape works — including `@fhirfly-io/terminology`
+ * or a hand-crafted mock. The SDK does NOT import that package.
+ */
+interface FhirflyClient {
+    ndc: {
+        lookup(code: string, options?: {
+            shape?: string;
+        }): Promise<{
+            data: {
+                ndc: string;
+                product_name: string;
+                generic_name?: string;
+                dosage_form?: string;
+                route?: string;
+                active_ingredients: Array<{
+                    name: string;
+                    strength?: string;
+                    unit?: string;
+                }>;
+                snomed?: Array<{
+                    concept_id: string;
+                    display?: string;
+                    map_type?: string;
+                }>;
+            };
+        }>;
+    };
+    rxnorm: {
+        lookup(rxcui: string, options?: {
+            shape?: string;
+        }): Promise<{
+            data: {
+                rxcui: string;
+                name: string;
+                tty: string;
+                snomed?: Array<{
+                    concept_id: string;
+                    display?: string;
+                    map_type?: string;
+                }>;
+            };
+        }>;
+    };
+    snomed: {
+        lookup(conceptId: string): Promise<{
+            data: {
+                concept_id: string;
+                preferred_term: string | null;
+                fsn: string | null;
+                ips_category: string | null;
+            };
+        }>;
+    };
+    icd10: {
+        lookup(code: string, options?: {
+            shape?: string;
+        }): Promise<{
+            data: {
+                code: string;
+                display: string;
+                snomed?: Array<{
+                    concept_id: string;
+                    display?: string;
+                    map_type?: string;
+                }>;
+            };
+        }>;
+    };
+    cvx: {
+        lookup(cvxCode: string, options?: {
+            shape?: string;
+        }): Promise<{
+            data: {
+                code: string;
+                display: string;
+                full_vaccine_name: string | null;
+            };
+        }>;
+    };
+}
+/** Medication status values for MedicationStatement */
+type MedicationStatus = "active" | "completed" | "stopped" | "on-hold";
+/** Add a medication by NDC code. Requires FHIRfly API for enrichment. */
+interface MedicationByNDC {
+    byNDC: string;
+    fhirfly: FhirflyClient;
+    status?: MedicationStatus;
+    dosageText?: string;
+    effectiveDate?: string;
+    byRxNorm?: never;
+    bySNOMED?: never;
+    fromResource?: never;
+    code?: never;
+}
+/** Add a medication by RxNorm CUI. Requires FHIRfly API for enrichment. */
+interface MedicationByRxNorm {
+    byRxNorm: string;
+    fhirfly: FhirflyClient;
+    status?: MedicationStatus;
+    dosageText?: string;
+    effectiveDate?: string;
+    byNDC?: never;
+    bySNOMED?: never;
+    fromResource?: never;
+    code?: never;
+}
+/** Add a medication by SNOMED CT code. API optional (used for preferred_term lookup). */
+interface MedicationBySNOMED {
+    bySNOMED: string;
+    display?: string;
+    fhirfly?: FhirflyClient;
+    status?: MedicationStatus;
+    dosageText?: string;
+    effectiveDate?: string;
+    byNDC?: never;
+    byRxNorm?: never;
+    fromResource?: never;
+    code?: never;
+}
+/** Pass through an existing MedicationStatement or MedicationRequest resource. */
+interface MedicationFromResource {
+    fromResource: Record<string, unknown>;
+    fhirfly?: FhirflyClient;
+    byNDC?: never;
+    byRxNorm?: never;
+    bySNOMED?: never;
+    code?: never;
+}
+/** Manual medication input with code, system, and display. */
+interface MedicationManual {
+    code: string;
+    system: string;
+    display: string;
+    status?: MedicationStatus;
+    dosageText?: string;
+    effectiveDate?: string;
+    byNDC?: never;
+    byRxNorm?: never;
+    bySNOMED?: never;
+    fromResource?: never;
+    fhirfly?: never;
+}
+/** Union of all medication input variants. */
+type MedicationOptions = MedicationByNDC | MedicationByRxNorm | MedicationBySNOMED | MedicationFromResource | MedicationManual;
+/** Clinical status values for Condition */
+type ConditionClinicalStatus = "active" | "recurrence" | "relapse" | "inactive" | "remission" | "resolved";
+/** Add a condition by ICD-10-CM code. Requires FHIRfly API for enrichment. */
+interface ConditionByICD10 {
+    byICD10: string;
+    fhirfly: FhirflyClient;
+    clinicalStatus?: ConditionClinicalStatus;
+    onsetDate?: string;
+    bySNOMED?: never;
+    fromResource?: never;
+    code?: never;
+}
+/** Add a condition by SNOMED CT code. API optional (used for preferred_term lookup). */
+interface ConditionBySNOMED {
+    bySNOMED: string;
+    display?: string;
+    fhirfly?: FhirflyClient;
+    clinicalStatus?: ConditionClinicalStatus;
+    onsetDate?: string;
+    byICD10?: never;
+    fromResource?: never;
+    code?: never;
+}
+/** Pass through an existing Condition resource. */
+interface ConditionFromResource {
+    fromResource: Record<string, unknown>;
+    fhirfly?: FhirflyClient;
+    byICD10?: never;
+    bySNOMED?: never;
+    code?: never;
+}
+/** Manual condition input with code, system, and display. */
+interface ConditionManual {
+    code: string;
+    system: string;
+    display: string;
+    clinicalStatus?: ConditionClinicalStatus;
+    onsetDate?: string;
+    byICD10?: never;
+    bySNOMED?: never;
+    fromResource?: never;
+    fhirfly?: never;
+}
+/** Union of all condition input variants. */
+type ConditionOptions = ConditionByICD10 | ConditionBySNOMED | ConditionFromResource | ConditionManual;
+/** Clinical status values for AllergyIntolerance */
+type AllergyClinicalStatus = "active" | "inactive" | "resolved";
+/** Add an allergy by SNOMED CT code. API optional (used for preferred_term lookup). */
+interface AllergyBySNOMED {
+    bySNOMED: string;
+    display?: string;
+    fhirfly?: FhirflyClient;
+    clinicalStatus?: AllergyClinicalStatus;
+    criticality?: "low" | "high" | "unable-to-assess";
+    fromResource?: never;
+    code?: never;
+}
+/** Pass through an existing AllergyIntolerance resource. */
+interface AllergyFromResource {
+    fromResource: Record<string, unknown>;
+    fhirfly?: FhirflyClient;
+    bySNOMED?: never;
+    code?: never;
+}
+/** Manual allergy input with code, system, and display. */
+interface AllergyManual {
+    code: string;
+    system: string;
+    display: string;
+    clinicalStatus?: AllergyClinicalStatus;
+    criticality?: "low" | "high" | "unable-to-assess";
+    bySNOMED?: never;
+    fromResource?: never;
+    fhirfly?: never;
+}
+/** Union of all allergy input variants. */
+type AllergyOptions = AllergyBySNOMED | AllergyFromResource | AllergyManual;
+/** Add an immunization by CVX code. Requires FHIRfly API for enrichment. */
+interface ImmunizationByCVX {
+    byCVX: string;
+    fhirfly: FhirflyClient;
+    status?: "completed" | "not-done";
+    occurrenceDate?: string;
+    fromResource?: never;
+    code?: never;
+}
+/** Pass through an existing Immunization resource. */
+interface ImmunizationFromResource {
+    fromResource: Record<string, unknown>;
+    fhirfly?: FhirflyClient;
+    byCVX?: never;
+    code?: never;
+}
+/** Manual immunization input with code, system, and display. */
+interface ImmunizationManual {
+    code: string;
+    system: string;
+    display: string;
+    status?: "completed" | "not-done";
+    occurrenceDate?: string;
+    byCVX?: never;
+    fromResource?: never;
+    fhirfly?: never;
+}
+/** Union of all immunization input variants. */
+type ImmunizationOptions = ImmunizationByCVX | ImmunizationFromResource | ImmunizationManual;
+
+/**
+ * Builder for creating IPS (International Patient Summary) FHIR bundles.
+ *
+ * @example
+ * ```ts
+ * const bundle = new IPS.Bundle({
+ *   given: "Jane",
+ *   family: "Doe",
+ *   birthDate: "1990-01-15",
+ *   gender: "female",
+ * });
+ *
+ * bundle.addMedication({
+ *   code: "860975",
+ *   system: "http://www.nlm.nih.gov/research/umls/rxnorm",
+ *   display: "Metformin 500 MG Oral Tablet",
+ *   status: "active",
+ * });
+ *
+ * const fhirBundle = await bundle.build({ profile: "ips" });
+ * ```
+ */
+declare class Bundle {
+    private readonly _patient;
+    private readonly _medications;
+    private readonly _allergies;
+    private readonly _conditions;
+    private readonly _immunizations;
+    private readonly _warnings;
+    private _buildWarnings;
+    constructor(patient: PatientDemographics);
+    /** Returns the patient demographics for this bundle. */
+    get patient(): PatientDemographics;
+    /** Returns all warnings collected from add-time and build-time. */
+    get warnings(): readonly ValidationIssue[];
+    /**
+     * Add a medication statement to the IPS bundle.
+     *
+     * Throws immediately for `fromResource` with wrong resourceType.
+     * All other validation happens at build time.
+     */
+    addMedication(medication: MedicationOptions): this;
+    /**
+     * Add an allergy/intolerance to the IPS bundle.
+     *
+     * Throws immediately for `fromResource` with wrong resourceType.
+     */
+    addAllergy(allergy: AllergyOptions): this;
+    /**
+     * Add a condition/problem to the IPS bundle.
+     *
+     * Throws immediately for `fromResource` with wrong resourceType.
+     */
+    addCondition(condition: ConditionOptions): this;
+    /**
+     * Add an immunization to the IPS bundle.
+     *
+     * Throws immediately for `fromResource` with wrong resourceType.
+     */
+    addImmunization(immunization: ImmunizationOptions): this;
+    /**
+     * Build the IPS FHIR Bundle resource.
+     *
+     * Async because `byNDC`, `byRxNorm`, `byICD10`, and `byCVX` require API enrichment.
+     * If no enrichment is needed, the Promise resolves immediately.
+     *
+     * @returns A FHIR Bundle resource object
+     */
+    build(options?: BuildOptions): Promise<Record<string, unknown>>;
+    /**
+     * Validate the bundle against the specified profile.
+     *
+     * @returns Validation result with any issues found
+     */
+    validate(options?: BuildOptions): ValidationResult;
+    private hasValidName;
+    private buildComposition;
+    private buildMedicationSection;
+    private buildAllergySection;
+    private buildConditionSection;
+    private buildImmunizationSection;
+    private buildDynamicSection;
+}
+
+/** Well-known FHIR code system URIs used across IPS resource generation. */
+declare const CODE_SYSTEMS: {
+    readonly NDC: "http://hl7.org/fhir/sid/ndc";
+    readonly RXNORM: "http://www.nlm.nih.gov/research/umls/rxnorm";
+    readonly SNOMED: "http://snomed.info/sct";
+    readonly LOINC: "http://loinc.org";
+    readonly CVX: "http://hl7.org/fhir/sid/cvx";
+    readonly ICD10CM: "http://hl7.org/fhir/sid/icd-10-cm";
+    readonly CONDITION_CLINICAL: "http://terminology.hl7.org/CodeSystem/condition-clinical";
+    readonly ALLERGY_CLINICAL: "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical";
+};
+
+type index$1_Address = Address;
+type index$1_AdministrativeGender = AdministrativeGender;
+type index$1_AllergyBySNOMED = AllergyBySNOMED;
+type index$1_AllergyClinicalStatus = AllergyClinicalStatus;
+type index$1_AllergyFromResource = AllergyFromResource;
+type index$1_AllergyManual = AllergyManual;
+type index$1_AllergyOptions = AllergyOptions;
+type index$1_BuildOptions = BuildOptions;
+type index$1_Bundle = Bundle;
+declare const index$1_Bundle: typeof Bundle;
+declare const index$1_CODE_SYSTEMS: typeof CODE_SYSTEMS;
+type index$1_CodeableConcept = CodeableConcept;
+type index$1_Coding = Coding;
+type index$1_ConditionByICD10 = ConditionByICD10;
+type index$1_ConditionBySNOMED = ConditionBySNOMED;
+type index$1_ConditionClinicalStatus = ConditionClinicalStatus;
+type index$1_ConditionFromResource = ConditionFromResource;
+type index$1_ConditionManual = ConditionManual;
+type index$1_ConditionOptions = ConditionOptions;
+type index$1_ContactPoint = ContactPoint;
+type index$1_FhirflyClient = FhirflyClient;
+type index$1_HumanName = HumanName;
+type index$1_Identifier = Identifier;
+type index$1_ImmunizationByCVX = ImmunizationByCVX;
+type index$1_ImmunizationFromResource = ImmunizationFromResource;
+type index$1_ImmunizationManual = ImmunizationManual;
+type index$1_ImmunizationOptions = ImmunizationOptions;
+type index$1_MedicationByNDC = MedicationByNDC;
+type index$1_MedicationByRxNorm = MedicationByRxNorm;
+type index$1_MedicationBySNOMED = MedicationBySNOMED;
+type index$1_MedicationFromResource = MedicationFromResource;
+type index$1_MedicationManual = MedicationManual;
+type index$1_MedicationOptions = MedicationOptions;
+type index$1_MedicationStatus = MedicationStatus;
+type index$1_PatientCommunication = PatientCommunication;
+type index$1_PatientContact = PatientContact;
+type index$1_PatientDemographics = PatientDemographics;
+type index$1_PatientFull = PatientFull;
+type index$1_PatientShorthand = PatientShorthand;
+type index$1_Period = Period;
+type index$1_Reference = Reference;
+type index$1_ValidationIssue = ValidationIssue;
+type index$1_ValidationResult = ValidationResult;
+declare namespace index$1 {
+  export { type index$1_Address as Address, type index$1_AdministrativeGender as AdministrativeGender, type index$1_AllergyBySNOMED as AllergyBySNOMED, type index$1_AllergyClinicalStatus as AllergyClinicalStatus, type index$1_AllergyFromResource as AllergyFromResource, type index$1_AllergyManual as AllergyManual, type index$1_AllergyOptions as AllergyOptions, type index$1_BuildOptions as BuildOptions, index$1_Bundle as Bundle, index$1_CODE_SYSTEMS as CODE_SYSTEMS, type index$1_CodeableConcept as CodeableConcept, type index$1_Coding as Coding, type index$1_ConditionByICD10 as ConditionByICD10, type index$1_ConditionBySNOMED as ConditionBySNOMED, type index$1_ConditionClinicalStatus as ConditionClinicalStatus, type index$1_ConditionFromResource as ConditionFromResource, type index$1_ConditionManual as ConditionManual, type index$1_ConditionOptions as ConditionOptions, type index$1_ContactPoint as ContactPoint, type index$1_FhirflyClient as FhirflyClient, type index$1_HumanName as HumanName, type index$1_Identifier as Identifier, type index$1_ImmunizationByCVX as ImmunizationByCVX, type index$1_ImmunizationFromResource as ImmunizationFromResource, type index$1_ImmunizationManual as ImmunizationManual, type index$1_ImmunizationOptions as ImmunizationOptions, type index$1_MedicationByNDC as MedicationByNDC, type index$1_MedicationByRxNorm as MedicationByRxNorm, type index$1_MedicationBySNOMED as MedicationBySNOMED, type index$1_MedicationFromResource as MedicationFromResource, type index$1_MedicationManual as MedicationManual, type index$1_MedicationOptions as MedicationOptions, type index$1_MedicationStatus as MedicationStatus, type index$1_PatientCommunication as PatientCommunication, type index$1_PatientContact as PatientContact, type index$1_PatientDemographics as PatientDemographics, type index$1_PatientFull as PatientFull, type index$1_PatientShorthand as PatientShorthand, type index$1_Period as Period, type index$1_Reference as Reference, type index$1_ValidationIssue as ValidationIssue, type index$1_ValidationResult as ValidationResult };
+}
+
+/**
+ * Create a SMART Health Link from a FHIR Bundle.
+ *
+ * Encrypts the bundle, stores it using the provided storage backend,
+ * and returns a SHL URL with an embedded QR code.
+ *
+ * This implements manifest mode only (`L` flag always set).
+ * The user's server is responsible for serving the manifest and content
+ * files from the storage backend.
+ *
+ * @example
+ * ```ts
+ * const result = await SHL.create({
+ *   bundle: fhirBundle,
+ *   passcode: "1234",
+ *   expiresAt: new Date("2025-12-31"),
+ *   storage: new SHL.LocalStorage({
+ *     directory: "./shl-data",
+ *     baseUrl: "https://shl.example.com",
+ *   }),
+ * });
+ *
+ * console.log(result.url);    // shlink:/...
+ * console.log(result.qrCode); // data:image/png;base64,...
+ * ```
+ */
+declare function create(options: SHLOptions): Promise<SHLResult>;
+
+/**
+ * A decoded SMART Health Link payload.
+ *
+ * Contains all fields from the shlink:/ URL payload,
+ * parsed and ready for use.
+ */
+interface DecodedSHL {
+    /** Manifest URL — POST here to retrieve the manifest */
+    url: string;
+    /** Decryption key (32 bytes) */
+    key: Buffer;
+    /** SHL flags (e.g., "L", "LP") */
+    flag: string;
+    /** SHL version (currently always 1) */
+    v: number;
+    /** Expiration as epoch seconds (undefined if no expiration) */
+    exp?: number;
+    /** Human-readable label (max 80 chars) */
+    label?: string;
+}
+/**
+ * Decode a `shlink:/` URL into its constituent parts.
+ *
+ * Extracts the manifest URL, decryption key, flags, version,
+ * optional expiration, and optional label from the SHL payload.
+ *
+ * @example
+ * ```ts
+ * const decoded = SHL.decode("shlink:/eyJ1cmw...");
+ * // decoded.url   → "https://shl.example.com/{shlId}"
+ * // decoded.key   → Buffer (32 bytes)
+ * // decoded.flag  → "LP"
+ * // decoded.exp   → 1798761600 (or undefined)
+ * // decoded.label → "Jane's IPS" (or undefined)
+ * ```
+ */
+declare function decode(url: string): DecodedSHL;
+/**
+ * Decrypt a JWE compact serialization back to a FHIR bundle.
+ *
+ * This is a convenience wrapper around the internal `decryptBundle` function,
+ * exposed as a public API for consuming SHLs.
+ *
+ * @param jwe - JWE compact serialization string (5 dot-separated parts)
+ * @param key - 32-byte AES-256 key (from `SHL.decode().key`)
+ * @returns The decrypted FHIR bundle as a JSON object
+ *
+ * @example
+ * ```ts
+ * const decoded = SHL.decode("shlink:/eyJ1cmw...");
+ * const manifest = await fetch(decoded.url, {
+ *   method: "POST",
+ *   headers: { "content-type": "application/json" },
+ *   body: JSON.stringify({ passcode: "1234" }),
+ * }).then(r => r.json());
+ *
+ * const jwe = await fetch(manifest.files[0].location).then(r => r.text());
+ * const bundle = SHL.decrypt(jwe, decoded.key);
+ * ```
+ */
+declare function decrypt(jwe: string, key: Buffer): Record<string, unknown>;
+/**
+ * Decrypt a JWE compact serialization to raw bytes and content type.
+ *
+ * Use this for non-FHIR content (PDFs, images, etc.) where the result
+ * is binary data rather than a JSON object.
+ *
+ * @param jwe - JWE compact serialization string
+ * @param key - 32-byte AES-256 key (from `SHL.decode().key`)
+ * @returns Object with `contentType` (from JWE header) and `data` (Buffer)
+ */
+declare function decryptContent(jwe: string, key: Buffer): {
+    contentType: string;
+    data: Buffer;
+};
+
+/**
+ * Revoke a SMART Health Link by deleting all stored files.
+ *
+ * Removes the encrypted content, manifest, and metadata from storage.
+ * After revocation, the SHL URL and QR code will no longer work —
+ * viewers will receive a 404 when attempting to access the manifest.
+ *
+ * @param shlId - The SHL identifier (from `SHLResult.id`)
+ * @param storage - The storage backend where the SHL files are stored
+ */
+declare function revoke(shlId: string, storage: SHLStorage): Promise<void>;
+
+type index_DecodedSHL = DecodedSHL;
+declare const index_LocalStorage: typeof LocalStorage;
+declare const index_LocalStorageConfig: typeof LocalStorageConfig;
+declare const index_Manifest: typeof Manifest;
+declare const index_ManifestEntry: typeof ManifestEntry;
+declare const index_S3Storage: typeof S3Storage;
+declare const index_S3StorageConfig: typeof S3StorageConfig;
+declare const index_SHLAttachment: typeof SHLAttachment;
+declare const index_SHLMetadata: typeof SHLMetadata;
+declare const index_SHLOptions: typeof SHLOptions;
+declare const index_SHLResult: typeof SHLResult;
+declare const index_SHLStorage: typeof SHLStorage;
+declare const index_create: typeof create;
+declare const index_decode: typeof decode;
+declare const index_decrypt: typeof decrypt;
+declare const index_decryptContent: typeof decryptContent;
+declare const index_revoke: typeof revoke;
+declare namespace index {
+  export { type index_DecodedSHL as DecodedSHL, index_LocalStorage as LocalStorage, index_LocalStorageConfig as LocalStorageConfig, index_Manifest as Manifest, index_ManifestEntry as ManifestEntry, index_S3Storage as S3Storage, index_S3StorageConfig as S3StorageConfig, index_SHLAttachment as SHLAttachment, index_SHLMetadata as SHLMetadata, index_SHLOptions as SHLOptions, index_SHLResult as SHLResult, index_SHLStorage as SHLStorage, index_create as create, index_decode as decode, index_decrypt as decrypt, index_decryptContent as decryptContent, index_revoke as revoke };
+}
+
+/**
+ * Base error class for all SHL SDK errors.
+ */
+declare class ShlError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when IPS bundle validation fails.
+ */
+declare class ValidationError extends ShlError {
+    readonly issues: string[];
+    constructor(message: string, issues?: string[]);
+}
+/**
+ * Error thrown when a storage operation fails.
+ */
+declare class StorageError extends ShlError {
+    readonly operation: string;
+    constructor(message: string, operation: string);
+}
+/**
+ * Error thrown when encryption or decryption fails.
+ */
+declare class EncryptionError extends ShlError {
+    constructor(message: string);
+}
+
+export { EncryptionError, index$1 as IPS, index as SHL, SHLStorage, ShlError, StorageError, ValidationError };