feat: generate signature

Author: froesecom

package-lock.json

@@ -12,7 +12,7 @@
   "scripts": {
     "lint": "eslint ./src/* && prettier ./ --check",
     "pretty": "prettier ./ --write",
-    "type-check": "tsc --noEmit src/**/*",
+    "type-check": "tsc --noEmit",
     "build": "tsup",
     "test": "jest"
   },
@@ -25,6 +25,7 @@
     "@eslint/js": "^9.11.1",
     "@types/eslint__js": "^8.42.3",
     "@types/jest": "^29.5.13",
+    "@types/jsonwebtoken": "^9.0.7",
     "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jest": "^28.8.3",

package.json

@@ -1,5 +1,6 @@
 import { TEST_KEY } from "../__test__/TEST_KEY"
 import { DatarockClient } from "./Client"
+
 describe("DatarockClient", () => {
   const email = "[email protected]"
   const privateKey = TEST_KEY

src/lib/Client.test.ts

@@ -0,0 +1,31 @@
+import { generateRequestHeaders } from "./utils"
+import { TEST_KEY } from "../__test__/TEST_KEY"
+
+describe("generateRequestHeaders()", () => {
+  const email = "[email protected]"
+  const requestUrl = "https://someurl.com"
+
+  it("generates request headers", () => {
+    const headers = generateRequestHeaders({
+      email,
+      privateKey: TEST_KEY,
+      requestUrl,
+    })
+    const expected = {
+      signature: expect.any(String),
+      "x-api-user": email,
+    }
+    expect(headers).toEqual(expected)
+  })
+
+  test.each`
+    privateKey   | requestUrl    | email        | issuedTime
+    ${undefined} | ${requestUrl} | ${email}     | ${new Date()}
+    ${TEST_KEY}  | ${undefined}  | ${email}     | ${new Date()}
+    ${TEST_KEY}  | ${requestUrl} | ${undefined} | ${new Date()}
+  `("throws an error if headers are missing", (headers) => {
+    expect(() => {
+      generateRequestHeaders(headers)
+    }).toThrow("is required when generating request headers!")
+  })
+})

src/lib/utils.test.ts

@@ -0,0 +1,37 @@
+import { createHash } from "crypto"
+import jwt from "jsonwebtoken"
+
+const REQUIRED_PARAMS = ["privateKey", "requestUrl", "email", "issuedTime"]
+interface RequestParams {
+  privateKey: string
+  requestUrl: string
+  email: string
+  issuedTime?: Date
+}
+function validatRequestParams(params: RequestParams): void {
+  REQUIRED_PARAMS.forEach((key) => {
+    // @ts-expect-error the keys match RequestParams
+    if (!params[key] || params[key] === "") {
+      throw new Error(`${key} is required when generating request headers!`)
+    }
+  })
+}
+export function generateRequestHeaders({
+  privateKey,
+  requestUrl,
+  email,
+  issuedTime = new Date(),
+}: RequestParams) {
+  validatRequestParams({ privateKey, requestUrl, email, issuedTime })
+  const iat = Math.floor(issuedTime.getTime() / 1000)
+  const requestStringToHash = `${email}/${iat}/${requestUrl}`
+  const jwtPayload = {
+    requestHash: createHash("sha512").update(requestStringToHash).digest("hex"),
+    iat,
+  }
+
+  return {
+    signature: jwt.sign(jwtPayload, privateKey, { algorithm: "RS256" }),
+    "x-api-user": email,
+  }
+}