@replayio-app-building/netlify-recorder 0.2.0 → 0.3.0

package/README.md

@@ -66,7 +66,7 @@ const handler: Handler = async (event) => {
 export { handler };
 ```
 
-That's it for capturing. The `remoteCallbacks(url)` helper sends the captured blob data to the Netlify Recorder service, which uploads it to blob storage and stores the request metadata. The response includes an `X-Replay-Request-Id` header with the request ID managed by the service.
+That's it for capturing. The `remoteCallbacks(url)` helper sends the captured blob data to the Netlify Recorder service's `/api/store-request` endpoint, which uploads it to blob storage and stores the request metadata. The response includes an `X-Replay-Request-Id` header with the request ID managed by the service.
 
 ### 2. Create recordings
 
@@ -74,40 +74,21 @@ When you want to turn a captured request into a Replay recording, POST to the se
 
 ```typescript
 const response = await fetch(
-  `${RECORDER_URL}/.netlify/functions/create-recording`,
-  {
-    method: "POST",
-    headers: { "Content-Type": "application/json" },
-    body: JSON.stringify({ requestId }),
-  }
-);
-```
-
-The service looks up the stored blob data, dispatches the work to a pool container, and creates the recording. You can check the recording status via the service's Requests page, or provide a webhook to be notified on completion.
-
-### 3. (Optional) Get notified when recordings complete
-
-If you want to be notified when a recording finishes, call the blob endpoint directly with a `webhookUrl`:
-
-```typescript
-await fetch(
-  `${RECORDER_URL}/.netlify/functions/create-recording-from-blob-background`,
+  `${RECORDER_URL}/api/create-recording`,
   {
     method: "POST",
     headers: { "Content-Type": "application/json" },
     body: JSON.stringify({
-      blobUrl: "https://...",         // blob URL from the service
-      handlerPath: "netlify/functions/my-handler",
-      commitSha: "a1b2c3d4...",
-      branchName: "main",
-      repositoryUrl: "https://github.com/your-org/your-repo",
-      webhookUrl: "https://your-app.netlify.app/.netlify/functions/on-recording-complete",
+      requestId,
+      webhookUrl: "https://your-app.netlify.app/api/on-recording-complete", // optional
     }),
   }
 );
 ```
 
-**Webhook payload (POSTed to `webhookUrl`):**
+The service looks up the stored blob data, dispatches the work to a pool container, and creates the recording.
+
+If `webhookUrl` is provided, the service will POST the result to that URL when the recording completes (or fails):
 
 On success:
 ```json
@@ -119,6 +100,19 @@ On failure:
 { "status": "failed", "error": "Error message" }
 ```
 
+### 3. Check recording status
+
+You can poll the recording status at any time:
+
+```typescript
+const res = await fetch(
+  `${RECORDER_URL}/api/get-request?requestId=${requestId}`
+);
+const { status, recordingId } = await res.json();
+// status: "captured" | "processing" | "recorded" | "failed"
+// recordingId: string | null
+```
+
 ---
 
 ## Option B: Self-Hosted

package/dist/index.d.ts

@@ -124,8 +124,8 @@ declare function finishRequest(requestContext: RequestContext, callbacks: Finish
  * to set up its own blob storage or database tables.
  *
  * The callbacks upload blob data and store request metadata via the
- * service's `store-request` endpoint, which handles UploadThing storage
- * and database insertion.
+ * service's `/api/store-request` endpoint, which handles UploadThing
+ * storage and database insertion.
  *
  * @param serviceUrl - Base URL of the Netlify Recorder service
  *   (e.g. "https://netlify-recorder-bm4wmw.netlify.app")

package/dist/index.js

@@ -319,7 +319,7 @@ function remoteCallbacks(serviceUrl) {
         );
       }
       const res = await fetch(
-        `${base}/.netlify/functions/store-request`,
+        `${base}/api/store-request`,
         {
           method: "POST",
           headers: { "Content-Type": "application/json" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@replayio-app-building/netlify-recorder",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Capture and replay Netlify function executions as Replay recordings",
   "type": "module",
   "exports": {