feat(plugins): implement definePlugin helper and update plugin context types

Author: hotlong

examples/plugin-bi/src/index.ts

@@ -1,4 +1,4 @@
-import { PluginDefinition } from '@objectstack/spec/system';
+import { definePlugin } from '@objectstack/spec';
 
 export class BiEngine {
   constructor() {
@@ -15,7 +15,7 @@ export class BiEngine {
   }
 }
 
-const plugin: PluginDefinition = {
+const plugin = definePlugin({
   id: 'com.objectstack.bi',
   version: '1.0.0',
 
@@ -58,6 +58,6 @@ const plugin: PluginDefinition = {
 
     logger.info('[BI Plugin] Services registered.');
   }
-};
+});
 
 export default plugin;

packages/adapters/hono/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src",
@@ -8,5 +8,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }

packages/adapters/nestjs/src/index.ts

@@ -1,11 +1,11 @@
-import { DynamicModule, Module, Global, Inject, Provider, Controller, Post, Get, Patch, Delete, Body, Param, Query, Req, Res, All, UseGuards, createParamDecorator, ExecutionContext } from '@nestjs/common';
+import { DynamicModule, Module, Global, Inject, Provider, Controller, Post, Get, Patch, Delete, Body, Param, Query, Req, Res, All, createParamDecorator, ExecutionContext } from '@nestjs/common';
 import { Injectable } from '@nestjs/common';
 import { ObjectKernel } from '@objectstack/runtime';
 
 export const OBJECT_KERNEL = 'OBJECT_KERNEL';
 
 export const ConnectReq = createParamDecorator(
-  (data: unknown, ctx: ExecutionContext) => {
+  (_data: unknown, ctx: ExecutionContext) => {
     return ctx.switchToHttp().getRequest();
   },
 );

packages/adapters/nestjs/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src",
@@ -10,5 +10,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }

packages/adapters/nextjs/src/index.ts

@@ -81,15 +81,15 @@ export function createRouteHandler(options: NextAdapterOptions) {
         // 0. Auth
         if (segments[0] === 'auth') {
             if (segments[1] === 'login' && method === 'POST') {
-                const body = await req.json();
+                const body = await req.json() as any;
                 const data = await kernel.broker.call('auth.login', body, { request: rawRequest });
                 return NextResponse.json(data);
             }
         }
 
         // 1. GraphQL
         if (segments[0] === 'graphql' && method === 'POST') {
-            const body = await req.json();
+            const body = await req.json() as any;
             const result = await kernel.graphql(body.query, body.variables, { request: rawRequest });
             return NextResponse.json(result);
         }
@@ -116,14 +116,14 @@ export function createRouteHandler(options: NextAdapterOptions) {
 
             // POST /data/:objectName/query
             if (segments[2] === 'query' && method === 'POST') {
-                const body = await req.json();
+                const body = await req.json() as any;
                 const result = await kernel.broker.call('data.query', { object: objectName, ...body }, { request: rawRequest });
                 return success(result.data, { count: result.count, limit: body.limit, skip: body.skip });
             }
 
             // POST /data/:objectName/batch
             if (segments[2] === 'batch' && method === 'POST') {
-                const body = await req.json();
+                const body = await req.json() as any;
                 const result = await kernel.broker.call('data.batch', { object: objectName, operations: body.operations }, { request: rawRequest });
                 return success(result);
             }

packages/adapters/nextjs/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src",
@@ -8,5 +8,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }

packages/spec/src/index.ts

@@ -70,3 +70,5 @@ export {
 
 export * from './stack.zod';
 
+export { definePlugin, type PluginContext } from './kernel/plugin.zod';
+

packages/spec/src/kernel/plugin.zod.ts

@@ -99,6 +99,7 @@ export const PluginContextSchema = z.object({
 });
 
 export type PluginContextData = z.infer<typeof PluginContextSchema>;
+export type PluginContext = PluginContextData;
 
 export const PluginLifecycleSchema = z.object({
   onInstall: z.function({
@@ -138,3 +139,11 @@ export const PluginSchema = PluginLifecycleSchema.extend({
 });
 
 export type PluginDefinition = z.infer<typeof PluginSchema>;
+
+/**
+ * Define an ObjectStack Plugin
+ * Helper function for creating type-safe plugin definitions
+ */
+export function definePlugin(config: PluginDefinition): PluginDefinition {
+  return config;
+}

packages/spec/src/stack.zod.ts

@@ -319,3 +319,6 @@ export type ObjectQLCapabilities = z.infer<typeof ObjectQLCapabilitiesSchema>;
 export type ObjectUICapabilities = z.infer<typeof ObjectUICapabilitiesSchema>;
 export type ObjectOSCapabilities = z.infer<typeof ObjectOSCapabilitiesSchema>;
 export type ObjectStackCapabilities = z.infer<typeof ObjectStackCapabilitiesSchema>;
+
+
+