feat: pass user location

Author: stephancill

packages/frames.js/src/getUserDataForFid.ts

@@ -6,7 +6,7 @@ import type { HubHttpUrlOptions, UserDataReturnType } from "./types";
  * Returns the latest user data for a given Farcaster users Fid if available.
  */
 export async function getUserDataForFid<
-  Options extends HubHttpUrlOptions | undefined,
+  Options extends HubHttpUrlOptions | undefined
 >({
   fid,
   options = {},
@@ -34,32 +34,42 @@ export async function getUserDataForFid<
     .catch(async () => {
       // body has not been
       throw new Error(
-        `Failed to parse response body as JSON because server hub returned response with status "${userDataResponse.status}" and body "${await userDataResponse.clone().text()}"`
+        `Failed to parse response body as JSON because server hub returned response with status "${
+          userDataResponse.status
+        }" and body "${await userDataResponse.clone().text()}"`
       );
     })) as { messages?: Record<string, any>[] };
 
   if (messages && messages.length > 0) {
     const valuesByType = messages.reduce<
       Partial<Record<UserDataType, { value: string; timestamp: number }>>
     >((acc, messageJson) => {
-      const message = Message.fromJSON(messageJson);
+      try {
+        const message = Message.fromJSON(messageJson);
 
-      if (message.data?.type !== MessageType.USER_DATA_ADD) {
-        return acc;
-      }
+        if (message.data?.type !== MessageType.USER_DATA_ADD) {
+          return acc;
+        }
 
-      if (!message.data.userDataBody) {
-        return acc;
-      }
+        if (!message.data.userDataBody) {
+          return acc;
+        }
 
-      const timestamp = message.data.timestamp;
-      const { type, value } = message.data.userDataBody;
-      const foundValue = acc[type];
+        const timestamp = message.data.timestamp;
+        const { type, value } = message.data.userDataBody;
+        const foundValue = acc[type];
 
-      if (foundValue && foundValue.timestamp < timestamp) {
-        acc[type] = { value, timestamp };
-      } else {
-        acc[type] = { value, timestamp };
+        if (foundValue && foundValue.timestamp < timestamp) {
+          acc[type] = { value, timestamp };
+        } else {
+          acc[type] = { value, timestamp };
+        }
+      } catch (error) {
+        console.warn(
+          `Failed to parse user data message for fid ${fid}`,
+          messageJson,
+          error
+        );
       }
 
       return acc;
@@ -70,6 +80,7 @@ export async function getUserDataForFid<
       displayName: valuesByType[UserDataType.DISPLAY]?.value,
       username: valuesByType[UserDataType.USERNAME]?.value,
       bio: valuesByType[UserDataType.BIO]?.value,
+      location: valuesByType[UserDataType.LOCATION]?.value,
     };
   }
 

packages/frames.js/src/types.ts

@@ -44,8 +44,11 @@ type FrameOptionalStringKeys =
   | keyof OpenFramesProperties
   | "frames.js:version"
   | "frames.js:debug-info:image";
-type FrameOptionalActionButtonTypeKeys =
-  `fc:frame:button:${1 | 2 | 3 | 4}:action`;
+type FrameOptionalActionButtonTypeKeys = `fc:frame:button:${
+  | 1
+  | 2
+  | 3
+  | 4}:action`;
 type FrameOptionalButtonStringKeys =
   | `fc:frame:button:${1 | 2 | 3 | 4}`
   | `fc:frame:button:${1 | 2 | 3 | 4}:target`
@@ -59,8 +62,8 @@ type MapFrameOptionalKeyToValueType<K extends FrameKeys> =
   K extends FrameOptionalStringKeys
     ? string | undefined
     : K extends FrameOptionalActionButtonTypeKeys
-      ? ActionButtonType | undefined
-      : string | undefined;
+    ? ActionButtonType | undefined
+    : string | undefined;
 
 type FrameRequiredProperties = {
   "fc:frame": FrameVersion;
@@ -153,7 +156,7 @@ export type FrameButtonsType =
   | [FrameButton, FrameButton, FrameButton, FrameButton];
 
 export type AddressReturnType<
-  Options extends { fallbackToCustodyAddress?: boolean } | undefined,
+  Options extends { fallbackToCustodyAddress?: boolean } | undefined
 > = Options extends { fallbackToCustodyAddress: true }
   ? `0x${string}`
   : `0x${string}` | null;
@@ -214,6 +217,7 @@ export type UserDataReturnType = {
   username?: string;
   bio?: string;
   profileImage?: string;
+  location?: string;
 } | null;
 
 export type FrameActionDataParsedAndHubContext = FrameActionDataParsed &