@haste-health/jwt 0.11.2

package/README.md

@@ -0,0 +1,122 @@
+# JWT
+
+JWT utility functions for creating and parsing JWTs. Tags JWTS with Payload so serialize and deserialize will return back payload type.
+
+## Types
+
+```typescript
+export interface AccessTokenPayload<role> {
+  /**
+   * REQUIRED. Issuer Identifier for the Issuer of the response.
+   * The iss value is a case-sensitive URL using the https scheme that contains scheme, host, and optionally,
+   *  port number and path components and no query or fragment components.
+   */
+  iss: Issuer;
+  /**
+   * sub REQUIRED. Subject Identifier.
+   * A locally unique and never reassigned identifier within the Issuer for the End-User,
+   * which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4.
+   * It MUST NOT exceed 255 ASCII [RFC20] characters in length. The sub value is a case-sensitive string.
+   */
+  sub: Subject;
+  /**
+   * Token can be associated with an Operation, Client or Membership this claim distinguishes between the three.
+   */
+  [CUSTOM_CLAIMS.RESOURCE_TYPE]: TOKEN_RESOURCE_TYPES;
+  /**
+   * The ID of the resource the token is associated with.
+   */
+  [CUSTOM_CLAIMS.RESOURCE_ID]?: id;
+  /**
+   * What tenants the user has access to.
+   */
+  [CUSTOM_CLAIMS.TENANTS]: TenantClaim<role>[];
+
+  /**
+   * Allow token to have additional claims.
+   */
+  [key: string]: unknown;
+}
+
+/**
+ * ID Token Payload. Extends Access token with additional claims from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
+ */
+export interface IDTokenPayload<role> extends AccessTokenPayload<role> {
+  /**
+   * End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
+   */
+  name?: string;
+  /**
+   *  Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
+   */
+  given_name?: string;
+  /**
+   * Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
+   */
+  family_name?: string;
+  /**
+   * Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
+   */
+  middle_name?: string;
+  /**
+   * Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
+   */
+  nickname?: string;
+  /**
+   * Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+   */
+  preferred_username?: string;
+  /**
+   * URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
+   */
+  profile?: string;
+  /**
+   * URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
+   */
+  picture?: string;
+  /**
+   * URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
+   */
+  website?: string;
+  /**
+   * End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+   */
+  email?: string;
+  /**
+   * True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
+   */
+  email_verified?: boolean;
+  /**
+   * End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
+   */
+  gender?: string;
+  /**
+   * End-User's birthday, represented as an ISO 8601-1 [ISO8601‑1] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
+   */
+  birthdate?: string;
+  /**
+   * String from IANA Time Zone Database [IANA.time‑zones] representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
+   */
+  zoneinfo?: string;
+  /**
+   * End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639 Alpha-2 [ISO639] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
+   */
+  locale?: string;
+  /**
+   * End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
+   */
+  phone_number?: string;
+  /**
+   * True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
+   */
+  phone_number_verified?: boolean;
+  /**
+   * JSON object	End-User's preferred postal address. The value of the address member is a JSON [RFC8259] structure containing some or all of the members defined in Section 5.1.1.
+   */
+  address?: Address;
+  /**
+   * Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time.
+   */
+  updated_at?: number;
+}
+```

package/lib/certifications.d.ts

