feat: parse all specs at once

Author: michalkvasnicak

packages/frames.js/package.json

@@ -267,6 +267,16 @@
         "default": "./dist/hono/index.cjs"
       }
     },
+    "./parseFramesWithReports": {
+      "import": {
+        "types": "./dist/parseFramesWithReports.d.ts",
+        "default": "./dist/parseFramesWithReports.js"
+      },
+      "require": {
+        "types": "./dist/parseFramesWithReports.d.cts",
+        "default": "./dist/parseFramesWithReports.cjs"
+      }
+    },
     "./remix": {
       "import": {
         "types": "./dist/remix/index.d.ts",

packages/frames.js/src/frame-parsers/types.ts

@@ -60,3 +60,20 @@ export type ParseResult =
        */
       reports: Record<string, ParsingReport[]>;
     };
+
+export type ParsedFrameworkDetails = {
+  framesVersion?: string;
+  framesDebugInfo?: {
+    /**
+     * Image URL of debug image.
+     */
+    image?: string;
+  };
+};
+
+export type ParseResultWithFrameworkDetails = ParseResult &
+  ParsedFrameworkDetails;
+
+export type ParseFramesWithReportsResult = {
+  [K in SupportedParsingSpecification]: ParseResultWithFrameworkDetails;
+};

packages/frames.js/src/getFrame.ts

@@ -1,18 +1,10 @@
 import type {
-  ParseResult,
   SupportedParsingSpecification,
+  ParseResultWithFrameworkDetails,
 } from "./frame-parsers/types";
 import { parseFramesWithReports } from "./parseFramesWithReports";
 
-type GetFrameResult = ParseResult & {
-  framesVersion?: string;
-  framesDebugInfo?: {
-    /**
-     * Image URL of debug image.
-     */
-    image?: string;
-  };
-};
+export type GetFrameResult = ParseResultWithFrameworkDetails;
 
 type GetFrameOptions = {
   htmlString: string;
@@ -51,11 +43,5 @@ export function getFrame({
     fromRequestMethod,
   });
 
-  return {
-    ...parsedFrames[specification],
-    framesVersion: parsedFrames.framesVersion,
-    ...(parsedFrames.framesDebugInfo
-      ? { framesDebugInfo: parsedFrames.framesDebugInfo }
-      : {}),
-  };
+  return parsedFrames[specification];
 }

packages/frames.js/src/parseFramesWithReports.ts

@@ -1,8 +1,8 @@
 import { load as loadDocument } from "cheerio";
 import { createReporter } from "./frame-parsers/reporter";
 import type {
-  ParseResult,
-  SupportedParsingSpecification,
+  ParsedFrameworkDetails,
+  ParseFramesWithReportsResult,
 } from "./frame-parsers/types";
 import { parseFarcasterFrame } from "./frame-parsers/farcaster";
 import { parseOpenFramesFrame } from "./frame-parsers/open-frames";
@@ -24,18 +24,6 @@ type ParseFramesWithReportsOptions = {
   fromRequestMethod?: "GET" | "POST";
 };
 
-export type ParseFramesWithReportsResult = {
-  [K in SupportedParsingSpecification]: ParseResult;
-} & {
-  framesVersion?: string;
-  framesDebugInfo?: {
-    /**
-     * Image URL of debug image.
-     */
-    image?: string;
-  };
-};
-
 /**
  * Gets all supported frames and validation their respective validation reports.
  */
@@ -62,14 +50,14 @@ export function parseFramesWithReports({
     `meta[name="${FRAMESJS_DEBUG_INFO_IMAGE_KEY}"], meta[property="${FRAMESJS_DEBUG_INFO_IMAGE_KEY}"]`
   ).attr("content");
 
-  return {
-    farcaster,
-    openframes: parseOpenFramesFrame(document, {
-      farcasterFrame: farcaster.frame,
-      reporter: openFramesReporter,
-      fallbackPostUrl,
-      fromRequestMethod,
-    }),
+  const openframes = parseOpenFramesFrame(document, {
+    farcasterFrame: farcaster.frame,
+    reporter: openFramesReporter,
+    fallbackPostUrl,
+    fromRequestMethod,
+  });
+
+  const frameworkDetails: ParsedFrameworkDetails = {
     framesVersion,
     ...(debugImageUrl
       ? {
@@ -79,4 +67,15 @@ export function parseFramesWithReports({
         }
       : {}),
   };
+
+  return {
+    farcaster: {
+      ...farcaster,
+      ...frameworkDetails,
+    },
+    openframes: {
+      ...openframes,
+      ...frameworkDetails,
+    },
+  };
 }