@haste-health/client 0.16.0 → 0.126.3

package/src/http/index.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Bundle, id } from "@haste-health/fhir-types/r4/types";
 import * as r4b from "@haste-health/fhir-types/r4b/types";
-import { FHIR_VERSION, R4, R4B } from "@haste-health/fhir-types/versions";
+import { FHIR_VERSION } from "@haste-health/fhir-types/versions";
 import { OperationError, outcomeError } from "@haste-health/operation-outcomes";
 
 import { AsynchronousClient } from "../index.js";
@@ -19,6 +19,13 @@ export type HTTPClientState = {
   authenticate?: () => void;
   getAccessToken?: () => Promise<string>;
   url: string | DeriveFHIRURL;
+  /**
+   * How searches are sent. Defaults to `"GET"` (parameters in the query
+   * string). `"POST"` form-encodes them into a `_search` body, keeping
+   * identifiers out of URLs and lifting the URL length limit.
+   * Allows users to send PHI without worrying about it appearing in URLs.
+   */
+  searchMethod?: "GET" | "POST";
 };
 
 export type HTTPContext = {
@@ -26,52 +33,27 @@ export type HTTPContext = {
 };
 
 function parametersToQueryString(
-  parameters: ParsedParameter<string | number>[]
+  parameters: ParsedParameter<string | number>[],
 ): string {
   return parameters
     .map((p) => {
       const name = p.chains ? [p.name, ...p.chains].join(".") : p.name;
-      return `${name}${p.modifier ? `:${p.modifier}` : ""}=${p.value
-        .map((v) => encodeURIComponent(v))
-        .join(",")}`;
+      const modifier = p.modifier ? `:${p.modifier}` : "";
+      const value = p.value.map((v) => encodeURIComponent(v)).join(",");
+      return `${name}${modifier}=${value}`;
     })
     .join("&");
 }
 
-const pathJoin = (parts: string[], sep = "/") =>
-  parts.join(sep).replace(new RegExp(sep + "{1,}", "g"), sep);
-
-function fhirUrlChunk(version: string) {
-  switch (version) {
-    case R4:
-      return "r4";
-    case R4B:
-      return "r4b";
-    default:
-      return version;
-  }
+/** Renders a query string as a URL suffix, empty when there is none. */
+function querySuffix(queryString: string): string {
+  return queryString ? `?${queryString}` : "";
 }
 
-/**
- * Used as default and for display purposes in admin app.
- * @param domain HasteHealth Domain
- * @param fhirVersion FHIRVersion
- * @returns HasteHealth VersionedURL.
- */
-export const deriveHasteHealthVersionedURL = (
-  domain: string,
-  fhirVersion: FHIR_VERSION
-) => {
-  return new URL(
-    pathJoin([new URL(domain).pathname, `/${fhirUrlChunk(fhirVersion)}`]),
-    domain
-  ).toString();
-};
-
 async function toHTTPRequest(
   state: HTTPClientState,
   context: HTTPContext,
-  request: FHIRRequest<FHIR_VERSION, AllInteractions>
+  request: FHIRRequest<FHIR_VERSION, AllInteractions>,
 ): Promise<{
   url: string;
   headers?: Record<string, string>;
@@ -83,10 +65,11 @@ async function toHTTPRequest(
     ...context.headers,
   };
 
+  // A string base URL is the FHIR root and is used as given. The FHIR version
+  // belongs to the project, so it is not appended to the path; pass a function
+  // if a deployment needs the URL to vary by version.
   let FHIRUrl =
-    typeof state.url === "string"
-      ? deriveHasteHealthVersionedURL(state.url, request.fhirVersion)
-      : state.url(request.fhirVersion);
+    typeof state.url === "string" ? state.url : state.url(request.fhirVersion);
   if (!FHIRUrl.endsWith("/")) {
     FHIRUrl = FHIRUrl + "/";
   }
@@ -122,8 +105,8 @@ async function toHTTPRequest(
           const queryString = parametersToQueryString(request.parameters);
           return {
             url: new URL(
-              `${request.resource}${queryString ? `?${queryString}` : ""}`,
-              FHIRUrl
+              `${request.resource}${querySuffix(queryString)}`,
+              FHIRUrl,
             ).href,
             method: "PUT",
             body: JSON.stringify(request.body),
@@ -154,7 +137,7 @@ async function toHTTPRequest(
       return {
         url: new URL(
           `${request.resource}/${request.id}/_history/${request.versionId}`,
-          FHIRUrl
+          FHIRUrl,
         ).href,
         method: "GET",
         headers,
@@ -173,8 +156,8 @@ async function toHTTPRequest(
           const queryString = parametersToQueryString(request.parameters);
           return {
             url: new URL(
-              `${request.resource}${queryString ? `?${queryString}` : ""}`,
-              FHIRUrl
+              `${request.resource}${querySuffix(queryString)}`,
+              FHIRUrl,
             ).href,
             method: "DELETE",
             headers,
@@ -183,8 +166,7 @@ async function toHTTPRequest(
         case "system": {
           const queryString = parametersToQueryString(request.parameters);
           return {
-            url: new URL(`${queryString ? `?${queryString}` : ""}`, FHIRUrl)
-              .href,
+            url: new URL(querySuffix(queryString), FHIRUrl).href,
             method: "DELETE",
             headers,
           };
@@ -199,7 +181,7 @@ async function toHTTPRequest(
         case "instance": {
           historyUrl = new URL(
             `${request.resource}/${request.id}/_history`,
-            FHIRUrl
+            FHIRUrl,
           ).href;
           break;
         }
@@ -214,8 +196,7 @@ async function toHTTPRequest(
       }
 
       return {
-        url: new URL(`${queryString ? `?${queryString}` : ""}`, historyUrl)
-          .href,
+        url: new URL(querySuffix(queryString), historyUrl).href,
         method: "GET",
         headers,
       };
@@ -231,28 +212,49 @@ async function toHTTPRequest(
       };
     }
     case "search-request": {
-      const queryString = parametersToQueryString(request.parameters);
-      let searchURL;
-      switch (request.level) {
-        case "type":
-          searchURL = new URL(
-            `${request.resource}${queryString ? `?${queryString}` : ""}`,
-            FHIRUrl
-          ).href;
-          break;
-        case "system":
-          searchURL = new URL(
-            `${queryString ? `?${queryString}` : ""}`,
-            FHIRUrl
-          ).href;
-          break;
-      }
+      // Percent-encoded, so this works as a query string or a form body.
+      const parameters = parametersToQueryString(request.parameters);
+
+      if (state.searchMethod === "POST") {
+        let searchURL;
+        switch (request.level) {
+          case "type":
+            searchURL = new URL(`${request.resource}/_search`, FHIRUrl).href;
+            break;
+          case "system":
+            searchURL = new URL("_search", FHIRUrl).href;
+            break;
+        }
 
-      return {
-        url: searchURL,
-        method: "GET",
-        headers,
-      };
+        return {
+          url: searchURL,
+          method: "POST",
+          body: parameters,
+          headers: {
+            ...headers,
+            "Content-Type": "application/x-www-form-urlencoded",
+          },
+        };
+      } else {
+        const queryString = querySuffix(parameters);
+
+        let searchURL;
+        switch (request.level) {
+          case "type":
+            searchURL = new URL(`${request.resource}${queryString}`, FHIRUrl)
+              .href;
+            break;
+          case "system":
+            searchURL = new URL(queryString, FHIRUrl).href;
+            break;
+        }
+
+        return {
+          url: searchURL,
+          method: "GET",
+          headers,
+        };
+      }
     }
 
     case "invoke-request": {
@@ -261,13 +263,13 @@ async function toHTTPRequest(
         case "instance":
           invokeURL = new URL(
             `${request.resource}/${request.id}/$${request.operation}`,
-            FHIRUrl
+            FHIRUrl,
           ).href;
           break;
         case "type":
           invokeURL = new URL(
             `${request.resource}/$${request.operation}`,
-            FHIRUrl
+            FHIRUrl,
           ).href;
           break;
         case "system":
@@ -289,7 +291,7 @@ export class ResponseError<Version extends FHIR_VERSION> extends Error {
   private readonly _response: FHIRResponse<Version, "error">;
   constructor(
     request: FHIRRequest<Version, AllInteractions>,
-    response: FHIRErrorResponse<Version>
+    response: FHIRErrorResponse<Version>,
   ) {
     super();
     this._request = request;
@@ -309,7 +311,7 @@ export function isResponseError(e: unknown): e is ResponseError<FHIR_VERSION> {
 
 async function httpResponseToFHIRResponse<Version extends FHIR_VERSION>(
   request: FHIRRequest<Version, AllInteractions>,
-  response: Response
+  response: Response,
 ): Promise<FHIRResponse<Version, AllInteractions>> {
   if (response.status >= 400) {
     switch (response.status) {
@@ -627,7 +629,7 @@ function httpMiddleware(state: HTTPClientState): MiddlewareAsync<HTTPContext> {
         const httpRequest = await toHTTPRequest(
           state,
           context.ctx,
-          context.request
+          context.request,
         );
         const response = await fetch(httpRequest.url, {
           method: httpRequest.method,
@@ -636,7 +638,7 @@ function httpMiddleware(state: HTTPClientState): MiddlewareAsync<HTTPContext> {
         });
         const fhirResponse = await httpResponseToFHIRResponse(
           context.request,
-          response
+          response,
         );
         fhirResponse.http = {
           status: response.status,
@@ -665,7 +667,7 @@ function httpMiddleware(state: HTTPClientState): MiddlewareAsync<HTTPContext> {
 }
 
 export default function createHTTPClient(
-  initialState: HTTPClientState
+  initialState: HTTPClientState,
 ): AsynchronousClient<HTTPContext> {
   // Removing trailing slash
   const middleware = httpMiddleware(initialState);

package/src/index.ts

@@ -148,9 +148,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
     const response = await this.request<typeof fhirVersion, "update">(ctx, {
       fhirVersion,
       type: "update-request",
@@ -284,9 +282,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
     const response = await this.request<typeof fhirVersion, "delete">(ctx, {
       fhirVersion,
       type: "delete-request",
@@ -305,9 +301,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
     const response = await this.request<typeof fhirVersion, "delete">(ctx, {
       fhirVersion,
       type: "delete-request",
@@ -325,9 +319,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
 
     const response = await this.request(ctx, {
       fhirVersion,
@@ -351,9 +343,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
     const response = await this.request<typeof fhirVersion, "history">(ctx, {
       fhirVersion,
       type: "history-request",
@@ -378,9 +368,7 @@ export class AsynchronousClient<CTX> implements FHIRClientAsync<CTX> {
     const parsedParameters: ParsedParameter<string | number>[] =
       typeof parameters === "string"
         ? parseQuery(parameters)
-        : parameters
-        ? parameters
-        : [];
+        : (parameters ?? []);
     const response = await this.request<typeof fhirVersion, "history">(ctx, {
       fhirVersion,
       type: "history-request",

package/src/middleware/index.ts

@@ -9,6 +9,11 @@ type Context<CTX, Request, Response> = {
   response?: Response;
 };
 
+type MiddlewareOptions = { logging?: boolean };
+
+/** Shared default so each call does not allocate a fresh options object. */
+const DEFAULT_OPTIONS: MiddlewareOptions = Object.freeze({ logging: false });
+
 export type MiddlewareAsyncChain<
   State,
   CTX,
@@ -45,7 +50,7 @@ function createNext<
   Response = FHIRResponse<FHIR_VERSION, AllInteractions | "error">
 >(
   middlewareChain: MiddlewareAsyncChain<State, CTX, Request, Response>[],
-  options: { logging?: boolean } = { logging: false }
+  options: MiddlewareOptions = DEFAULT_OPTIONS
 ): Next<State, CTX, Request, Response> {
   const [first, ...rest] = middlewareChain;
 
@@ -72,7 +77,7 @@ export function createMiddlewareAsync<
 >(
   _state: State,
   middlewareChain: MiddlewareAsyncChain<State, CTX, Request, Response>[],
-  options: { logging?: boolean } = { logging: false }
+  options: MiddlewareOptions = DEFAULT_OPTIONS
 ): MiddlewareAsync<CTX, Request, Response> {
   let state = _state;
 

package/lib/types/r4.d.ts

@@ -1,257 +0,0 @@
-import {
-  Bundle,
-  CapabilityStatement,
-  OperationOutcome,
-  Parameters,
-  Resource,
-  ResourceType,
-  code,
-  id,
-} from "@oxidized-health/fhir-types/r4/types";
-import { R4 } from "@oxidized-health/fhir-types/versions";
-import type { ParsedParameter } from "../url.js";
-import {
-  Request,
-  RequestInteractionTypes,
-  RequestLevel,
-  ResponseInteractionTypes,
-} from "./utilities.js";
-export interface R4InstanceInteraction extends Request<R4, "instance"> {
-  resource: ResourceType;
-  id: id;
-}
-export interface R4TypeInteraction extends Request<R4, "type"> {
-  resource: ResourceType;
-}
-export interface R4SystemInteraction extends Request<R4, "system"> {}
-export type R4ReadRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["read"];
-};
-export type R4VersionReadRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["vread"];
-  versionId: string;
-};
-export type R4UpdateRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["update"];
-  body: Resource;
-};
-export type R4PatchRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["patch"];
-  body: unknown;
-};
-export type R4InstanceDeleteRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["delete"];
-};
-export type R4TypeDeleteRequest = R4TypeInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: RequestInteractionTypes["delete"];
-};
-export type R4SystemDeleteRequest = R4SystemInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: RequestInteractionTypes["delete"];
-};
-export type R4HistoryInstanceRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["history"];
-  parameters?: ParsedParameter<string | number>[];
-};
-export type R4CreateRequest = R4TypeInteraction & {
-  type: RequestInteractionTypes["create"];
-  body: Resource;
-};
-export type R4ConditinalUpdateRequest = R4TypeInteraction & {
-  type: RequestInteractionTypes["update"];
-  parameters: ParsedParameter<string | number>[];
-  body: Resource;
-};
-export type R4TypeSearchRequest = R4TypeInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: RequestInteractionTypes["search"];
-};
-export type R4TypeHistoryRequest = R4TypeInteraction & {
-  type: RequestInteractionTypes["history"];
-  parameters?: ParsedParameter<string | number>[];
-};
-export type R4CapabilitiesRequest = R4SystemInteraction & {
-  type: RequestInteractionTypes["capabilities"];
-};
-export type R4BatchRequest = R4SystemInteraction & {
-  type: RequestInteractionTypes["batch"];
-  body: Bundle;
-};
-export type R4TransactionRequest = R4SystemInteraction & {
-  type: RequestInteractionTypes["transaction"];
-  body: Bundle;
-};
-export type R4SystemHistoryRequest = R4SystemInteraction & {
-  type: RequestInteractionTypes["history"];
-  parameters?: ParsedParameter<string | number>[];
-};
-export type R4SystemSearchRequest = R4SystemInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: RequestInteractionTypes["search"];
-};
-export type R4InvokeInstanceRequest = R4InstanceInteraction & {
-  type: RequestInteractionTypes["invoke"];
-  operation: code;
-  body: Resource;
-};
-export type R4InvokeTypeRequest = R4TypeInteraction & {
-  type: RequestInteractionTypes["invoke"];
-  operation: code;
-  body: Resource;
-};
-export type R4InvokeSystemRequest = R4SystemInteraction & {
-  type: RequestInteractionTypes["invoke"];
-  operation: code;
-  body: Resource;
-};
-export type R4FHIRRequest =
-  | R4InvokeInstanceRequest
-  | R4InvokeTypeRequest
-  | R4InvokeSystemRequest
-  | R4ReadRequest
-  | R4VersionReadRequest
-  | R4UpdateRequest
-  | R4PatchRequest
-  | R4HistoryInstanceRequest
-  | R4InstanceDeleteRequest
-  | R4CreateRequest
-  | R4TypeSearchRequest
-  | R4TypeHistoryRequest
-  | R4TypeDeleteRequest
-  | R4CapabilitiesRequest
-  | R4BatchRequest
-  | R4TransactionRequest
-  | R4SystemHistoryRequest
-  | R4SystemSearchRequest
-  | R4SystemDeleteRequest
-  | R4ConditinalUpdateRequest;
-export type R4ReadResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["read"];
-  body: Resource;
-};
-export type R4VersionReadResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["vread"];
-  versionId: string;
-  body: Resource;
-};
-export type R4UpdateResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["update"];
-  created?: boolean;
-  body: Resource;
-};
-export type R4PatchResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["patch"];
-  body: Resource;
-};
-export type R4InstanceDeleteResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["delete"];
-};
-export type R4TypeDeleteResponse = R4TypeInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: ResponseInteractionTypes["delete"];
-  deletions?: {
-    id: id;
-    type: ResourceType;
-  }[];
-};
-export type R4SystemDeleteResponse = R4SystemInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: ResponseInteractionTypes["delete"];
-  deletions?: {
-    id: id;
-    type: ResourceType;
-  }[];
-};
-export type R4InstanceHistoryResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["history"];
-  body: Bundle;
-};
-export type R4CreateResponse = R4TypeInteraction & {
-  type: ResponseInteractionTypes["create"];
-  body: Resource;
-};
-export type R4TypeSearchResponse = R4TypeInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: ResponseInteractionTypes["search"];
-  body: Bundle;
-};
-export type R4TypeHistoryResponse = R4TypeInteraction & {
-  type: ResponseInteractionTypes["history"];
-  body: Bundle;
-};
-export type R4CapabilitiesResponse = R4SystemInteraction & {
-  type: ResponseInteractionTypes["capabilities"];
-  body: CapabilityStatement;
-};
-export type R4BatchResponse = R4SystemInteraction & {
-  type: ResponseInteractionTypes["batch"];
-  body: Bundle;
-};
-export type R4TransactionResponse = R4SystemInteraction & {
-  type: ResponseInteractionTypes["transaction"];
-  body: Bundle;
-};
-export type R4SystemHistoryResponse = R4SystemInteraction & {
-  type: ResponseInteractionTypes["history"];
-  body: Bundle;
-};
-export type R4SystemSearchResponse = R4SystemInteraction & {
-  parameters: ParsedParameter<string | number>[];
-  type: ResponseInteractionTypes["search"];
-  body: Bundle;
-};
-export type R4InvokeInstanceResponse = R4InstanceInteraction & {
-  type: ResponseInteractionTypes["invoke"];
-  operation: code;
-  body: Parameters;
-};
-export type R4InvokeTypeResponse = R4TypeInteraction & {
-  type: ResponseInteractionTypes["invoke"];
-  operation: code;
-  body: Parameters;
-};
-export type R4InvokeSystemResponse = R4SystemInteraction & {
-  type: ResponseInteractionTypes["invoke"];
-  operation: code;
-  body: Parameters;
-};
-export type R4InvokeResponse =
-  | R4InvokeInstanceResponse
-  | R4InvokeTypeResponse
-  | R4InvokeSystemResponse;
-export type R4InvokeRequest =
-  | R4InvokeInstanceRequest
-  | R4InvokeTypeRequest
-  | R4InvokeSystemRequest;
-interface R4ErrorResponse<Level extends keyof RequestLevel>
-  extends Request<R4, Level> {
-  type: ResponseInteractionTypes["error"];
-  body: OperationOutcome;
-}
-export type R4FHIRErrorResponse =
-  | R4ErrorResponse<"system">
-  | R4ErrorResponse<"type">
-  | R4ErrorResponse<"instance">;
-export type R4FHIRResponse =
-  | R4FHIRErrorResponse
-  | R4InvokeInstanceResponse
-  | R4InvokeTypeResponse
-  | R4InvokeSystemResponse
-  | R4ReadResponse
-  | R4VersionReadResponse
-  | R4UpdateResponse
-  | R4PatchResponse
-  | R4InstanceHistoryResponse
-  | R4InstanceDeleteResponse
-  | R4CreateResponse
-  | R4TypeSearchResponse
-  | R4TypeHistoryResponse
-  | R4TypeDeleteResponse
-  | R4CapabilitiesResponse
-  | R4BatchResponse
-  | R4TransactionResponse
-  | R4SystemHistoryResponse
-  | R4SystemSearchResponse
-  | R4SystemDeleteResponse;
-export {};

package/lib/types/r4.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=r4.js.map

package/lib/types/r4.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"r4.js","sourceRoot":"","sources":["../../src/types/r4.ts"],"names":[],"mappings":""}