@@ -0,0 +1,71 @@
+import { ALGORITHMS_ALLOWED } from "./constants.js";
+interface BaseOption {
+    alg: ALGORITHMS_ALLOWED;
+}
+interface JWTCertificationFileConfig extends BaseOption {
+    type: "file";
+    directory: string;
+    kid: string;
+}
+interface JWTCertificationEnvironmentConfig extends BaseOption {
+    type: "environment";
+    kid: string;
+    privateKey: string;
+    publicKey: string;
+}
+/**
+ *
+ * @param directory
+ * @param alg
+ * @returns JSON Web Key Set with all public keys in the directory. Uses filename to distinguish between keys (sets the kid field in the JWK).
+ */
+export declare function getJWKS(option: JWTCertificationConfig): Promise<{
+    keys: {
+        alg: ALGORITHMS_ALLOWED;
+        use: string;
+        kid: string;
+        crv?: string;
+        d?: string;
+        dp?: string;
+        dq?: string;
+        e?: string;
+        k?: string;
+        n?: string;
+        p?: string;
+        q?: string;
+        qi?: string;
+        x?: string;
+        y?: string;
+        pub?: string;
+        priv?: string;
+        kty?: string;
+        key_ops?: string[];
+        ext?: boolean;
+        x5c?: string[];
+        x5t?: string;
+        'x5t#S256'?: string;
+        x5u?: string;
+    }[];
+}>;
+export type JWTCertificationConfig = JWTCertificationFileConfig | JWTCertificationEnvironmentConfig;
+/**
+ *
+ * @param directory
+ * @param kid
+ * @param alg
+ * @returns Returns the private key for a given kid.
+ */
+export declare function getSigningKey(option: JWTCertificationConfig): Promise<{
+    key: CryptoKey;
+    kid: string;
+}>;
+/**
+ * Create certifications if not exist. Saves by default
+ * private keys under /${directory}/{kid}.p8 and public keys under /${directory}/{kid}.spki.
+ * Should only be used in development environment as these should be injected in environment in prod.
+ * @param directory
+ * @param kid
+ * @param alg
+ */
+export declare function createCertsIfNoneExists(option: JWTCertificationConfig): Promise<void>;
+export {};

package/lib/certifications.js

@@ -0,0 +1,84 @@
+import * as jose from "jose";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+/**
+ * Generates a keypair using the provided algorithm.
+ * @param alg
+ * @returns privateKey and publicKey generated using jose library.
+ */
+async function generateKeyPair(alg, options) {
+    const { privateKey, publicKey } = await jose.generateKeyPair(alg, options);
+    return { privateKey, publicKey };
+}
+async function writeToFile(directory, kid, publicKey, privateKey) {
+    const p8PublicKey = await jose.exportSPKI(publicKey);
+    const p8Private = await jose.exportPKCS8(privateKey);
+    if (!existsSync(directory)) {
+        mkdirSync(directory, { recursive: true });
+    }
+    writeFileSync(path.join(directory, `${kid}.spki`), p8PublicKey);
+    writeFileSync(path.join(directory, `${kid}.p8`), p8Private);
+}
+async function getPublicPrivateKey(option) {
+    switch (option.type) {
+        case "environment": {
+            const publicKey = await jose.importSPKI(option.publicKey, option.alg);
+            const privateKey = await jose.importPKCS8(option.privateKey, option.alg);
+            return { publicKey, privateKey };
+        }
+        case "file": {
+            const publicKey = await jose.importSPKI(readFileSync(path.join(option.directory, `${option.kid}.spki`), "utf-8"), option.alg);
+            const privateKey = await jose.importPKCS8(readFileSync(path.join(option.directory, `${option.kid}.p8`), "utf-8"), option.alg);
+            return { privateKey, publicKey };
+        }
+    }
+}
+/**
+ *
+ * @param directory
+ * @param alg
+ * @returns JSON Web Key Set with all public keys in the directory. Uses filename to distinguish between keys (sets the kid field in the JWK).
+ */
+export async function getJWKS(option) {
+    const { publicKey } = await getPublicPrivateKey(option);
+    const pubJWK = await jose.exportJWK(publicKey);
+    return {
+        keys: [{ ...pubJWK, alg: option.alg, use: "sig", kid: option.kid }],
+    };
+}
+/**
+ *
+ * @param directory
+ * @param kid
+ * @param alg
+ * @returns Returns the private key for a given kid.
+ */
+export async function getSigningKey(option) {
+    const { privateKey } = await getPublicPrivateKey(option);
+    return {
+        key: privateKey,
+        kid: option.kid,
+    };
+}
+/**
+ * Create certifications if not exist. Saves by default
+ * private keys under /${directory}/{kid}.p8 and public keys under /${directory}/{kid}.spki.
+ * Should only be used in development environment as these should be injected in environment in prod.
+ * @param directory
+ * @param kid
+ * @param alg
+ */
+export async function createCertsIfNoneExists(option) {
+    try {
+        await getSigningKey(option);
+    }
+    catch {
+        if (option.type === "environment")
+            throw new Error(`Cannot create certs for 'environment' type.`);
+        const { publicKey, privateKey } = await generateKeyPair(option.alg, {
+            extractable: true,
+        });
+        await writeToFile(option.directory, option.kid, publicKey, privateKey);
+    }
+}
+//# sourceMappingURL=certifications.js.map

