@oystehr/sdk 4.3.8 → 4.3.10

package/dist/cjs/resources/classes/fhir-ext.cjs

@@ -195,13 +195,9 @@ function assertRetrievedResource(config, resource) {
         }
     }
 }
-/**
- * Performs a FHIR search and returns the results as a Bundle resource
- *
- * @param options FHIR resource type and FHIR search parameters
- * @param request optional OystehrClientRequest object
- * @returns FHIR Bundle resource
- */
+function isAsyncRequestMode(mode) {
+    return mode === 'async-bundle' || mode === 'async-bulk';
+}
 async function search(params, request) {
     const { resourceType } = params;
     const taggedParams = applyTagSearchParams(this.config, params.params);
@@ -215,6 +211,13 @@ async function search(params, request) {
             return acc;
         }, {});
     }
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}/_search`, 'POST', paramMap ?? {}, requestMode, {
+            ...request,
+            contentType: 'application/x-www-form-urlencoded',
+        });
+    }
     const requestBundle = await this.fhirRequest(`/${resourceType}/_search`, 'POST')(paramMap, {
         ...request,
         contentType: 'application/x-www-form-urlencoded',
@@ -228,12 +231,61 @@ async function search(params, request) {
     };
     return bundle;
 }
+/**
+ * Performs an iterative FHIR search over initial request and following "next" urls,
+ * collecting all pages into a single Bundle.
+ *
+ * @param params FHIR search parameters plus optional pageSize that will overwrite _count in params
+ * @param request optional OystehrClientRequest object
+ * @returns FHIR Bundle resource that contains all entries across all pages. Bundle-level metadata
+ * (id, meta, total, etc.) is taken from the first page.
+ */
+async function searchAndGetAllPages(params, request) {
+    const { pageSize, ...searchParams } = params;
+    let firstPageParams = searchParams;
+    if (pageSize) {
+        const baseParams = (searchParams.params ?? []).filter((p) => p.name !== '_count') ?? [];
+        firstPageParams = { ...searchParams, params: [...baseParams, { name: '_count', value: pageSize }] };
+    }
+    const allEntries = [];
+    const typedSearch = (search);
+    // search returns Bundle, and fhirRequest in the while block returns FhirBundle
+    let currentBundle = await typedSearch.call(this, firstPageParams, request);
+    const firstBundle = { ...currentBundle, link: currentBundle.link?.filter((link) => link.relation !== 'next') };
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        const entries = currentBundle.entry;
+        if (entries) {
+            allEntries.push(...entries);
+        }
+        const nextLink = currentBundle.link?.find((link) => link.relation === 'next')?.url;
+        if (!nextLink) {
+            break;
+        }
+        currentBundle = await this.fhirRequest(nextLink, 'GET')({}, request);
+    }
+    return {
+        ...firstBundle,
+        entry: allEntries.length ? allEntries : undefined,
+        unbundle: function () {
+            return this.entry?.map((e) => e.resource).filter((r) => r !== undefined) ?? [];
+        },
+    };
+}
 async function create(params, request) {
     const tagged = applyTagToResource(this.config, params);
     const { resourceType } = tagged;
-    return this.fhirRequest(`/${resourceType}`, 'POST')(tagged, request);
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}`, 'POST', tagged, requestMode, request);
+    }
+    return await this.fhirRequest(`/${resourceType}`, 'POST')(tagged, request);
 }
 async function get({ resourceType, id }, request) {
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}/${id}`, 'GET', {}, requestMode, request);
+    }
     const result = await this.fhirRequest(`/${resourceType}/${id}`, 'GET')({}, request);
     assertRetrievedResource(this.config, result);
     return result;
@@ -241,23 +293,215 @@ async function get({ resourceType, id }, request) {
 async function update(params, request) {
     const tagged = applyTagToResource(this.config, params);
     const { id, resourceType } = tagged;
-    return this.fhirRequest(`/${resourceType}/${id}`, 'PUT')(tagged, {
+    const requestMode = request?.mode;
+    const ifMatchRequest = {
         ...request,
         ifMatch: request?.optimisticLockingVersionId ? `W/"${request.optimisticLockingVersionId}"` : undefined,
-    });
+    };
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}/${id}`, 'PUT', tagged, requestMode, ifMatchRequest);
+    }
+    return await this.fhirRequest(`/${resourceType}/${id}`, 'PUT')(tagged, ifMatchRequest);
 }
 async function patch({ resourceType, id, operations }, request) {
     const taggedOperations = applyTagToPatchOperations(this.config, operations);
-    return this.fhirRequest(`/${resourceType}/${id}`, 'PATCH')(taggedOperations, {
+    const requestMode = request?.mode;
+    const ifMatchRequest = {
         ...request,
-        contentType: 'application/json-patch+json',
         ifMatch: request?.optimisticLockingVersionId ? `W/"${request.optimisticLockingVersionId}"` : undefined,
+    };
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}/${id}`, 'PATCH', taggedOperations, requestMode, {
+            ...ifMatchRequest,
+            contentType: 'application/json-patch+json',
+        });
+    }
+    return this.fhirRequest(`/${resourceType}/${id}`, 'PATCH')(taggedOperations, {
+        ...ifMatchRequest,
+        contentType: 'application/json-patch+json',
     });
 }
 async function del({ resourceType, id }, request) {
-    return this.fhirRequest(`/${resourceType}/${id}`, 'DELETE')({}, request);
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob(`/${resourceType}/${id}`, 'DELETE', {}, requestMode, request);
+    }
+    return await this.fhirRequest(`/${resourceType}/${id}`, 'DELETE')({}, request);
+}
+function getRetryDelayMs(retryAfter, fallbackMs) {
+    if (!retryAfter) {
+        return fallbackMs;
+    }
+    const asSeconds = Number(retryAfter);
+    if (Number.isFinite(asSeconds) && asSeconds >= 0) {
+        return Math.max(0, Math.floor(asSeconds * 1000));
+    }
+    const asTimestamp = Date.parse(retryAfter);
+    if (Number.isFinite(asTimestamp)) {
+        return Math.max(0, asTimestamp - Date.now());
+    }
+    return fallbackMs;
+}
+/**
+ *  Fetches the status of an async job. If the job is still in progress, returns an object with status 202. If the job is completed, returns the job result with status 200. If the job has failed, returns an object with status 500 and an OperationOutcome resource describing the failure. If the job has expired, returns an object with status 410.
+ * @param this The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.getAsyncJob(jobId)`)
+ * @param jobId The ID of the async job to fetch
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to the FhirAsyncJobStatus
+ */
+async function getAsyncJob(jobId, request) {
+    return await this.fetchAsyncJobStatus(jobId, request);
+}
+/**
+ *  Waits for an async job to complete by polling its status until it reaches a terminal state (success, failure, or expiration) or the specified timeout is reached. Returns the final job status. Throws if the job fails, expires, or does not complete within the timeout.
+ * @param this  The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.waitForAsyncJob(jobId)`)
+ * @param jobId  The ID of the async job to wait for
+ * @param options  Optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to the final FhirAsyncJobStatus
+ */
+async function waitForAsyncJob(jobId, options, request) {
+    // 5 seconds poll interval by default
+    const pollIntervalMs = options?.pollIntervalMs ?? 5000;
+    // 15 minutes timout by default
+    const timeoutMs = options?.timeoutMs ?? 900000;
+    const attempts = Math.max(1, Math.ceil(timeoutMs / pollIntervalMs));
+    for (let attempt = 0; attempt < attempts; attempt++) {
+        const status = await this.fetchAsyncJobStatus(jobId, request);
+        if (status.status !== 202) {
+            return status;
+        }
+        if (attempt < attempts - 1) {
+            const retryAfter = 'retryAfter' in status ? status.retryAfter : undefined;
+            await new Promise((resolve) => setTimeout(resolve, getRetryDelayMs(retryAfter, pollIntervalMs)));
+        }
+    }
+    throw new index.OystehrSdkError({
+        message: `Async job ${jobId} did not complete within ${timeoutMs} ms`,
+        code: 408,
+    });
+}
+function parseNdjsonResources(ndjson, sourceUrl) {
+    const resources = [];
+    const lines = ndjson.split('\n');
+    for (let index$1 = 0; index$1 < lines.length; index$1++) {
+        const line = lines[index$1].trim();
+        if (line.length === 0) {
+            continue;
+        }
+        try {
+            resources.push(JSON.parse(line));
+        }
+        catch (error) {
+            throw new index.OystehrSdkError({
+                message: `Failed to parse NDJSON line ${index$1 + 1} from ${sourceUrl}`,
+                code: 500,
+                cause: error,
+            });
+        }
+    }
+    return resources;
+}
+/**
+ *  Waits for an async job to complete and retrieves the bulk output manifest and files. Throws if the job fails, expires, or does not complete within the specified timeout.
+ * @param this  The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.waitForAsyncBulkOutput(jobId)`)
+ * @param jobId  The ID of the async job to wait for
+ * @param options  Optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to a FhirAsyncBulkOutputResult containing the bulk output manifest and files
+ */
+async function waitForAsyncBulkOutput(jobId, options, request) {
+    const status = await waitForAsyncJob.call(this, jobId, options, request);
+    if (status.status === 404) {
+        throw new index.OystehrSdkError({
+            message: `Async job ${jobId} not found`,
+            code: 404,
+        });
+    }
+    if (status.status === 410) {
+        throw new index.OystehrSdkError({
+            message: `Async job ${jobId} expired`,
+            code: 410,
+        });
+    }
+    if (status.status !== 200 || !('mode' in status) || status.mode !== 'bulk') {
+        throw new index.OystehrSdkError({
+            message: `Async job ${jobId} did not complete in bulk mode`,
+            code: status.status,
+        });
+    }
+    const accessToken = request?.accessToken ?? this.config.accessToken;
+    const projectId = request?.projectId ?? this.config.projectId;
+    if (status.manifest.requiresAccessToken && !accessToken) {
+        throw new index.OystehrSdkError({
+            message: `Bulk output for async job ${jobId} requires an access token`,
+            code: 401,
+        });
+    }
+    const fetchImpl = this.config.fetch ?? fetch;
+    const headers = {};
+    if (projectId) {
+        headers['x-zapehr-project-id'] = projectId;
+        headers['x-oystehr-project-id'] = projectId;
+    }
+    if (status.manifest.requiresAccessToken && accessToken) {
+        headers.Authorization = `Bearer ${accessToken}`;
+    }
+    const requestHeaders = Object.keys(headers).length > 0 ? headers : undefined;
+    const output = await Promise.all(status.manifest.output.map(async (file) => {
+        const response = await fetchImpl(new Request(file.url, {
+            method: 'GET',
+            headers: requestHeaders,
+        }));
+        if (!response.ok) {
+            throw new index.OystehrSdkError({
+                message: `Failed to download bulk output (${file.type}): HTTP ${response.status}`,
+                code: response.status,
+            });
+        }
+        const ndjson = await response.text();
+        return {
+            ...file,
+            resources: parseNdjsonResources(ndjson, file.url),
+        };
+    }));
+    return {
+        manifest: status.manifest,
+        output,
+    };
+}
+/**
+ * Wrapper around waitForAsyncBulkOutput that transforms the retrieved bulk output files into a single Bundle resource containing all the output resources as entries. This is a convenience method for use cases where you want to work with the bulk output as a Bundle, but it may not be efficient for large outputs due to the overhead of downloading and parsing all files and constructing the Bundle in memory.
+ * Can be slow due to downloading and parsing potentially large NDJSON files, so use only if you need the full output as a Bundle resource. For more efficient processing of large bulk outputs, use waitForAsyncBulkOutput directly.
+ * @param jobId the ID of the async job to wait for
+ * @param options optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request optional OystehrClientRequest for authentication and headers
+ * @returns a Promise that resolves to a Bundle containing all resources from the bulk output
+ */
+async function waitForAsyncBulkBundle(jobId, options, request) {
+    const bulkOutput = await waitForAsyncBulkOutput.call(this, jobId, options, request);
+    const resources = bulkOutput.output.flatMap((file) => file.resources);
+    const bundle = {
+        resourceType: 'Bundle',
+        type: 'collection',
+        entry: resources.map((resource) => ({ resource })),
+        unbundle: function () {
+            return this.entry?.map((entry) => entry.resource).filter((value) => value !== undefined) ?? [];
+        },
+    };
+    return bundle;
+}
+async function cancelAsyncJob(jobId, request) {
+    await this.fhirRequest(`/async-job/${jobId}`, 'DELETE')({}, request);
 }
 async function history({ resourceType, id, versionId, count, offset, }, request) {
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        if (versionId) {
+            return await this.startAsyncJob(`/${resourceType}/${id}/_history/${versionId}`, 'GET', {}, requestMode, request);
+        }
+        return await this.startAsyncJob(`/${resourceType}/${id}/_history`, 'GET', {}, requestMode, request);
+    }
     if (versionId) {
         return this.fhirRequest(`/${resourceType}/${id}/_history/${versionId}`, 'GET')({}, request);
     }
@@ -401,11 +645,16 @@ function batchInputRequestToBundleEntryItem(request, config) {
     throw new Error('Unrecognized method');
 }
 async function batch(input, request) {
-    const resp = await this.fhirRequest('/', 'POST')({
+    const requestPayload = {
         resourceType: 'Bundle',
         type: 'batch',
         entry: input.requests.map((req) => batchInputRequestToBundleEntryItem(req, this.config)),
-    }, request);
+    };
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob('/', 'POST', requestPayload, requestMode, request);
+    }
+    const resp = await this.fhirRequest('/', 'POST')(requestPayload, request);
     // Validate each GET/HEAD retrieval entry against the tag config.
     // Violations are replaced with a synthetic 404 OperationOutcome entry; batch entries are independent.
     const rawEntries = resp.entry;
@@ -448,11 +697,16 @@ async function batch(input, request) {
     return bundle;
 }
 async function transaction(input, request) {
-    const resp = await this.fhirRequest('/', 'POST')({
+    const requestPayload = {
         resourceType: 'Bundle',
         type: 'transaction',
         entry: input.requests.map((req) => batchInputRequestToBundleEntryItem(req, this.config)),
-    }, request);
+    };
+    const requestMode = request?.mode;
+    if (isAsyncRequestMode(requestMode)) {
+        return await this.startAsyncJob('/', 'POST', requestPayload, requestMode, request);
+    }
+    const resp = await this.fhirRequest('/', 'POST')(requestPayload, request);
     // Validate each GET/HEAD retrieval entry against the tag config.
     // A violation throws OystehrFHIRError(404) — transactions are all-or-nothing.
     if (this.config.workspaceTag || this.config.ignoreTags?.length) {
@@ -523,15 +777,21 @@ function formatHumanName(name, options) {
 }
 
 exports.batch = batch;
+exports.cancelAsyncJob = cancelAsyncJob;
 exports.create = create;
 exports.delete = del;
 exports.formatAddress = formatAddress;
 exports.formatHumanName = formatHumanName;
 exports.generateFriendlyPatientId = generateFriendlyPatientId;
 exports.get = get;
+exports.getAsyncJob = getAsyncJob;
 exports.history = history;
 exports.patch = patch;
 exports.search = search;
+exports.searchAndGetAllPages = searchAndGetAllPages;
 exports.transaction = transaction;
 exports.update = update;
+exports.waitForAsyncBulkBundle = waitForAsyncBulkBundle;
+exports.waitForAsyncBulkOutput = waitForAsyncBulkOutput;
+exports.waitForAsyncJob = waitForAsyncJob;
 //# sourceMappingURL=fhir-ext.cjs.map