Add types for "fhir-kit-client" module (#36046)

* Add types for "fhir-kit-client" module * Add specialized method types * Refactoring "fhir-kit-client" to have single export and no namespace * Convert to exclude type for custom resources * Fix "type" response unions * Add missing tests * Further define fhir-kit-client to match with all custom resource types * Add support for OperationOutcome for all operations
2026-10-06 07:47:04 +00:00 · 2019-06-13 20:24:48 -07:00
parent a6cda8a2df
commit 6bcf6bab27
4 changed files with 1639 additions and 0 deletions
@@ -0,0 +1,250 @@
+import Client from "fhir-kit-client";
+import { Headers } from "request";
+import { OpPatch } from "json-patch";
+
+const client: Client = new Client({
+    baseUrl: "http://foo",
+    customHeaders: {
+        FOO: "bar"
+    }
+});
+
+client.baseUrl = "foo";
+client.bearerToken = "foo";
+client.customHeaders = {
+    BASH: {
+        BANG: "Bing"
+    }
+};
+
+export class OperationOutcomeError extends Error {
+    readonly outcome: fhir.OperationOutcome;
+
+    constructor(outcome: fhir.OperationOutcome) {
+        super(outcome.issue && outcome.issue.length > 1 && outcome.issue[0].diagnostics || "Unknown Operation result error");
+        this.outcome = outcome;
+    }
+}
+
+function rejectOnOperationOutcome<ResultType extends fhir.ResourceBase>(promise: fhir.OperationOutcome | ResultType | Promise<fhir.OperationOutcome | ResultType>): Promise<ResultType> {
+    if (promise instanceof Promise) {
+        return promise.then(result => {
+            if ('issue' in result) {
+                throw new OperationOutcomeError(result);
+            } else {
+                return result;
+            }
+        });
+    } else if ('issue' in promise) {
+        throw new OperationOutcomeError(promise);
+    } else {
+        return Promise.resolve(promise);
+    }
+}
+
+const url: string = client.baseUrl;
+url.endsWith("foo");
+const headers: Headers = client.customHeaders;
+headers["foo"] = "bar";
+
+client.create({
+    resourceType: "Patient",
+    body: {
+        name: [{
+            text: "Jim Bean"
+        }]
+    }
+}).then(rejectOnOperationOutcome).then((p: fhir.Patient) => {
+    if (p.name && p.name.length !== 0 && p.name[0].text) {
+        console.log(p.name[0].text);
+    }
+});
+
+client.update({
+    resourceType: "Basic",
+    id: "abc122312341",
+    body: {
+        code: {
+            text: "Offer"
+        },
+        identifier: [
+            {
+                system: "https://foo",
+                value: "1235"
+            }
+        ]
+    }
+}).then(rejectOnOperationOutcome).then((basic: fhir.Basic) => {
+});
+
+client.update({
+    resourceType: "QuestionnaireResponse",
+    id: "1235",
+    body: {
+        status: "completed"
+    }
+}).then(rejectOnOperationOutcome)
+.then((r: fhir.QuestionnaireResponse) => {
+});
+
+client.delete({
+    resourceType: "Basic",
+    id: "1235"
+}).then((o: fhir.OperationOutcome) => {
+    console.log(o.issue);
+});
+
+client.batch({
+    body: {
+        type: "batch",
+        total: 1234
+    }
+}).then(rejectOnOperationOutcome).then(r => {
+    if (r.type === "batch-response") {
+        console.log("unhuh!");
+    } else {
+        // should never happen
+    }
+});
+
+client.transaction({
+    body: {
+        type: "transaction"
+    }
+}).then(rejectOnOperationOutcome).then(r => {
+    if (r.type === "transaction-response") {
+        console.log("yup!");
+    }
+});
+
+client.resolve({
+    reference: "#1234",
+    context: {
+        contained: [ {
+                resourceType: "Patient",
+                id: "1235"
+            }
+        ]
+    }
+}).then((entity) => {
+    switch (entity.resourceType) {
+        case "Patient":
+            const patient: fhir.Patient = entity as fhir.Patient;
+            if (patient.name) {
+                console.log(patient.name[0].text);
+            }
+            break;
+    }
+    if (entity.id !== undefined) {
+        const id: string = entity.id;
+        id.substring(1);
+    }
+});
+
+client.capabilityStatement()
+    .then(rejectOnOperationOutcome)
+    .then((cs: fhir.CapabilityStatement) => {
+        if (cs.software) {
+            const software: fhir.CapabilityStatementSoftware = cs.software;
+            const name: string = software.name;
+            name.concat('');
+        }
+    });
+
+client.smartAuthMetadata()
+    .then((s => {
+        if (s && s.authorizeUrl) {
+            s.authorizeUrl.substring(1);
+        }
+    }));
+
+const JSONPatch: OpPatch[] = [
+    {
+        op: "add",
+        path: "name",
+        value: "12356"
+    }
+];
+client.patch({
+    resourceType: "Patient",
+    id: "12354",
+    JSONPatch
+}).then(results => {
+    if (results && results.id) {
+        return results.id.substring(1);
+    }
+});
+
+client.search({
+    resourceType: "Doctor",
+}).then(doctor => {
+    const value: string = doctor.id || "";
+    value.substring(1);
+});
+
+client.compartmentSearch({
+    resourceType: "Doctor",
+    compartment: {
+        resourceType: "Patient",
+        id: "12345"
+    }
+}).then(() => {
+});
+
+client.resourceSearch({
+    resourceType: "Doctor",
+    searchParams: {
+        foo: "bar"
+    }
+}).then(rejectOnOperationOutcome);
+
+client.systemSearch({
+    searchParams: {
+        identifier: "12356"
+    }
+}).then(rejectOnOperationOutcome);
+
+client.systemHistory()
+    .then(rejectOnOperationOutcome)
+    .then(history => {
+        if (history) {
+            const type: string = history.type;
+            type.split('[');
+        }
+    });
+
+client.history()
+    .then(history => {
+        if (history.resourceType) {
+            history.resourceType.substring(1);
+        }
+    });
+
+client.typeHistory({
+    resourceType: "Hospital"
+}).then(rejectOnOperationOutcome).then(history => {
+    if (history.total !== undefined) {
+        const total: number = history.total + 1;
+        console.log(`${total}`);
+    }
+});
+
+client.resourceHistory({
+    resourceType: "Medication",
+    id: "123"
+}).then(() => {
+});
+
+client.prevPage({
+    bundle: {
+        type: "searchset"
+    }
+}).then(() => {
+});
+
+client.nextPage({
+    bundle: {
+        type: "searchset"
+    }
+}).then(() => {
+});
@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "lib": [
+            "es6"
+        ],
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "fhir-kit-client-tests.ts"
+    ]
+}
@@ -0,0 +1,7 @@
+{
+    "extends": "dtslint/dt.json",
+    "rules": {
+        "no-redundant-jsdoc": false,
+        "no-redundant-jsdoc-2": false
+    }
+}