feat(types): add @objectstack/types package with IKernel interface and runtime plugin definitions

Author: hotlong

examples/plugin-bi/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "main": "src/index.ts",
   "license": "MIT",
+  "private": true,
   "scripts": {
     "build": "tsc"
   },

packages/plugin-hono-server/package.json

@@ -8,13 +8,17 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@objectstack/runtime": "workspace:*",
+    "@hono/node-server": "^1.2.0",
     "@objectstack/spec": "workspace:*",
-    "hono": "^4.0.0",
-    "@hono/node-server": "^1.2.0"
+    "@objectstack/types": "workspace:*",
+    "hono": "^4.0.0"
   },
   "devDependencies": {
+    "@objectstack/runtime": "^0.1.0",
     "@types/node": "^20.0.0",
     "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@objectstack/runtime": "^0.1.0"
   }
 }

packages/plugin-hono-server/src/index.ts

@@ -3,7 +3,8 @@ import { serveStatic } from '@hono/node-server/serve-static';
 import { Hono } from 'hono';
 import { cors } from 'hono/cors';
 import { logger } from 'hono/logger';
-import { ObjectStackKernel, ObjectStackRuntimeProtocol, RuntimePlugin } from '@objectstack/runtime';
+import { ObjectStackRuntimeProtocol } from '@objectstack/runtime';
+import { RuntimePlugin, IKernel } from '@objectstack/types';
 
 export interface HonoServerOptions {
   port?: number;
@@ -32,9 +33,10 @@ export class HonoServerPlugin implements RuntimePlugin {
     };
   }
 
-  async onStart(ctx: { engine: ObjectStackKernel }) {
+  async onStart(ctx: { engine: IKernel }) {
     const app = new Hono();
-    const protocol = new ObjectStackRuntimeProtocol(ctx.engine);
+    // TODO: Protocol needs access to actual Kernel instance or we make Protocol an interface too
+    const protocol = new ObjectStackRuntimeProtocol(ctx.engine as any);
 
     // 1. Middlewares
     if (this.options.logger) app.use('*', logger());

packages/runtime/package.json

@@ -10,6 +10,7 @@
   },
   "dependencies": {
     "@objectstack/objectql": "workspace:*",
+    "@objectstack/types": "workspace:*",
     "@objectstack/spec": "workspace:*"
   },
   "devDependencies": {

packages/types/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@objectstack/types",
+  "version": "0.1.0",
+  "description": "Shared interfaces describing the ObjectStack Runtime environment",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "dependencies": {
+    "@objectstack/spec": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

packages/types/src/index.ts

@@ -0,0 +1,19 @@
+// Placeholder for Kernel interface to avoid circular dependency
+// The actual Kernel implementation will satisfy this interface.
+export interface IKernel {
+    // We can add specific methods here that plugins are allowed to call
+    // forcing a stricter contract than exposing the whole class.
+    start(): Promise<void>;
+    // ... expose other needed public methods
+    [key: string]: any; 
+}
+
+export interface RuntimeContext {
+    engine: IKernel;
+}
+
+export interface RuntimePlugin {
+    name: string;
+    install?: (ctx: RuntimeContext) => void | Promise<void>;
+    onStart?: (ctx: RuntimeContext) => void | Promise<void>;
+}

packages/types/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}