feat(core): add GetInfo RPC endpoint

fwouts · Dec 15, 2024 · 60ea49b · 60ea49b
1 parent 3b8a9b6
commit 60ea49b
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 7 deletions.
diff --git a/api/src/api.ts b/api/src/api.ts
@@ -5,3 +5,8 @@ export interface Api {
     ...[endpoint, request]: RequestOf<E> extends void ? [E] : [E, RequestOf<E>]
   ): Promise<ResponseOf<E>>;
 }
+
+export type FrameworkPluginInfo = {
+  name: string;
+  apiVersion: number;
+};
diff --git a/api/src/rpcs.ts b/api/src/rpcs.ts
@@ -1,7 +1,17 @@
 import type { SerializableValue } from "@previewjs/serializable-values";
 import type { CollectedTypes, ValueType } from "@previewjs/type-analyzer";
+import type { FrameworkPluginInfo } from "./api.js";
 import type { RPC } from "./rpc.js";
 
+export const GetInfo: RPC<
+  Record<string, never>,
+  {
+    frameworkPlugin: FrameworkPluginInfo;
+  }
+> = {
+  path: "info",
+};
+
 export const Analyze: RPC<
   {
     previewableIds: string[];

diff --git a/core/src/index.ts b/core/src/index.ts
@@ -171,6 +171,9 @@ export async function createWorkspace({
           types,
         };
       });
+      router.registerRPC(RPCs.GetInfo, async () => ({
+        frameworkPlugin: frameworkPluginFactory.info,
+      }));
       router.registerRPC(RPCs.CrawlFiles, (options) =>
         crawlFiles(logger, workspace, frameworkPlugin, options)
       );

diff --git a/core/src/plugins/framework.ts b/core/src/plugins/framework.ts
@@ -1,12 +1,12 @@
 import type { Analyzer } from "@previewjs/analyzer-api";
+import type { FrameworkPluginInfo } from "@previewjs/api";
 import type { Reader } from "@previewjs/vfs";
 import type { Logger } from "pino";
 import type * as vite from "vite";
 import type { PackageDependencies } from "./dependencies.js";
 
 export interface FrameworkPluginFactory {
-  /** This will always be set in current plugin versions. */
-  info?: FrameworkPluginInfo;
+  info: FrameworkPluginInfo;
   isCompatible(dependencies: PackageDependencies): Promise<boolean>;
   create(options: {
     rootDir: string;
@@ -22,8 +22,3 @@ export interface FrameworkPlugin extends Analyzer {
   viteConfig: (configuredPlugins: vite.Plugin[]) => vite.UserConfig;
   dispose(): void;
 }
-
-type FrameworkPluginInfo = {
-  name: string;
-  apiVersion: number;
-};