package/lib/certifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"certifications.js","sourceRoot":"","sources":["../src/certifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,IAAI,MAAM,WAAW,CAAC;AAqB7B;;;;GAIG;AACH,KAAK,UAAU,eAAe,CAC5B,GAAuB,EACvB,OAAiC;IAEjC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3E,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,SAAiB,EACjB,GAAW,EACX,SAAoB,EACpB,UAAqB;IAErB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAErD,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC;IAChE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;AAC9D,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,MAA8B;IAI/D,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YACtE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YACzE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QACnC,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CACrC,YAAY,CACV,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,EACjD,OAAO,CACR,EACD,MAAM,CAAC,GAAG,CACX,CAAC;YACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CACvC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC,EAAE,OAAO,CAAC,EACtE,MAAM,CAAC,GAAG,CACX,CAAC;YAEF,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QACnC,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,MAA8B;IAC1D,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;KACpE,CAAC;AACJ,CAAC;AAMD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACzD,OAAO;QACL,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,MAAM,CAAC,GAAG;KAChB,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,MAA8B;IAC1E,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa;YAC/B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAEjE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE;YAClE,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,MAAM,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;AACH,CAAC"}

package/lib/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const CUSTOM_CLAIMS: {
+    RESOURCE_TYPE: "https://haste.health/resourceType";
+    RESOURCE_ID: "https://haste.health/resourceId";
+    ACCESS_POLICY_VERSION_IDS: "https://haste.health/accessPolicyVersionIds";
+    TENANT: "https://haste.health/tenant";
+    ROLE: "https://haste.health/user_role";
+};
+export type ALGORITHMS_ALLOWED = (typeof ALGORITHMS)[keyof typeof ALGORITHMS];
+export declare const ALGORITHMS: {
+    readonly RS256: "RS256";
+    readonly RS384: "RS384";
+};

package/lib/constants.js

@@ -0,0 +1,12 @@
+export const CUSTOM_CLAIMS = {
+    RESOURCE_TYPE: "https://haste.health/resourceType",
+    RESOURCE_ID: "https://haste.health/resourceId",
+    ACCESS_POLICY_VERSION_IDS: ("https://haste.health/accessPolicyVersionIds"),
+    TENANT: "https://haste.health/tenant",
+    ROLE: "https://haste.health/user_role",
+};
+export const ALGORITHMS = {
+    RS256: "RS256",
+    RS384: "RS384",
+};
+//# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,aAAa,EAAS,mCAAmC;IACzD,WAAW,EAAS,iCAAiC;IACrD,yBAAyB,EAAS,CAChC,6CAA6C,CAC9C;IACD,MAAM,EAAS,6BAA6B;IAC5C,IAAI,EAAS,gCAAgC;CAC9C,CAAC;AAIF,MAAM,CAAC,MAAM,UAAU,GAAU;IAC/B,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;CACf,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./token.js";
+export * from "./constants.js";
+export * from "./certifications.js";

package/lib/index.js

@@ -0,0 +1,5 @@
+export * from "./types.js";
+export * from "./token.js";
+export * from "./constants.js";
+export * from "./certifications.js";
+//# 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,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/lib/token.d.ts

