@haste-health/fhir-patch-building 0.10.1

package/README.md

@@ -0,0 +1,3 @@
+# FHIR Patch Building
+
+High level API for building JSON Patches with deeply nested FHIR Objects.

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+import { Operation } from "fast-json-patch";
+import * as fpt from "@haste-health/fhir-pointer";
+import { Resource } from "@haste-health/fhir-types/r4/types";
+export interface Mutation<T, R> {
+    path: fpt.Loc<T, R, any>;
+    op: "add" | "remove" | "replace";
+    value?: R;
+}
+export default function buildPatches<T extends Resource, R>(value: T, mutation: Mutation<T, R>): Operation[];
+export declare function applyMutation<T extends Resource, R>(value: T, mutation: Mutation<T, R>): T;
+export declare function applyMutationImmutable<T extends Resource, R>(value: T, mutation: Mutation<T, R>): T;

package/lib/index.js

@@ -0,0 +1,102 @@
+import jsonpatch from "fast-json-patch";
+import { produce } from "immer";
+import * as fpt from "@haste-health/fhir-pointer";
+import { R4 } from "@haste-health/fhir-types/versions";
+function getValue(value, pointer) {
+    return fpt.get(pointer, value);
+}
+function valueExists(value, json_pointer) {
+    return getValue(value, json_pointer) !== undefined;
+}
+function deriveNextValuePlaceHolder(fields) {
+    if (typeof fields[1] === "number") {
+        return [];
+    }
+    return {};
+}
+function createPatchesNonExistantFields(resource, path) {
+    const fields = fpt.fields(path);
+    let patches = [];
+    let curValue = resource;
+    let curPointer = fpt.pointer(R4, resource.resourceType, resource.id);
+    for (let i = 0; i < fields.length; i++) {
+        curPointer = fpt.descend(curPointer, fields[i]);
+        curValue = getValue(resource, curPointer);
+        if (curValue === undefined) {
+            const nextValue = deriveNextValuePlaceHolder(fields.slice(i));
+            patches = [
+                ...patches,
+                { op: "add", path: fpt.toJSONPointer(curPointer), value: nextValue },
+            ];
+        }
+    }
+    return patches;
+}
+export default function buildPatches(value, mutation) {
+    // Builds patches with a given mutation to include non existant values up to the point in the path
+    // where the mutation occurs
+    switch (mutation.op) {
+        case "remove": {
+            if (valueExists(value, mutation.path)) {
+                return [
+                    {
+                        op: "remove",
+                        path: fpt.toJSONPointer(mutation.path),
+                    },
+                ];
+            }
+            return [];
+        }
+        case "add": {
+            const patches = createPatchesNonExistantFields(value, mutation.path);
+            //If last is adding value remove here as collection will only add once.
+            if (patches[patches.length - 1]?.op === "add" &&
+                patches[patches.length - 1]?.path === fpt.toJSONPointer(mutation.path)) {
+                return [
+                    ...patches.slice(0, patches.length - 1),
+                    {
+                        op: "add",
+                        path: fpt.toJSONPointer(mutation.path),
+                        value: mutation.value,
+                    },
+                ];
+            }
+            return [
+                ...patches,
+                {
+                    op: "add",
+                    path: fpt.toJSONPointer(mutation.path),
+                    value: mutation.value,
+                },
+            ];
+        }
+        case "replace": {
+            if (mutation.value === undefined || mutation.value === null) {
+                return buildPatches(value, {
+                    op: "remove",
+                    path: mutation.path,
+                });
+            }
+            const patches = createPatchesNonExistantFields(value, mutation.path);
+            return [
+                ...patches,
+                {
+                    op: "replace",
+                    path: fpt.toJSONPointer(mutation.path),
+                    value: mutation.value,
+                },
+            ];
+        }
+        default:
+            throw new Error(`Invalid operation '${mutation.op}'`);
+    }
+}
+export function applyMutation(value, mutation) {
+    return jsonpatch.applyPatch(value, buildPatches(value, mutation)).newDocument;
+}
+export function applyMutationImmutable(value, mutation) {
+    return produce(value, (v) => {
+        applyMutation(v, mutation);
+    });
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAwB,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,KAAK,GAAG,MAAM,4BAA4B,CAAC;AAElD,OAAO,EAAE,EAAE,EAAE,MAAM,mCAAmC,CAAC;AAQvD,SAAS,QAAQ,CACf,KAAQ,EACR,OAA2B;IAE3B,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAClB,KAAQ,EACR,YAAgC;IAEhC,OAAO,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,SAAS,CAAC;AACrD,CAAC;AAED,SAAS,0BAA0B,CACjC,MAAoC;IAEpC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,8BAA8B,CACrC,QAAW,EACX,IAAwB;IAExB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEhC,IAAI,OAAO,GAAgB,EAAE,CAAC;IAC9B,IAAI,QAAQ,GAAG,QAAmB,CAAC;IACnC,IAAI,UAAU,GAAyB,GAAG,CAAC,OAAO,CAChD,EAAE,EACF,QAAQ,CAAC,YAAY,EACrB,QAAQ,CAAC,EAAQ,CAClB,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAG,0BAA0B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9D,OAAO,GAAG;gBACR,GAAG,OAAO;gBACV,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE;aACrE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,KAAQ,EACR,QAAwB;IAExB,kGAAkG;IAClG,4BAA4B;IAE5B,QAAQ,QAAQ,CAAC,EAAE,EAAE,CAAC;QACpB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,OAAO;oBACL;wBACE,EAAE,EAAE,QAAQ;wBACZ,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;qBACvC;iBACF,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,OAAO,GAAG,8BAA8B,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrE,uEAAuE;YACvE,IACE,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,KAAK;gBACzC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,KAAK,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EACtE,CAAC;gBACD,OAAO;oBACL,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;oBACvC;wBACE,EAAE,EAAE,KAAK;wBACT,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACtC,KAAK,EAAE,QAAQ,CAAC,KAAK;qBACtB;iBACF,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,GAAG,OAAO;gBACV;oBACE,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACtC,KAAK,EAAE,QAAQ,CAAC,KAAK;iBACtB;aACF,CAAC;QACJ,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC5D,OAAO,YAAY,CAAC,KAAK,EAAE;oBACzB,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,QAAQ,CAAC,IAAI;iBACpB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,OAAO,GAAG,8BAA8B,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrE,OAAO;gBACL,GAAG,OAAO;gBACV;oBACE,EAAE,EAAE,SAAS;oBACb,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACtC,KAAK,EAAE,QAAQ,CAAC,KAAK;iBACtB;aACF,CAAC;QACJ,CAAC;QACD;YACE,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,KAAQ,EACR,QAAwB;IAExB,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,KAAQ,EACR,QAAwB;IAExB,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1B,aAAa,CAAC,CAAM,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@haste-health/fhir-patch-building",
+  "version": "0.10.1",
+  "homepage": "https://haste.health",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HasteHealth/HasteHealth.git"
+  },
+  "description": "JSON Patch building with typesafe fhir pointers.",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "pnpm tsc",
+    "test": "pnpm node --experimental-vm-modules $(pnpm bin jest)",
+    "publish": "pnpm build && pnpm npm publish --access public --tolerate-republish"
+  },
+  "devDependencies": {
+    "@haste-health/fhir-types": "workspace:^",
+    "@jest/globals": "^29.7.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.2",
+    "typescript": "5.9.2"
+  },
+  "dependencies": {
+    "@haste-health/fhir-pointer": "workspace:^",
+    "fast-json-patch": "^3.1.1",
+    "immer": "^10.1.1"
+  },
+  "files": [
+    "readme.md",
+    "lib/**",
+    "src/**"
+  ]
+}

