Pim 1306

.changeset/witty-years-walk.md

@@ -0,0 +1,5 @@
+---
+"@pimlico/webhook": patch
+---
+
+Updated README, added usage example

.github/workflows/on-pull-request.yml

@@ -44,8 +44,14 @@ jobs:
       - name: Install dependencies
         uses: ./.github/actions/install-dependencies
 
-      - name: Report bundle size
-        uses: andresz1/size-limit-action@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          package_manager: pnpm
+      - name: Build
+        run: pnpm build
+
+      - name: Size
+        run: pnpm size
+
+      # - name: Report bundle size
+      #   uses: andresz1/size-limit-action@master
+      #   with:
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      #     # package_manager: pnpm

package.json

@@ -2,6 +2,7 @@
     "description": "",
     "main": "index.js",
     "scripts": {
+        "size": "size-limit",
         "lint": "biome check --fix --error-on-warnings .",
         "format": "biome format --write .",
         "webhook": "pnpm --filter @pimlico/webhook",
@@ -24,8 +25,26 @@
         "@changesets/changelog-git": "^0.2.0",
         "@changesets/changelog-github": "^0.5.0",
         "@changesets/cli": "^2.27.10",
+        "@size-limit/preset-small-lib": "^11.1.6",
         "@types/node": "^20.11.18",
+        "esbuild": "^0.24.0",
         "rimraf": "^6.0.1",
+        "size-limit": "^11.1.6",
+        "size-limit-node-esbuild": "^0.3.0",
         "tsc-alias": "^1.8.10"
-    }
+    },
+    "size-limit": [
+        {
+            "name": "@pimlico/webhook (esm)",
+            "path": "./packages/webhook/_esm/src/index.js",
+            "limit": "50 kB",
+            "import": "*"
+        },
+        {
+            "name": "@pimlico/webhook (cjs)",
+            "path": "./packages/webhook/_cjs/src/index.js",
+            "limit": "50 kB",
+            "import": "*"
+        }
+    ]
 }

packages/webhook/README.md

@@ -0,0 +1,22 @@
+# @pimlico/webhook
+
+A library for verifying webhook requests from Pimlico. [Example](./../../examples/webhook).
+
+## Installation
+
+```bash
+pnpm install @pimlico/webhook
+```
+
+## Usage
+
+```typescript
+import { pimlicoWebhookVerifier } from "@pimlico/webhook"
+
+const verifyWebhook = pimlicoWebhookVerifier(process.env.PIMLICO_API_KEY)
+
+const body = await verifyWebhook(
+    req.headers as Record<string, string>,
+    Buffer.from(JSON.stringify(req.body))
+)
+```