@meith/plugin-kit 0.22.0 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meith/plugin-kit",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "The SDK for writing a Meith plugin: typed manifests, hooks, routes, pages and migrations.",
   "license": "MIT",
   "repository": {
@@ -20,8 +20,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@meith/core": "^0.22.0",
-    "@meith/theme-kit": "^0.22.0"
+    "@meith/core": "^0.23.0",
+    "@meith/theme-kit": "^0.23.0"
   },
   "peerDependencies": {
     "react": "^19.2.0"

package/src/host.ts

@@ -206,10 +206,10 @@ export class PluginHost {
     }
   }
 
-  renderRegion(
+  async renderRegion(
     region: PluginRegion,
-    context: PluginRegionContext,
-  ): readonly { key: string; node: ReactNode }[] {
+    context: Omit<PluginRegionContext, 'runtime'>,
+  ): Promise<readonly { key: string; node: ReactNode }[]> {
     const entries = this.#contributions.get(region)
     if (entries === undefined) return []
 
@@ -219,7 +219,10 @@ export class PluginHost {
 
       const started = this.#now()
       try {
-        const node = entry.contribution.render(context)
+        const node = await entry.contribution.render({
+          ...context,
+          runtime: this.#runtimeFor(entry.pluginKey),
+        })
         this.#record(entry.pluginKey, region, this.#now() - started)
         if (node !== null && node !== undefined) nodes.push({ key: entry.pluginKey, node })
       } catch (error) {

package/src/index.ts

@@ -78,8 +78,6 @@ export {
   pluginSettingKey,
   pluginTablePrefix,
   pluginTaskId,
-  unavailableHookRuntime,
-  unavailablePluginRuntime,
 } from './plugin'
 export {
   createRouteRateLimiter,
@@ -111,9 +109,11 @@ export {
   type PluginUsers,
   pluginNotificationKindSpecs,
   pluginNotify,
+  unavailableHookRuntime,
   unavailablePluginData,
   unavailablePluginGrants,
   unavailablePluginNotify,
+  unavailablePluginRuntime,
   unavailablePluginUsers,
 } from './runtime'
 export {

package/src/plugin.ts

@@ -1,3 +1,5 @@
+export type { HookRuntime, PluginRuntimeContext } from './runtime'
+
 import type { ReactNode } from 'react'
 
 import type { Translator } from '@meith/theme-kit'
@@ -5,18 +7,7 @@ import type { Translator } from '@meith/theme-kit'
 import { type HOOKS, type HookName, isHookName } from './hooks'
 import type { HookContext, HookValue } from './payloads'
 import { isPluginRegion, type PluginRegion, type PluginRegionContext } from './regions'
-import {
-  type PluginData,
-  type PluginGrants,
-  type PluginNotify,
-  type PluginUsers,
-  unavailablePluginData,
-  unavailablePluginGrants,
-  unavailablePluginNotify,
-  unavailablePluginUsers,
-} from './runtime'
-
-export type HookRuntime = () => Promise<PluginRuntimeContext>
+import type { HookRuntime, PluginRuntimeContext } from './runtime'
 
 export type FilterHandler<K extends HookName> = (
   value: HookValue<K>,
@@ -87,7 +78,7 @@ export interface PluginAdminPage {
 export interface PluginContribution {
   readonly region: PluginRegion
   readonly priority?: number | undefined
-  readonly render: (context: PluginRegionContext) => ReactNode
+  readonly render: (context: PluginRegionContext) => ReactNode | Promise<ReactNode>
 }
 
 export interface PluginViewer {
@@ -176,34 +167,6 @@ export interface PluginNavigationItem {
   readonly under?: string | undefined
 }
 
-export interface PluginRuntimeContext {
-  readonly settings: Readonly<Record<string, string | number | boolean>>
-  readonly logger: {
-    readonly info: (message: string, detail?: Record<string, unknown>) => void
-    readonly warn: (message: string, detail?: Record<string, unknown>) => void
-    readonly error: (message: string, detail?: Record<string, unknown>) => void
-  }
-  readonly grants: PluginGrants
-  readonly data: PluginData
-  readonly users: PluginUsers
-  readonly notify: PluginNotify
-}
-
-export function unavailablePluginRuntime(reason: string): PluginRuntimeContext {
-  return {
-    settings: {},
-    logger: { info: () => {}, warn: () => {}, error: () => {} },
-    grants: unavailablePluginGrants(reason),
-    data: unavailablePluginData(reason),
-    users: unavailablePluginUsers(reason),
-    notify: unavailablePluginNotify(reason),
-  }
-}
-
-export function unavailableHookRuntime(reason: string): HookRuntime {
-  return () => Promise.resolve(unavailablePluginRuntime(reason))
-}
-
 export interface PluginNotificationKind {
   readonly key: string
   readonly title: string

package/src/regions.ts

@@ -1,3 +1,5 @@
+import type { HookRuntime } from './runtime'
+
 export interface RegionSpec {
   readonly purpose: string
   readonly context: string
@@ -22,6 +24,12 @@ export const PLUGIN_REGIONS = {
     purpose: 'Below a post body, above its actions.',
     context: 'The viewer, the post id and the author id.',
   },
+  'thread.header': {
+    purpose:
+      'Above the first post of a thread, below its title. Runs once per thread page, ' +
+      'so unlike postbit.* it can afford to read from the plugin’s own tables.',
+    context: 'The viewer, the thread id and the thread author’s id.',
+  },
   'profile.panel': {
     purpose: 'A panel on a member’s profile, below the standard fields.',
     context: 'The viewer and the profile’s member id.',
@@ -45,4 +53,5 @@ export interface PluginRegionContext {
   readonly viewer: { readonly userId: number | null; readonly isGuest: boolean }
   readonly subjectId: number | null
   readonly authorId: number | null
+  readonly runtime: HookRuntime
 }

package/src/runtime.ts

@@ -246,3 +246,33 @@ export function pluginNotify(
     },
   }
 }
+
+export interface PluginRuntimeContext {
+  readonly settings: Readonly<Record<string, string | number | boolean>>
+  readonly logger: {
+    readonly info: (message: string, detail?: Record<string, unknown>) => void
+    readonly warn: (message: string, detail?: Record<string, unknown>) => void
+    readonly error: (message: string, detail?: Record<string, unknown>) => void
+  }
+  readonly grants: PluginGrants
+  readonly data: PluginData
+  readonly users: PluginUsers
+  readonly notify: PluginNotify
+}
+
+export type HookRuntime = () => Promise<PluginRuntimeContext>
+
+export function unavailablePluginRuntime(reason: string): PluginRuntimeContext {
+  return {
+    settings: {},
+    logger: { info: () => {}, warn: () => {}, error: () => {} },
+    grants: unavailablePluginGrants(reason),
+    data: unavailablePluginData(reason),
+    users: unavailablePluginUsers(reason),
+    notify: unavailablePluginNotify(reason),
+  }
+}
+
+export function unavailableHookRuntime(reason: string): HookRuntime {
+  return () => Promise.resolve(unavailablePluginRuntime(reason))
+}