package/src/index.test.ts

@@ -0,0 +1,188 @@
+import { expect, test } from "@jest/globals";
+import jsonpatch from "fast-json-patch";
+
+import { descend, pointer } from "@haste-health/fhir-pointer";
+import { Patient, id } from "@haste-health/fhir-types/r4/types";
+import { R4 } from "@haste-health/fhir-types/versions";
+
+import buildPatches, { applyMutationImmutable } from "./index.js";
+
+test("Adding a value.", () => {
+  const loc = pointer(R4, "Patient", "123" as id);
+  const patient: Patient = { resourceType: "Patient", id: "123" } as Patient;
+
+  descend(descend(descend(descend(loc, "name"), 0), "given"), 0);
+  expect(
+    buildPatches(patient, {
+      op: "add",
+      path: descend(descend(descend(descend(loc, "name"), 0), "given"), 0),
+      value: "test",
+    })
+  ).toEqual([
+    {
+      op: "add",
+      path: "/name",
+      value: [],
+    },
+    {
+      op: "add",
+      path: "/name/0",
+      value: {},
+    },
+    {
+      op: "add",
+      path: "/name/0/given",
+      value: [],
+    },
+    {
+      op: "add",
+      path: "/name/0/given/0",
+      value: "test",
+    },
+  ]);
+
+  expect(
+    buildPatches(patient, {
+      op: "add",
+      path: descend(loc, "name"),
+      value: [{ given: ["John"] }],
+    })
+  ).toEqual([
+    {
+      op: "add",
+      path: "/name",
+      value: [{ given: ["John"] }],
+    },
+  ]);
+
+  expect(
+    buildPatches(
+      { ...patient, name: [{ given: ["bob"] }] },
+      {
+        op: "add",
+        path: descend(descend(descend(descend(loc, "name"), 0), "given"), 1),
+        value: "Jake",
+      }
+    )
+  ).toEqual([
+    {
+      op: "add",
+      path: "/name/0/given/1",
+      value: "Jake",
+    },
+  ]);
+
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "add",
+          path: descend(descend(descend(descend(loc, "name"), 0), "given"), 1),
+          value: "Jake",
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["bob", "Jake"] }] });
+
+  expect(
+    jsonpatch.applyPatch(
+      patient,
+      buildPatches(patient, {
+        op: "add",
+        path: descend(descend(descend(descend(loc, "name"), 0), "given"), 0),
+        value: "test",
+      })
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["test"] }] });
+});
+
+test("replace", () => {
+  const loc = pointer(R4, "Patient", "123" as id);
+  const patient: Patient = { resourceType: "Patient", id: "123" } as Patient;
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "replace",
+          path: descend(descend(descend(descend(loc, "name"), 0), "given"), 0),
+          value: "Jake",
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["Jake"] }] });
+
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "replace",
+          path: descend(descend(descend(descend(loc, "name"), 0), "given"), 1),
+          value: "Jake",
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["bob", "Jake"] }] });
+});
+
+test("removal", () => {
+  const loc = pointer(R4, "Patient", "123" as id);
+  const patient: Patient = { resourceType: "Patient", id: "123" } as Patient;
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "remove",
+          path: descend(descend(descend(descend(loc, "name"), 0), "given"), 0),
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: [] }] });
+
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "remove",
+          path: descend(descend(descend(descend(loc, "name"), 0), "given"), 1),
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["bob"] }] });
+  expect(
+    jsonpatch.applyPatch(
+      { ...patient, name: [{ given: ["bob"] }] },
+      buildPatches(
+        { ...patient, name: [{ given: ["bob"] }] },
+        {
+          op: "remove",
+          path: descend(descend(descend(loc, "identifier"), 0), "system"),
+        }
+      )
+    ).newDocument
+  ).toEqual({ ...patient, name: [{ given: ["bob"] }] });
+});
+
+test("immutable Patch", () => {
+  const loc = pointer(R4, "Patient", "123" as id);
+  const patient: Patient = { resourceType: "Patient", id: "123" } as Patient;
+  expect(
+    applyMutationImmutable(
+      { ...patient, name: [{ given: ["bob"] }] },
+      {
+        op: "replace",
+        path: descend(descend(descend(descend(loc, "name"), 0), "given"), 1),
+        value: "Jake",
+      }
+    )
+  ).toEqual({ ...patient, name: [{ given: ["bob", "Jake"] }] });
+});