@@ -0,0 +1,14 @@
+import * as jose from "jose";
+import { JWT } from "./types.js";
+export declare function parseJwt<A, Token extends JWT<A>>(token: Token): Token["payload"];
+/**
+ * Creates a JWT token using the provided private key and payload.
+ */
+export declare function createToken<Payload extends jose.JWTPayload>({ signingKey, payload, expiresIn, }: {
+    signingKey: {
+        kid: string;
+        key: CryptoKey;
+    };
+    payload: Payload;
+    expiresIn?: string;
+}): Promise<JWT<Payload>>;

package/lib/token.js

@@ -0,0 +1,26 @@
+import * as jose from "jose";
+import { ALGORITHMS } from "./types.js";
+export function parseJwt(token) {
+    const base64Url = token.split(".")[1];
+    const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+    const jsonPayload = decodeURIComponent(window
+        .atob(base64)
+        .split("")
+        .map(function (c) {
+        return "%" + ("00" + c.charCodeAt(0).toString(16)).slice(-2);
+    })
+        .join(""));
+    return JSON.parse(jsonPayload);
+}
+/**
+ * Creates a JWT token using the provided private key and payload.
+ */
+export async function createToken({ signingKey, payload, expiresIn = "1h", }) {
+    const signedJWT = (await new jose.SignJWT(payload)
+        .setProtectedHeader({ kid: signingKey.kid, alg: ALGORITHMS.RS384 })
+        .setIssuedAt()
+        .setExpirationTime(expiresIn)
+        .sign(signingKey.key));
+    return signedJWT;
+}
+//# sourceMappingURL=token.js.map

