feat(server): ready utility function

A promise that resolves when the plugin has been setup.

Useful for other plugins that depend on it!

.changeset/new-feet-tell.md

@@ -0,0 +1,5 @@
+---
+'@robojs/server': patch
+---
+
+feat: `ready` utility function

packages/plugin-api/src/core/plugin-utils.ts

@@ -1,6 +1,19 @@
 import { pluginOptions } from '~/events/_start.js'
 import type { BaseEngine } from '~/engines/base.js'
 
+export let _readyPromiseResolve: () => void
+
+const _readyPromise = new Promise<void>((resolve) => {
+	_readyPromiseResolve = resolve
+})
+
 export function getServerEngine<T extends BaseEngine = BaseEngine>() {
 	return pluginOptions.engine as T
 }
+
+/**
+ * Returns a promise that resolves when the plugin is all set up.
+ */
+export function ready(): Promise<void> {
+	return _readyPromise
+}

packages/plugin-api/src/events/_start.ts

@@ -1,5 +1,6 @@
 import { logger } from '../core/logger.js'
 import { hasDependency } from '../core/runtime-utils.js'
+import { _readyPromiseResolve } from '~/core/plugin-utils.js'
 import { existsSync } from 'node:fs'
 import path from 'node:path'
 import { portal } from 'robo.js'
@@ -76,6 +77,7 @@ export default async (_client: Client, options: PluginOptions) => {
 
 	logger.debug(`Starting server...`)
 	await engine.start({ port })
+	_readyPromiseResolve()
 }
 
 async function getDefaultEngine() {