feat(primitives): implement id type

packages/primitives/src/id.ts

@@ -0,0 +1,22 @@
+/**
+ * ID FHIR Primitive Runtime Type
+ */
+
+import { Type, success, failure, identity } from "io-ts";
+
+// TODO: This regex seems incorrect as well
+const ID_REGEX = /[A-Za-z0-9\-\.]{1,64}/;
+
+export class IDType extends Type<string> {
+  readonly _tag: "IDType" = "IDType";
+  constructor() {
+    super(
+      "id",
+      (m): m is string => typeof m === "string" && ID_REGEX.test(m),
+      (m, c) => (this.is(m) ? success(m) : failure(m, c)),
+      identity
+    );
+  }
+}
+
+export const id = new IDType();

packages/primitives/src/index.ts

@@ -8,6 +8,7 @@ import { CanonicalType, canonical } from "./canonical";
 import { CodeType, code } from "./code";
 import { DateType, date } from "./date";
 import { DecimalType, decimal } from "./decimal";
+import { IDType, id } from "./id";
 import { InstantType, instant } from "./instant";
 import { IntegerType, integer } from "./integer";
 import { OIDType, oid } from "./oid";
@@ -29,6 +30,8 @@ export {
   DateType,
   decimal,
   DecimalType,
+  id,
+  IDType,
   instant,
   InstantType,
   integer,

packages/primitives/test/id.test.ts

@@ -0,0 +1,53 @@
+/**
+ * Tests for ID Runtime Type
+ */
+
+import { assertSuccess, assertFailure, assertStrictEqual } from "./helpers";
+import { id } from "../src";
+
+describe("IDType", () => {
+  it("should succeed validating a valid value", () => {
+    const T = id;
+    const input = "5e8c5a39-ac09-4a1e-9769-c61192b4355d";
+    assertSuccess(T.decode(input));
+  });
+
+  it("should return the same reference if validation succeeded and nothing changed", () => {
+    const T = id;
+    const value = "5e8c5a39-ac09-4a1e-9769-c61192b4355d";
+    assertStrictEqual(T.decode(value), value);
+  });
+
+  it("should fail validating an invalid value", () => {
+    const T = id;
+    assertFailure(T.decode(2), ["Invalid value 2 supplied to : id"]);
+  });
+
+  // TODO: Improve regex so this fails
+  xit("should fail validating a string that doesn't match regex", () => {
+    const T = id;
+    assertFailure(T.decode("invalid{}"), [
+      'Invalid value "invalid{}" supplied to : id'
+    ]);
+  });
+
+  // TODO: Improve regex so this fails
+  xit("should fail validating a string that is greater than 64 characters", () => {
+    const T = id;
+    assertFailure(
+      T.decode(
+        "5e8c5a39-ac09-4a1e-9769-c61192b4355d5e8c5a39-ac09-4a1e-9769-c61192b4355d"
+      ),
+      [
+        'Invalid value "5e8c5a39-ac09-4a1e-9769-c61192b4355d5e8c5a39-ac09-4a1e-9769-c61192b4355d" supplied to : id'
+      ]
+    );
+  });
+
+  it("should type guard", () => {
+    const T = id;
+    expect(T.is("5e8c5a39-ac09-4a1e-9769-c61192b4355d")).toEqual(true);
+    expect(T.is(2)).toEqual(false);
+    expect(T.is(undefined)).toEqual(false);
+  });
+});