package/src/index.ts

@@ -0,0 +1,144 @@
+import jsonpatch, { Operation } from "fast-json-patch";
+import { produce } from "immer";
+
+import * as fpt from "@haste-health/fhir-pointer";
+import { Resource, id } from "@haste-health/fhir-types/r4/types";
+import { R4 } from "@haste-health/fhir-types/versions";
+
+export interface Mutation<T, R> {
+  path: fpt.Loc<T, R, any>;
+  op: "add" | "remove" | "replace";
+  value?: R;
+}
+
+function getValue<T extends object, R>(
+  value: T,
+  pointer: fpt.Loc<T, R, any>
+): R {
+  return fpt.get(pointer, value);
+}
+
+function valueExists<T extends object, R>(
+  value: T,
+  json_pointer: fpt.Loc<T, R, any>
+) {
+  return getValue(value, json_pointer) !== undefined;
+}
+
+function deriveNextValuePlaceHolder(
+  fields: (string | number | symbol)[]
+): Array<unknown> | Record<string, unknown> {
+  if (typeof fields[1] === "number") {
+    return [];
+  }
+  return {};
+}
+
+function createPatchesNonExistantFields<T extends Record<string, any>, R>(
+  resource: T,
+  path: fpt.Loc<T, R, any>
+) {
+  const fields = fpt.fields(path);
+
+  let patches: Operation[] = [];
+  let curValue = resource as unknown;
+  let curPointer: fpt.Loc<T, any, any> = fpt.pointer(
+    R4,
+    resource.resourceType,
+    resource.id as id
+  );
+  for (let i = 0; i < fields.length; i++) {
+    curPointer = fpt.descend(curPointer, fields[i]);
+    curValue = getValue(resource, curPointer);
+    if (curValue === undefined) {
+      const nextValue = deriveNextValuePlaceHolder(fields.slice(i));
+      patches = [
+        ...patches,
+        { op: "add", path: fpt.toJSONPointer(curPointer), value: nextValue },
+      ];
+    }
+  }
+  return patches;
+}
+
+export default function buildPatches<T extends Resource, R>(
+  value: T,
+  mutation: Mutation<T, R>
+): Operation[] {
+  // Builds patches with a given mutation to include non existant values up to the point in the path
+  // where the mutation occurs
+
+  switch (mutation.op) {
+    case "remove": {
+      if (valueExists(value, mutation.path)) {
+        return [
+          {
+            op: "remove",
+            path: fpt.toJSONPointer(mutation.path),
+          },
+        ];
+      }
+      return [];
+    }
+    case "add": {
+      const patches = createPatchesNonExistantFields(value, mutation.path);
+      //If last is adding value remove here as collection will only add once.
+      if (
+        patches[patches.length - 1]?.op === "add" &&
+        patches[patches.length - 1]?.path === fpt.toJSONPointer(mutation.path)
+      ) {
+        return [
+          ...patches.slice(0, patches.length - 1),
+          {
+            op: "add",
+            path: fpt.toJSONPointer(mutation.path),
+            value: mutation.value,
+          },
+        ];
+      }
+      return [
+        ...patches,
+        {
+          op: "add",
+          path: fpt.toJSONPointer(mutation.path),
+          value: mutation.value,
+        },
+      ];
+    }
+    case "replace": {
+      if (mutation.value === undefined || mutation.value === null) {
+        return buildPatches(value, {
+          op: "remove",
+          path: mutation.path,
+        });
+      }
+      const patches = createPatchesNonExistantFields(value, mutation.path);
+      return [
+        ...patches,
+        {
+          op: "replace",
+          path: fpt.toJSONPointer(mutation.path),
+          value: mutation.value,
+        },
+      ];
+    }
+    default:
+      throw new Error(`Invalid operation '${mutation.op}'`);
+  }
+}
+
+export function applyMutation<T extends Resource, R>(
+  value: T,
+  mutation: Mutation<T, R>
+): T {
+  return jsonpatch.applyPatch(value, buildPatches(value, mutation)).newDocument;
+}
+
+export function applyMutationImmutable<T extends Resource, R>(
+  value: T,
+  mutation: Mutation<T, R>
+): T {
+  return produce(value, (v) => {
+    applyMutation(v as T, mutation);
+  });
+}