@medplum/fhir-router 2.1.15 → 2.1.17

package/dist/esm/index.d.mts

@@ -0,0 +1,229 @@
+import { Bundle } from '@medplum/fhirtypes';
+import { Operation } from 'rfc6902';
+import { OperationOutcome } from '@medplum/fhirtypes';
+import { OperationOutcomeError } from '@medplum/core';
+import { Reference } from '@medplum/fhirtypes';
+import { Resource } from '@medplum/fhirtypes';
+import { SearchRequest } from '@medplum/core';
+
+export declare abstract class BaseRepository {
+    /**
+     * Searches for FHIR resources.
+     *
+     * See: https://www.hl7.org/fhir/http.html#search
+     * @param searchRequest - The FHIR search request.
+     * @returns The search results.
+     */
+    abstract search<T extends Resource>(searchRequest: SearchRequest<T>): Promise<Bundle<T>>;
+    /**
+     * Searches for a single FHIR resource.
+     *
+     * This is a convenience method for `search()` that returns the first resource rather than a `Bundle`.
+     *
+     * The return value is the resource, if available; otherwise, undefined.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     * @param searchRequest - The FHIR search request.
+     * @returns Promise to the first search result or undefined.
+     */
+    searchOne<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T | undefined>;
+    /**
+     * Sends a FHIR search request for an array of resources.
+     *
+     * This is a convenience method for `search()` that returns the resources as an array rather than a `Bundle`.
+     *
+     * The return value is an array of resources.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     * @param searchRequest - The FHIR search request.
+     * @returns Promise to the array of search results.
+     */
+    searchResources<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T[]>;
+}
+
+export declare interface FhirOptions {
+    introspectionEnabled?: boolean;
+}
+
+/**
+ * The FhirRepository interface defines the methods that are required to implement a FHIR repository.
+ * A FHIR repository is responsible for storing and retrieving FHIR resources.
+ * It is used by the FHIR router to implement the FHIR REST API.
+ * The primary implementations at this time are:
+ *  1. MemoryRepository - A repository that stores resources in memory.
+ *  2. Server Repository - A repository that stores resources in a relational database.
+ */
+export declare interface FhirRepository {
+    /**
+     * Creates a FHIR resource.
+     *
+     * See: https://www.hl7.org/fhir/http.html#create
+     * @param resource - The FHIR resource to create.
+     * @returns The created resource.
+     */
+    createResource<T extends Resource>(resource: T): Promise<T>;
+    /**
+     * Reads a FHIR resource by ID.
+     *
+     * See: https://www.hl7.org/fhir/http.html#read
+     * @param resourceType - The FHIR resource type.
+     * @param id - The FHIR resource ID.
+     * @returns The FHIR resource.
+     */
+    readResource<T extends Resource>(resourceType: string, id: string): Promise<T>;
+    /**
+     * Reads a FHIR resource by reference.
+     *
+     * See: https://www.hl7.org/fhir/http.html#read
+     * @param reference - The FHIR reference.
+     * @returns The FHIR resource.
+     */
+    readReference<T extends Resource>(reference: Reference<T>): Promise<T>;
+    /**
+     * Reads a collection of FHIR resources by reference.
+     *
+     * See: https://www.hl7.org/fhir/http.html#read
+     * @param references - The FHIR references.
+     * @returns The FHIR resources.
+     */
+    readReferences(references: readonly Reference[]): Promise<(Resource | Error)[]>;
+    /**
+     * Returns resource history.
+     *
+     * Results are sorted with oldest versions last
+     *
+     * See: https://www.hl7.org/fhir/http.html#history
+     * @param resourceType - The FHIR resource type.
+     * @param id - The FHIR resource ID.
+     * @returns Operation outcome and a history bundle.
+     */
+    readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
+    /**
+     * Reads a FHIR resource version.
+     *
+     * See: https://www.hl7.org/fhir/http.html#vread
+     * @param resourceType - The FHIR resource type.
+     * @param id - The FHIR resource ID.
+     * @param vid - The FHIR resource version ID.
+     */
+    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>;
+    /**
+     * Updates a FHIR resource.
+     *
+     * See: https://www.hl7.org/fhir/http.html#update
+     * @param resource - The FHIR resource to update.
+     * @returns The updated resource.
+     */
+    updateResource<T extends Resource>(resource: T): Promise<T>;
+    /**
+     * Deletes a FHIR resource.
+     *
+     * See: https://www.hl7.org/fhir/http.html#delete
+     * @param resourceType - The FHIR resource type.
+     * @param id - The FHIR resource ID.
+     */
+    deleteResource(resourceType: string, id: string): Promise<void>;
+    /**
+     * Patches a FHIR resource.
+     *
+     * See: https://www.hl7.org/fhir/http.html#patch
+     * @param resourceType - The FHIR resource type.
+     * @param id - The FHIR resource ID.
+     * @param patch - The JSONPatch operations.
+     * @returns The patched resource.
+     */
+    patchResource(resourceType: string, id: string, patch: Operation[]): Promise<Resource>;
+    /**
+     * Searches for FHIR resources.
+     *
+     * See: https://www.hl7.org/fhir/http.html#search
+     * @param searchRequest - The FHIR search request.
+     * @returns The search results.
+     */
+    search<T extends Resource>(searchRequest: SearchRequest<T>): Promise<Bundle<T>>;
+    /**
+     * Searches for a single FHIR resource.
+     *
+     * This is a convenience method for `search()` that returns the first resource rather than a `Bundle`.
+     *
+     * The return value is the resource, if available; otherwise, undefined.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     * @param searchRequest - The FHIR search request.
+     * @returns Promise to the first search result or undefined.
+     */
+    searchOne<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T | undefined>;
+    /**
+     * Sends a FHIR search request for an array of resources.
+     *
+     * This is a convenience method for `search()` that returns the resources as an array rather than a `Bundle`.
+     *
+     * The return value is an array of resources.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     * @param searchRequest - The FHIR search request.
+     * @returns Promise to the array of search results.
+     */
+    searchResources<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T[]>;
+}
+
+export declare type FhirRequest = {
+    method: HttpMethod;
+    pathname: string;
+    body: any;
+    params: Record<string, string>;
+    query: Record<string, string>;
+};
+
+export declare type FhirResponse = [OperationOutcome] | [OperationOutcome, Resource];
+
+export declare type FhirRouteHandler = (req: FhirRequest, repo: FhirRepository, router: FhirRouter) => Promise<FhirResponse>;
+
+export declare class FhirRouter {
+    readonly router: Router<FhirRouteHandler>;
+    readonly options: FhirOptions;
+    constructor(options?: {});
+    handleRequest(req: FhirRequest, repo: FhirRepository): Promise<FhirResponse>;
+}
+
+export declare type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+
+export declare class MemoryRepository extends BaseRepository implements FhirRepository {
+    private readonly resources;
+    private readonly history;
+    constructor();
+    createResource<T extends Resource>(resource: T): Promise<T>;
+    updateResource<T extends Resource>(resource: T): Promise<T>;
+    patchResource(resourceType: string, id: string, patch: Operation[]): Promise<Resource>;
+    readResource<T extends Resource>(resourceType: string, id: string): Promise<T>;
+    readReference<T extends Resource>(reference: Reference<T>): Promise<T>;
+    readReferences(references: readonly Reference[]): Promise<(Resource | OperationOutcomeError)[]>;
+    readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
+    readVersion<T extends Resource>(resourceType: string, id: string, versionId: string): Promise<T>;
+    search<T extends Resource>(searchRequest: SearchRequest<T>): Promise<Bundle<T>>;
+    deleteResource(resourceType: string, id: string): Promise<void>;
+}
+
+export declare type PathSegment = {
+    value: string;
+    param?: boolean;
+};
+
+export declare type Route<T> = {
+    method: HttpMethod;
+    path: PathSegment[];
+    handler: T;
+};
+
+export declare class Router<T> {
+    readonly routes: Route<T>[];
+    add(method: HttpMethod, pathStr: string, handler: T): void;
+    find(method: HttpMethod, pathStr: string): RouteResult<T> | undefined;
+}
+
+export declare type RouteResult<T> = {
+    handler: T;
+    params: Record<string, string>;
+};
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/fhir-router",
-  "version": "2.1.15",
+  "version": "2.1.17",
   "description": "Medplum FHIR Router",
   "keywords": [
     "medplum",
@@ -27,15 +27,14 @@
   "author": "Medplum <hello@medplum.com>",
   "sideEffects": false,
   "exports": {
-    "types": "./dist/types.d.ts",
     "require": "./dist/cjs/index.cjs",
     "import": "./dist/esm/index.mjs"
   },
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
-  "types": "dist/types.d.ts",
   "scripts": {
-    "build": "npm run clean && tsc --project tsconfig.build.json && node esbuild.mjs && api-extractor run --local",
+    "api-extractor": "api-extractor run --local && cp dist/types.d.ts dist/cjs/index.d.cts && cp dist/types.d.ts dist/esm/index.d.mts",
+    "build": "npm run clean && tsc --project tsconfig.build.json && node esbuild.mjs && npm run api-extractor",
     "clean": "rimraf dist",
     "test": "jest"
   },

package/api-extractor.json

@@ -1,3 +0,0 @@
-{
-  "extends": "../../api-extractor.json"
-}

package/tsdoc.json

@@ -1,4 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  "extends": ["../../tsdoc.json"]
-}