package/lib/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../src/token.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,UAAU,EAAO,MAAM,YAAY,CAAC;AAE7C,MAAM,UAAU,QAAQ,CACtB,KAAY;IAEZ,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/D,MAAM,WAAW,GAAG,kBAAkB,CACpC,MAAM;SACH,IAAI,CAAC,MAAM,CAAC;SACZ,KAAK,CAAC,EAAE,CAAC;SACT,GAAG,CAAC,UAAU,CAAC;QACd,OAAO,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CACZ,CAAC;IAEF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAkC,EACjE,UAAU,EACV,OAAO,EACP,SAAS,GAAG,IAAI,GAKjB;IACC,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAC/C,kBAAkB,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;SAClE,WAAW,EAAE;SACb,iBAAiB,CAAC,SAAS,CAAC;SAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAiB,CAAC;IAEzC,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,162 @@
+import * as jose from "jose";
+import { Address, ClientApplication, Membership, OperationDefinition, Reference, canonical, id } from "@haste-health/fhir-types/r4/types";
+import { CUSTOM_CLAIMS } from "./constants.js";
+export * from "./constants.js";
+declare const __tenant: unique symbol;
+export type TenantId = string & {
+    [__tenant]: string;
+};
+export interface TenantClaim<role> {
+    id: TenantId;
+    userRole: role;
+}
+declare const __project: unique symbol;
+export type ProjectId = string & {
+    [__project]: string;
+};
+declare const __subject: unique symbol;
+export type Subject = string & {
+    [__subject]: string;
+};
+declare const __iss: unique symbol;
+export type Issuer = string & {
+    [__iss]: string;
+};
+export type TOKEN_RESOURCE_TYPES = OperationDefinition["resourceType"] | ClientApplication["resourceType"] | Membership["resourceType"];
+export interface HasteHealthCustomClaims<role> {
+    /**
+     * Token can be associated with an Operation, Client or Membership this claim distinguishes between the three.
+     */
+    [CUSTOM_CLAIMS.RESOURCE_TYPE]: TOKEN_RESOURCE_TYPES;
+    /**
+     * The ID of the resource the token is associated with.
+     */
+    [CUSTOM_CLAIMS.RESOURCE_ID]: id;
+    [CUSTOM_CLAIMS.ACCESS_POLICY_VERSION_IDS]: id[];
+    /**
+     * The users role for the tenant.
+     */
+    [CUSTOM_CLAIMS.ROLE]: role;
+    /**
+     * The tenant the token is associated with.
+     */
+    [CUSTOM_CLAIMS.TENANT]: TenantId;
+}
+export interface SMARTPayload {
+    fhirUser?: canonical;
+    patient?: id;
+    encounter?: id;
+    fhirContext?: Reference[];
+}
+export interface AccessTokenPayload<role> extends HasteHealthCustomClaims<role>, SMARTPayload, jose.JWTPayload {
+    /**
+     * REQUIRED. Issuer Identifier for the Issuer of the response.
+     * The iss value is a case-sensitive URL using the https scheme that contains scheme, host, and optionally,
+     *  port number and path components and no query or fragment components.
+     */
+    iss: Issuer;
+    /**
+     * sub REQUIRED. Subject Identifier.
+     * A locally unique and never reassigned identifier within the Issuer for the End-User,
+     * which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4.
+     * It MUST NOT exceed 255 ASCII [RFC20] characters in length. The sub value is a case-sensitive string.
+     */
+    sub: Subject;
+    /**
+     * REQUIRED. Audience(s) that this ID Token is intended for.
+     * It MUST contain the OAuth 2.0 client_id of the Relying Party as an audience value.
+     * It MAY also contain identifiers for other audiences. In the general case, the aud value is an array of case-sensitive strings.
+     * In the common special case when there is one audience, the aud value MAY be a single case-sensitive string.
+     */
+    aud: string;
+    /**
+     * scope Required. OAuth 2.0 scopes. Space-separated string.
+     */
+    scope: string;
+}
+/**
+ * ID Token Payload. Extends Access token with additional claims from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
+ */
+export interface IDTokenPayload<role> extends AccessTokenPayload<role> {
+    /**
+     * End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
+     */
+    name?: string;
+    /**
+     *  Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
+     */
+    given_name?: string;
+    /**
+     * Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
+     */
+    family_name?: string;
+    /**
+     * Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
+     */
+    middle_name?: string;
+    /**
+     * Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
+     */
+    nickname?: string;
+    /**
+     * Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+     */
+    preferred_username?: string;
+    /**
+     * URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
+     */
+    profile?: string;
+    /**
+     * URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
+     */
+    picture?: string;
+    /**
+     * URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
+     */
+    website?: string;
+    /**
+     * End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+     */
+    email?: string;
+    /**
+     * True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
+     */
+    email_verified?: boolean;
+    /**
+     * End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
+     */
+    gender?: string;
+    /**
+     * End-User's birthday, represented as an ISO 8601-1 [ISO8601‑1] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
+     */
+    birthdate?: string;
+    /**
+     * String from IANA Time Zone Database [IANA.time‑zones] representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
+     */
+    zoneinfo?: string;
+    /**
+     * End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639 Alpha-2 [ISO639] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
+     */
+    locale?: string;
+    /**
+     * End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
+     */
+    phone_number?: string;
+    /**
+     * True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
+     */
+    phone_number_verified?: boolean;
+    /**
+     * JSON object	End-User's preferred postal address. The value of the address member is a JSON [RFC8259] structure containing some or all of the members defined in Section 5.1.1.
+     */
+    address?: Address;
+    /**
+     * Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time.
+     */
+    updated_at?: number;
+}
+export type JWT<Payload> = string & {
+    ["payload"]: Payload;
+};
+export type AccessToken<role> = JWT<AccessTokenPayload<role>>;
+export type IDToken<role> = JWT<IDTokenPayload<role>>;

package/lib/types.js

@@ -0,0 +1,3 @@
+import { CUSTOM_CLAIMS } from "./constants.js";
+export * from "./constants.js";
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@haste-health/jwt",
+  "version": "0.11.2",
+  "dependencies": {
+    "jose": "^6.0.11"
+  },
+  "type": "module",
+  "description": "JWT utilities for Igu Health",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "publish": "pnpm build && pnpm npm publish --access public --tolerate-republish"
+  },
+  "devDependencies": {
+    "@haste-health/fhir-types": "workspace:^",
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^24.3.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.2",
+    "typescript": "5.9.2"
+  },
+  "exports": {
+    ".": "./lib/index.js",
+    "./token": "./lib/token.js",
+    "./certifications": "./lib/certifications.js",
+    "./types": "./lib/types.js"
+  },
+  "files": [
+    "lib/**",
+    "src/**"
+  ]
+}

