refactor: ExtensionAPI添加getExposedAPI方法

Author: x6eull

src/extension/ExtensionAPI.ts

@@ -7,6 +7,7 @@ const apiMetadataKey = Symbol('APIMetadata')
 type WithAPIMetadata = { [apiMetadataKey]: APIMetatdata }
 type APIMetatdata = { version: string; schema: z.ZodType }
 
+/**标记一个类的方法是暴露的插件API。调用此函数会返回一个stage3装饰器。 */
 function exposedAPI<V extends string>(version: V, schema: z.ZodType) {
   return function <
     This,
@@ -27,24 +28,30 @@ function exposedAPI<V extends string>(version: V, schema: z.ZodType) {
   }
 }
 
-export function isExposedAPI(value: unknown): value is WithAPIMetadata {
-  return typeof value === 'function' && apiMetadataKey in value
-}
-
 export class ExtensionAPI {
   constructor(protected runtime: ExtensionRuntime) {}
+  getExposedAPI(
+    key: string,
+  ):
+    | (((this: typeof this, ...args: unknown[]) => unknown) & WithAPIMetadata)
+    | null {
+    const value = this[key as keyof this]
+    if (typeof value === 'function' && apiMetadataKey in value)
+      return value as ((this: this, ...args: unknown[]) => unknown) &
+        WithAPIMetadata
+    return null
+  }
 
-  @exposedAPI('0.1.0', z.any())
+  @exposedAPI('0.1.0', z.unknown())
   ping() {
     return 'pong'
   }
 
   @exposedAPI('0.1.0', z.tuple([z.string().min(1)]))
   caniuse(identifier: string) {
-    const func = this[identifier as keyof this] as WithAPIMetadata | undefined,
-      metadata = func?.[apiMetadataKey]
-    if (!metadata) return undefined
-    const { version } = metadata
+    const func = this.getExposedAPI(identifier)
+    if (!func) return undefined
+    const { version } = func[apiMetadataKey]
     return { identifier, version, available: true }
   }
 

src/extension/WidgetExtensionRuntime.ts

@@ -3,7 +3,7 @@ import { z } from 'zod'
 import { afterDone, applyOn, PromiseAwaited } from '../utils/func'
 import { BorrowedHandle } from './BorrowManager'
 import { encodeReturn, ExtensionRuntime } from './ExtensionRuntime'
-import { isExposedAPI, WidgetExtensionAPI } from './ExtensionAPI'
+import { WidgetExtensionAPI } from './ExtensionAPI'
 
 type ResolveHandle<H> = H extends BorrowedHandle<infer O> ? O : H
 type WidgetExtensionRuntimeExposedAPIs = WidgetExtensionRuntime['exposedAPIs']
@@ -45,13 +45,9 @@ export class WidgetExtensionRuntime extends ExtensionRuntime {
       const { call, args } =
         WidgetExtensionRuntime.widgetMessageDataBaseSchema.parse(data)
 
-      const f = this.exposedAPIs[call as keyof typeof this.exposedAPIs]
-      if (!isExposedAPI(f)) throw new Error(`No exposed API named ${call}`)
-      const result = applyOn(
-        f as (this: typeof this.exposedAPIs, ...args: unknown[]) => unknown,
-        this.exposedAPIs,
-        args,
-      )
+      const f = this.exposedAPIs.getExposedAPI(call)
+      if (!f) throw new Error(`No exposed API named ${call}`)
+      const result = applyOn(f, this.exposedAPIs, args)
 
       afterDone(result, async (data: unknown) =>
         source.postMessage({ traceId, return: await encodeReturn(data) }, '*'),

widgets/credit234/credit234.ts

@@ -1,11 +1,11 @@
 import nx from '../../extHelper'
 
-const r = await nx.newZjuamService({
+const service = await nx.newZjuamService({
   service: 'http://sztz.zju.edu.cn/dekt/',
 })
 
-const rs = (await (
-  await r.nxFetch('http://sztz.zju.edu.cn/dekt/student/home/getMyInfo')
+const result = (await (
+  await service.nxFetch('http://sztz.zju.edu.cn/dekt/student/home/getMyInfo')
 ).json()) as {
   extend: {
     myInfo: {
@@ -20,11 +20,11 @@ const rs = (await (
     }
   }
 }
-console.log(rs)
+console.log(result)
 const {
   extend: {
     myInfo: { dektJf: credit2, dsktJf: credit3, dsiktJf: credit4 },
   },
-} = rs
+} = result
 document.body.innerText = `二课分:${credit2}\n三课分:${credit3}\n四课分:${credit4}`
 await nx.setWidgetHeight(document.body.scrollHeight)