@oystehr/sdk 3.0.5 → 3.0.7

package/README.md

@@ -46,7 +46,7 @@ npm install @oystehr/sdk
 ## Usage
 
 1. Import the SDK.
-2. Initialize the SDK with a Oystehr access token. ([Learn how to get an access token](https://docs.oystehr.com/core-documentation/authenticating-api-requests)).
+2. Initialize the SDK with an Oystehr access token. ([Learn how to get an access token](https://docs.oystehr.com/core-documentation/authenticating-api-requests)).
 3. Invoke any of Oystehr's APIs with a function call.
 
 ```typescript filename="Example of using the SDK"
@@ -118,7 +118,7 @@ interface OystehrConfig {
 }
 ```
 
-## Features
+## SDK Features
 
 ### Unauthenticated Usage
 
@@ -151,8 +151,6 @@ Note that the Oystehr FHIR API is eventually consistent, so if you are retrievin
 
 To retry on additional status codes, change the number of retries, or register a callback for each retry, pass options to the Oystehr SDK configuration object as shown above.
 
-## Types
-
 ### Oystehr Types
 
 The SDK includes input and output types for all non-FHIR Oystehr services, as well as some reusable "component" types. These types provide a single interface for inputs — no need to worry about whether a value goes into a path parameters or the request body.
@@ -164,7 +162,7 @@ import Oystehr, { UserInviteParams, UserInviteResponse } from '@oystehr/sdk';
 const APP_ID = process.env.OYSTEHR_APP_ID;
 
 // Elsewhere in your project, initialize an Oystehr client
-// with the currently-authenticated user's access token 
+// with the currently-authenticated user's access token
 const oystehr = new Oystehr({ accessToken: accessTokenFromAuthn });
 
 // Define a reusable helper function to add practitioners
@@ -181,8 +179,6 @@ async function inviteUserToMyApp(
 }
 ```
 
-## FHIR
-
 ### FHIR Types
 
 The SDK supports both the R4B and R5 versions of FHIR from one shared set of generic functions. You shouldn't need to mix these types, since each Oystehr project can only have one FHIR version, but the example below shows how the SDK handles types for each version.
@@ -267,6 +263,27 @@ const getAppointments: BatchInputGetRequest = {
 await oystehr.fhir.transaction({ requests: [patchAppointment, getAppointments ]});
 ```
 
+### FHIR Search and Batch Types
+
+When writing complex search and batch requests, you may end up with requests that return more than one type of FHIR Resource. To handle this, the Oystehr FHIR SDK supports generic types on all functions. Use type inference and [type predicates](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) to pull out individual collections of resources and ensure they have the correct type.
+
+```typescript
+import Oystehr from '@oystehr/sdk';
+import { Encounter, Location } from 'fhir/r4b';
+
+const bundle/*: Bundle<Encounter | Location>*/ = await oystehr.fhir.search<Encounter | Location>({
+  resourceType: 'Encounter',
+  params: [{
+    name: '_include',
+    value: 'Encounter.location',
+  }],
+});
+
+const results/*: (Encounter | Location)[]*/ = bundle.unbundle();
+const encounters/*: Encounter[]*/ = results.filter((res): res is Encounter => res.resourceType === 'Encounter');
+const locations/*: Location[]*/ = results.filter((res): res is Location => res.resourceType === 'Location');
+```
+
 ### Optimistic Locking
 
 The Oystehr FHIR API and SDK supports [FHIR's optimistic locking specification](https://build.fhir.org/http.html#concurrency). To use optimistic locking, pass a valid [FHIR version ID](https://build.fhir.org/resource.html#metadata) to the request object on your SDK function call.
@@ -336,4 +353,3 @@ If you have questions about migrating to a new version of the Oystehr SDK, check
 ## Contact
 
 Questions? Join our [public Slack](https://join.slack.com/t/oystehr/shared_invite/zt-1se6hw93b-olDYmAzDGDhU5ibnEugCmA) or contact [support](mailto:support@oystehr.com).
-              

package/dist/cjs/client/client.d.ts

@@ -32,7 +32,7 @@ export type FhirFetcherResponse<T extends FhirData<FhirResource> = any> = T;
 export declare class SDKResource {
     protected readonly config: OystehrConfig;
     constructor(config: OystehrConfig);
-    protected request(path: string, method: string): FetcherFunction;
+    protected request(path: string, method: string, baseUrlThunk: () => string): FetcherFunction;
     protected fhirRequest<T extends FhirResource = any>(path: string, method: string): (params: any, request?: InternalClientRequest) => Promise<FhirFetcherResponse<T>>;
 }
 export type FetcherError = {

package/dist/cjs/config.d.ts

@@ -12,6 +12,11 @@ export interface OystehrConfig {
     projectId?: string;
     fhirApiUrl?: string;
     projectApiUrl?: string;
+    services?: {
+        faxApiUrl?: string;
+        fhirApiUrl?: string;
+        projectApiUrl?: string;
+    };
     /**
      * Optionally provide a custom fetch implementation. This must conform to the
      * built-in node.js fetch implementation (undici fetch).

package/dist/cjs/errors/index.d.ts

@@ -2,11 +2,13 @@ import { OperationOutcome as OperationOutcomeR4B } from 'fhir/r4b';
 import { OperationOutcome as OperationOutcomeR5 } from 'fhir/r5';
 export declare class OystehrSdkError extends Error {
     code: number;
-    constructor({ message, code }: {
+    constructor({ message, code, cause }: {
         message: string;
         code: number;
+        cause?: unknown;
     });
     toString(): string;
+    toJSON(): any;
 }
 export declare class OystehrFHIRError extends OystehrSdkError {
     cause: OperationOutcomeR4B | OperationOutcomeR5;
@@ -14,4 +16,5 @@ export declare class OystehrFHIRError extends OystehrSdkError {
         error: OperationOutcomeR4B | OperationOutcomeR5;
         code: number;
     });
+    toJSON(): any;
 }