package/src/certifications.ts

@@ -0,0 +1,139 @@
+import * as jose from "jose";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+
+import { ALGORITHMS_ALLOWED } from "./constants.js";
+
+interface BaseOption {
+  alg: ALGORITHMS_ALLOWED;
+}
+
+interface JWTCertificationFileConfig extends BaseOption {
+  type: "file";
+  directory: string;
+  kid: string;
+}
+
+interface JWTCertificationEnvironmentConfig extends BaseOption {
+  type: "environment";
+  kid: string;
+  privateKey: string;
+  publicKey: string;
+}
+
+/**
+ * Generates a keypair using the provided algorithm.
+ * @param alg
+ * @returns privateKey and publicKey generated using jose library.
+ */
+async function generateKeyPair(
+  alg: ALGORITHMS_ALLOWED,
+  options: { extractable: boolean },
+) {
+  const { privateKey, publicKey } = await jose.generateKeyPair(alg, options);
+  return { privateKey, publicKey };
+}
+
+async function writeToFile(
+  directory: string,
+  kid: string,
+  publicKey: CryptoKey,
+  privateKey: CryptoKey,
+) {
+  const p8PublicKey = await jose.exportSPKI(publicKey);
+  const p8Private = await jose.exportPKCS8(privateKey);
+
+  if (!existsSync(directory)) {
+    mkdirSync(directory, { recursive: true });
+  }
+
+  writeFileSync(path.join(directory, `${kid}.spki`), p8PublicKey);
+  writeFileSync(path.join(directory, `${kid}.p8`), p8Private);
+}
+
+async function getPublicPrivateKey(option: JWTCertificationConfig): Promise<{
+  publicKey: CryptoKey;
+  privateKey: CryptoKey;
+}> {
+  switch (option.type) {
+    case "environment": {
+      const publicKey = await jose.importSPKI(option.publicKey, option.alg);
+      const privateKey = await jose.importPKCS8(option.privateKey, option.alg);
+      return { publicKey, privateKey };
+    }
+    case "file": {
+      const publicKey = await jose.importSPKI(
+        readFileSync(
+          path.join(option.directory, `${option.kid}.spki`),
+          "utf-8",
+        ),
+        option.alg,
+      );
+      const privateKey = await jose.importPKCS8(
+        readFileSync(path.join(option.directory, `${option.kid}.p8`), "utf-8"),
+        option.alg,
+      );
+
+      return { privateKey, publicKey };
+    }
+  }
+}
+
+/**
+ *
+ * @param directory
+ * @param alg
+ * @returns JSON Web Key Set with all public keys in the directory. Uses filename to distinguish between keys (sets the kid field in the JWK).
+ */
+export async function getJWKS(option: JWTCertificationConfig) {
+  const { publicKey } = await getPublicPrivateKey(option);
+
+  const pubJWK = await jose.exportJWK(publicKey);
+
+  return {
+    keys: [{ ...pubJWK, alg: option.alg, use: "sig", kid: option.kid }],
+  };
+}
+
+export type JWTCertificationConfig =
+  | JWTCertificationFileConfig
+  | JWTCertificationEnvironmentConfig;
+
+/**
+ *
+ * @param directory
+ * @param kid
+ * @param alg
+ * @returns Returns the private key for a given kid.
+ */
+export async function getSigningKey(
+  option: JWTCertificationConfig,
+): Promise<{ key: CryptoKey; kid: string }> {
+  const { privateKey } = await getPublicPrivateKey(option);
+  return {
+    key: privateKey,
+    kid: option.kid,
+  };
+}
+
+/**
+ * Create certifications if not exist. Saves by default
+ * private keys under /${directory}/{kid}.p8 and public keys under /${directory}/{kid}.spki.
+ * Should only be used in development environment as these should be injected in environment in prod.
+ * @param directory
+ * @param kid
+ * @param alg
+ */
+export async function createCertsIfNoneExists(option: JWTCertificationConfig) {
+  try {
+    await getSigningKey(option);
+  } catch {
+    if (option.type === "environment")
+      throw new Error(`Cannot create certs for 'environment' type.`);
+
+    const { publicKey, privateKey } = await generateKeyPair(option.alg, {
+      extractable: true,
+    });
+    await writeToFile(option.directory, option.kid, publicKey, privateKey);
+  }
+}

