Merge pull request #33 from open-frames/dj/post-url

Account for button post_url in frameInfo
open-frames · May 2, 2024 · c164bdf · c164bdf
2 parents d2b6b2e + 91dd6df
commit c164bdf
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 7 deletions.
diff --git a/.changeset/rude-chefs-roll.md b/.changeset/rude-chefs-roll.md
@@ -0,0 +1,5 @@
+---
+"@open-frames/proxy-types": patch
+---
+
+add button result type
diff --git a/.changeset/tricky-eyes-trade.md b/.changeset/tricky-eyes-trade.md
@@ -0,0 +1,5 @@
+---
+"@open-frames/proxy": patch
+---
+
+account for button post_url in frameInfo
diff --git a/packages/server/src/parser.test.ts b/packages/server/src/parser.test.ts
@@ -188,8 +188,7 @@ const testCases = [
 			'of:button:1:target': EXPECTED_FRAME_POST_URL,
 			'of:button:1:post_url': EXPECTED_FRAME_TX_POST_URL,
 		},
-		frameInfo: {
-			ogImage: EXPECTED_FRAME_IMAGE,
+		expectedFrameInfo: {
 			acceptedClients: {
 				xmtp: EXPECTED_FRAME_XMTP_VERSION,
 				lens: '2',
@@ -200,13 +199,12 @@ const testCases = [
 				alt: EXPECTED_IMAGE_ALT,
 			},
 			postUrl: EXPECTED_FRAME_POST_URL,
-			state: EXPECTED_FRAME_STATE,
 			buttons: {
 				'1': {
 					action: 'tx',
 					label: 'button-1',
 					target: EXPECTED_FRAME_POST_URL,
-					post_url: EXPECTED_FRAME_TX_POST_URL,
+					postUrl: EXPECTED_FRAME_TX_POST_URL,
 				},
 			},
 		},

diff --git a/packages/server/src/parser.ts b/packages/server/src/parser.ts
@@ -1,4 +1,10 @@
-import type { OpenFrameButton, OpenFrameImage, OpenFrameResult, TransactionResponse } from '@open-frames/proxy-types';
+import type {
+	OpenFrameButton,
+	OpenFrameButtonResult,
+	OpenFrameImage,
+	OpenFrameResult,
+	TransactionResponse,
+} from '@open-frames/proxy-types';
 import { load } from 'cheerio';
 
 import { ALLOWED_ACTIONS, FRAMES_PREFIXES, TAG_PREFIXES } from './constants.js';
@@ -110,7 +116,7 @@ function updateFrameButton(frameInfo: DeepPartial<OpenFrameResult>, key: string,
 		return;
 	}
 	frameInfo.buttons = frameInfo.buttons || {};
-	const button = frameInfo.buttons[buttonIndex] || {};
+	const button = (frameInfo.buttons[buttonIndex] as OpenFrameButtonResult) || {};
 	if (maybeField) {
 		const field = maybeField as keyof OpenFrameButton;
 		if (field === 'action' && isAllowedAction(value)) {
@@ -119,6 +125,9 @@ function updateFrameButton(frameInfo: DeepPartial<OpenFrameResult>, key: string,
 		if (field === 'target') {
 			button.target = value;
 		}
+		if (field === 'post_url') {
+			button.postUrl = value;
+		}
 	} else {
 		button.label = value;
 	}

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -14,11 +14,13 @@ export type OpenFrameButton =
 			action: 'link' | 'mint';
 			target: string;
 			label: string;
+			post_url: never;
 	  }
 	| {
 			action: 'post' | 'post_redirect';
 			target?: string;
 			label: string;
+			post_url?: string;
 	  }
 	| {
 			action: 'tx';
@@ -27,6 +29,26 @@ export type OpenFrameButton =
 			post_url: string;
 	  };
 
+export type OpenFrameButtonResult =
+	| {
+			action: 'link' | 'mint';
+			target: string;
+			label: string;
+			postUrl: never;
+	  }
+	| {
+			action: 'post' | 'post_redirect';
+			target?: string;
+			label: string;
+			postUrl?: string;
+	  }
+	| {
+			action: 'tx';
+			target: string;
+			label: string;
+			postUrl: string;
+	  };
+
 export type TextInput = {
 	content: string;
 };
@@ -38,7 +60,7 @@ export type OpenFrameResult = {
 	image: OpenFrameImage;
 	postUrl?: string;
 	textInput?: TextInput;
-	buttons?: { [k: string]: OpenFrameButton };
+	buttons?: { [k: string]: OpenFrameButtonResult };
 	ogImage: string;
 	state?: string;
 };