feat: onReady plugin hook

zazuko · Feb 12, 2025 · d929eb7 · d929eb7
1 parent 1dac8dc
commit d929eb7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/.changeset/modern-walls-hammer.md b/.changeset/modern-walls-hammer.md
@@ -0,0 +1,6 @@
+---
+"@kopflos-cms/core": patch
+"kopflos": patch
+---
+
+New plugin hook: `onReady`
diff --git a/packages/cli/lib/command/serve.ts b/packages/cli/lib/command/serve.ts
@@ -49,6 +49,7 @@ async function run({
 
   const server = app.listen(port, host, () => {
     log.info(`Server running on ${port}. API URL: ${config.baseIri}`)
+    instance.ready()
   })
 
   if (config.watch) {

diff --git a/packages/core/lib/Kopflos.ts b/packages/core/lib/Kopflos.ts
@@ -65,6 +65,7 @@ export interface PluginConfig {
 export interface KopflosPlugin {
   readonly name?: string
   onStart?(): Promise<void> | void
+  onReady?(): Promise<void> | void
   onStop?(): Promise<void> | void
   apiTriples?(): Promise<DatasetCore | Stream> | DatasetCore | Stream
 }
@@ -121,6 +122,7 @@ export default class Impl implements Kopflos {
   readonly env: KopflosEnvironment
   readonly plugins: Array<KopflosPlugin>
   readonly start: () => Promise<void>
+  readonly ready: () => Promise<void>
 
   constructor({ variables = {}, ...config }: KopflosConfig, private readonly options: Options = {}) {
     this.env = createEnv({ variables, ...config })
@@ -148,6 +150,10 @@ export default class Impl implements Kopflos {
     this.start = onetime(async function (this: Impl) {
       await Promise.all(this.plugins.map(plugin => plugin.onStart?.()))
     }).bind(this)
+
+    this.ready = onetime(async function (this: Impl) {
+      await Promise.all(this.plugins.map(plugin => plugin.onReady?.()))
+    }).bind(this)
   }
 
   get graph() {