package/src/constants.ts

@@ -0,0 +1,16 @@
+export const CUSTOM_CLAIMS = {
+  RESOURCE_TYPE: <const>"https://haste.health/resourceType",
+  RESOURCE_ID: <const>"https://haste.health/resourceId",
+  ACCESS_POLICY_VERSION_IDS: <const>(
+    "https://haste.health/accessPolicyVersionIds"
+  ),
+  TENANT: <const>"https://haste.health/tenant",
+  ROLE: <const>"https://haste.health/user_role",
+};
+
+export type ALGORITHMS_ALLOWED = (typeof ALGORITHMS)[keyof typeof ALGORITHMS];
+
+export const ALGORITHMS = <const>{
+  RS256: "RS256",
+  RS384: "RS384",
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./token.js";
+export * from "./constants.js";
+export * from "./certifications.js";

package/src/token.ts

@@ -0,0 +1,42 @@
+import * as jose from "jose";
+
+import { ALGORITHMS, JWT } from "./types.js";
+
+export function parseJwt<A, Token extends JWT<A>>(
+  token: Token,
+): Token["payload"] {
+  const base64Url = token.split(".")[1];
+  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+  const jsonPayload = decodeURIComponent(
+    window
+      .atob(base64)
+      .split("")
+      .map(function (c) {
+        return "%" + ("00" + c.charCodeAt(0).toString(16)).slice(-2);
+      })
+      .join(""),
+  );
+
+  return JSON.parse(jsonPayload);
+}
+
+/**
+ * Creates a JWT token using the provided private key and payload.
+ */
+export async function createToken<Payload extends jose.JWTPayload>({
+  signingKey,
+  payload,
+  expiresIn = "1h",
+}: {
+  signingKey: { kid: string; key: CryptoKey };
+  payload: Payload;
+  expiresIn?: string;
+}): Promise<JWT<Payload>> {
+  const signedJWT = (await new jose.SignJWT(payload)
+    .setProtectedHeader({ kid: signingKey.kid, alg: ALGORITHMS.RS384 })
+    .setIssuedAt()
+    .setExpirationTime(expiresIn)
+    .sign(signingKey.key)) as JWT<Payload>;
+
+  return signedJWT;
+}

package/src/types.ts

@@ -0,0 +1,180 @@
+import * as jose from "jose";
+
+import {
+  Address,
+  ClientApplication,
+  Membership,
+  OperationDefinition,
+  Reference,
+  canonical,
+  id,
+} from "@haste-health/fhir-types/r4/types";
+
+import { CUSTOM_CLAIMS } from "./constants.js";
+
+export * from "./constants.js";
+
+declare const __tenant: unique symbol;
+export type TenantId = string & { [__tenant]: string };
+export interface TenantClaim<role> {
+  id: TenantId;
+  userRole: role;
+}
+
+declare const __project: unique symbol;
+export type ProjectId = string & {
+  [__project]: string;
+};
+
+declare const __subject: unique symbol;
+export type Subject = string & { [__subject]: string };
+declare const __iss: unique symbol;
+export type Issuer = string & { [__iss]: string };
+
+export type TOKEN_RESOURCE_TYPES =
+  | OperationDefinition["resourceType"]
+  | ClientApplication["resourceType"]
+  | Membership["resourceType"];
+
+export interface HasteHealthCustomClaims<role> {
+  /**
+   * Token can be associated with an Operation, Client or Membership this claim distinguishes between the three.
+   */
+  [CUSTOM_CLAIMS.RESOURCE_TYPE]: TOKEN_RESOURCE_TYPES;
+  /**
+   * The ID of the resource the token is associated with.
+   */
+  [CUSTOM_CLAIMS.RESOURCE_ID]: id;
+  [CUSTOM_CLAIMS.ACCESS_POLICY_VERSION_IDS]: id[];
+  /**
+   * The users role for the tenant.
+   */
+  [CUSTOM_CLAIMS.ROLE]: role;
+  /**
+   * The tenant the token is associated with.
+   */
+  [CUSTOM_CLAIMS.TENANT]: TenantId;
+}
+
+export interface SMARTPayload {
+  fhirUser?: canonical;
+  patient?: id;
+  encounter?: id;
+  fhirContext?: Reference[];
+}
+
+export interface AccessTokenPayload<role>
+  extends HasteHealthCustomClaims<role>,
+    SMARTPayload,
+    jose.JWTPayload {
+  /**
+   * REQUIRED. Issuer Identifier for the Issuer of the response.
+   * The iss value is a case-sensitive URL using the https scheme that contains scheme, host, and optionally,
+   *  port number and path components and no query or fragment components.
+   */
+  iss: Issuer;
+  /**
+   * sub REQUIRED. Subject Identifier.
+   * A locally unique and never reassigned identifier within the Issuer for the End-User,
+   * which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4.
+   * It MUST NOT exceed 255 ASCII [RFC20] characters in length. The sub value is a case-sensitive string.
+   */
+  sub: Subject;
+  /**
+   * REQUIRED. Audience(s) that this ID Token is intended for.
+   * It MUST contain the OAuth 2.0 client_id of the Relying Party as an audience value.
+   * It MAY also contain identifiers for other audiences. In the general case, the aud value is an array of case-sensitive strings.
+   * In the common special case when there is one audience, the aud value MAY be a single case-sensitive string.
+   */
+  aud: string;
+  /**
+   * scope Required. OAuth 2.0 scopes. Space-separated string.
+   */
+  scope: string;
+}
+
+/**
+ * ID Token Payload. Extends Access token with additional claims from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
+ */
+export interface IDTokenPayload<role> extends AccessTokenPayload<role> {
+  /**
+   * End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
+   */
+  name?: string;
+  /**
+   *  Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
+   */
+  given_name?: string;
+  /**
+   * Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
+   */
+  family_name?: string;
+  /**
+   * Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
+   */
+  middle_name?: string;
+  /**
+   * Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
+   */
+  nickname?: string;
+  /**
+   * Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+   */
+  preferred_username?: string;
+  /**
+   * URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
+   */
+  profile?: string;
+  /**
+   * URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
+   */
+  picture?: string;
+  /**
+   * URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
+   */
+  website?: string;
+  /**
+   * End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
+   */
+  email?: string;
+  /**
+   * True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
+   */
+  email_verified?: boolean;
+  /**
+   * End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
+   */
+  gender?: string;
+  /**
+   * End-User's birthday, represented as an ISO 8601-1 [ISO8601‑1] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
+   */
+  birthdate?: string;
+  /**
+   * String from IANA Time Zone Database [IANA.time‑zones] representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
+   */
+  zoneinfo?: string;
+  /**
+   * End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639 Alpha-2 [ISO639] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
+   */
+  locale?: string;
+  /**
+   * End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
+   */
+  phone_number?: string;
+  /**
+   * True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
+   */
+  phone_number_verified?: boolean;
+  /**
+   * JSON object	End-User's preferred postal address. The value of the address member is a JSON [RFC8259] structure containing some or all of the members defined in Section 5.1.1.
+   */
+  address?: Address;
+  /**
+   * Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time.
+   */
+  updated_at?: number;
+}
+
+export type JWT<Payload> = string & { ["payload"]: Payload };
+export type AccessToken<role> = JWT<AccessTokenPayload<role>>;
+export type IDToken<role> = JWT<IDTokenPayload<role>>;