docs(lib): add JSDoc to base64url and getFrame functions

Author: Dark-Brain07

packages/frames.js/src/getFrame.ts

@@ -35,8 +35,15 @@ type GetFrameOptions = {
 
 /**
  * Extracts frame metadata from the given htmlString.
+ * Parses the HTML and extracts frame information based on the specified protocol.
  *
- * @returns an object representing the parsing result
+ * @param options - Configuration options for frame extraction
+ * @param options.htmlString - The HTML string to parse
+ * @param options.frameUrl - URL to the frame
+ * @param options.url - Fallback URL used if post_url is missing
+ * @param options.specification - The parsing specification (default: 'farcaster')
+ * @param options.fromRequestMethod - Request method used to fetch the frame (default: 'GET')
+ * @returns An object representing the parsing result with frame data and any reports
  */
 export async function getFrame({
   htmlString,

packages/frames.js/src/lib/base64url.ts

@@ -1,3 +1,9 @@
+/**
+ * Encodes a Buffer to a URL-safe base64 string.
+ * Replaces '+' with '-', '/' with '_', and removes padding '='.
+ * @param data - The buffer to encode
+ * @returns URL-safe base64 encoded string
+ */
 export function base64urlEncode(data: Buffer): string {
   // we could use .toString('base64url') on buffer, but that throws in browser
   return data
@@ -7,6 +13,12 @@ export function base64urlEncode(data: Buffer): string {
     .replace(/=/g, "");
 }
 
+/**
+ * Decodes a URL-safe base64 string back to a Buffer.
+ * Handles the reverse transformations of base64urlEncode.
+ * @param encodedData - The URL-safe base64 string to decode
+ * @returns Decoded buffer
+ */
 export function base64urlDecode(encodedData: string): Buffer {
   const encodedChunks = encodedData.length % 4;
   const base64 = encodedData
@@ -17,3 +29,4 @@ export function base64urlDecode(encodedData: string): Buffer {
   // we could use base64url on buffer, but that throws in browser
   return Buffer.from(base64, "base64");
 }
+