@ensera/plugin-backend 1.0.0 → 1.2.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Request, Response, NextFunction } from 'express';
+import { Request, Response, NextFunction, Express } from 'express';
 
 /**
  * Plugin scope extracted from JWT token
@@ -373,4 +373,35 @@ declare function toDateString(date: string | Date | null | undefined): string |
  */
 declare function buildDateTime(dateValue: string | Date | null | undefined, timeValue: string | null | undefined, defaultHour?: number, defaultMinute?: number): Date | null;
 
-export { type BackendNotification, type JsonObject, type JsonValue, type NotificationAction, type NotificationApiPayload, type NotificationBulkApiPayload, type NotificationBulkResponse, type NotificationCancelResponse, type NotificationCapabilities, type NotificationOptions, type NotificationPublishResponse, type NotificationPublisher, type NotificationPublisherConfig, type NotificationTypeConfig, type PluginAuthOptions, type PluginContext, PluginError, type PluginErrorResponse, type PluginScope, type RequestWithContext, type ScheduleOptions, assertPluginScope, buildDateTime, calculateScheduleTime, createNotificationPublisher, forbidClientInstanceId, formatTime, getPluginScope, isPastDate, pluginAuth, pluginErrorHandler, requireFeature, requirePermission, requireTabView, requireTaskScope, resolveEffectiveInstanceId, toDateString, withInstanceOnly, withInstanceScope, withUserAndInstance };
+declare function withCoreServiceToken(handler: (req: Request, res: Response, next: NextFunction) => unknown): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+type CoreRequestContext = {
+    workspaceId: string;
+    spaceId: string;
+    userId: string;
+    taskScopeId?: string;
+    requestId: string;
+};
+type CommandHandler = (input: Record<string, unknown>, context: CoreRequestContext) => Promise<unknown>;
+type CommandRegistry = {
+    register: (name: string, handler: CommandHandler) => void;
+    get: (name: string) => CommandHandler | undefined;
+    list: () => string[];
+};
+declare function createCommandRegistry(): CommandRegistry;
+declare function createCoreRouter(app: Express, registry: CommandRegistry): void;
+
+type CreateDbOptions = {
+    prismaDir?: string;
+    coreApiUrl?: string;
+    serviceToken?: string;
+    runMigrations?: boolean;
+};
+type DbProvisionResult = {
+    connectionString: string;
+    schemaName: string;
+    featureSlug: string;
+};
+declare function provisionDb(options?: CreateDbOptions): Promise<DbProvisionResult>;
+
+export { type BackendNotification, type CommandHandler, type CommandRegistry, type CoreRequestContext, type CreateDbOptions, type DbProvisionResult, type JsonObject, type JsonValue, type NotificationAction, type NotificationApiPayload, type NotificationBulkApiPayload, type NotificationBulkResponse, type NotificationCancelResponse, type NotificationCapabilities, type NotificationOptions, type NotificationPublishResponse, type NotificationPublisher, type NotificationPublisherConfig, type NotificationTypeConfig, type PluginAuthOptions, type PluginContext, PluginError, type PluginErrorResponse, type PluginScope, type RequestWithContext, type ScheduleOptions, assertPluginScope, buildDateTime, calculateScheduleTime, createCommandRegistry, createCoreRouter, createNotificationPublisher, forbidClientInstanceId, formatTime, getPluginScope, isPastDate, pluginAuth, pluginErrorHandler, provisionDb, requireFeature, requirePermission, requireTabView, requireTaskScope, resolveEffectiveInstanceId, toDateString, withCoreServiceToken, withInstanceOnly, withInstanceScope, withUserAndInstance };

package/dist/index.js

@@ -657,11 +657,209 @@ function buildDateTime(dateValue, timeValue, defaultHour = 9, defaultMinute = 0)
   if (isNaN(result.getTime())) return null;
   return result;
 }
+
+// src/withCoreServiceToken.ts
+function withCoreServiceToken(handler) {
+  return async function coreServiceTokenWrapped(req, res, next) {
+    try {
+      const authHeader = req.headers.authorization;
+      const token = authHeader?.startsWith("Bearer ") ? authHeader.slice(7) : null;
+      const expected = process.env.CORE_SERVICE_TOKEN?.trim();
+      if (!expected) {
+        throw new PluginError({
+          status: 500,
+          code: "CORE_SERVICE_TOKEN_NOT_CONFIGURED",
+          message: "CORE_SERVICE_TOKEN is not set in environment"
+        });
+      }
+      if (!token || token !== expected) {
+        throw new PluginError({
+          status: 401,
+          code: "INVALID_CORE_SERVICE_TOKEN",
+          message: "Unauthorized: invalid or missing Core service token"
+        });
+      }
+      await handler(req, res, next);
+    } catch (e) {
+      next(e);
+    }
+  };
+}
+
+// src/createCommandRegistry.ts
+function createCommandRegistry() {
+  const registry = /* @__PURE__ */ new Map();
+  return {
+    register(name, handler) {
+      if (!name || typeof handler !== "function") {
+        throw new Error(
+          "createCommandRegistry: name and handler are required"
+        );
+      }
+      registry.set(name, handler);
+    },
+    get(name) {
+      return registry.get(name);
+    },
+    list() {
+      return Array.from(registry.keys());
+    }
+  };
+}
+function createCoreRouter(app, registry) {
+  app.post(
+    "/api/core/execute",
+    withCoreServiceToken(async (req, res) => {
+      const { command, input, context } = req.body ?? {};
+      if (!command || typeof command !== "string") {
+        return res.status(400).json({
+          success: false,
+          error: "MISSING_COMMAND",
+          message: "Request body must include a command string"
+        });
+      }
+      if (!context?.workspaceId || !context?.userId) {
+        return res.status(400).json({
+          success: false,
+          error: "MISSING_CONTEXT",
+          message: "Request context must include workspaceId and userId"
+        });
+      }
+      const handler = registry.get(command);
+      if (!handler) {
+        return res.status(404).json({
+          success: false,
+          error: "UNKNOWN_COMMAND",
+          message: `Command '${command}' is not registered`,
+          available: registry.list()
+        });
+      }
+      try {
+        const result = await handler(
+          input ?? {},
+          context
+        );
+        return res.json({ success: true, data: result });
+      } catch (err) {
+        console.error(`[CoreRouter] Command '${command}' failed:`, err);
+        return res.status(500).json({
+          success: false,
+          error: "COMMAND_FAILED",
+          message: err?.message ?? "Internal error"
+        });
+      }
+    })
+  );
+}
+
+// src/createDb.ts
+import { execSync } from "child_process";
+import fs from "fs";
+import path from "path";
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function getString(value) {
+  if (typeof value !== "string") return void 0;
+  const trimmed = value.trim();
+  return trimmed.length > 0 ? trimmed : void 0;
+}
+function parseProvisionResult(value) {
+  if (!isRecord(value)) {
+    throw new Error("provisionDb: Core returned an invalid response body");
+  }
+  const connectionString = getString(value.connectionString);
+  const schemaName = getString(value.schemaName);
+  const featureSlug = getString(value.featureSlug);
+  if (!connectionString) {
+    throw new Error("provisionDb: Core did not return a connectionString");
+  }
+  if (!schemaName) {
+    throw new Error("provisionDb: Core did not return a schemaName");
+  }
+  if (!featureSlug) {
+    throw new Error("provisionDb: Core did not return a featureSlug");
+  }
+  return {
+    connectionString,
+    schemaName,
+    featureSlug
+  };
+}
+async function provisionDb(options = {}) {
+  const coreApiUrl = (options.coreApiUrl ?? process.env.CORE_API_URL)?.replace(/\/+$/, "");
+  const serviceToken = options.serviceToken ?? process.env.CORE_SERVICE_TOKEN;
+  if (!coreApiUrl) {
+    throw new Error(
+      "provisionDb: CORE_API_URL is not set. Add it to your .env file."
+    );
+  }
+  if (!serviceToken) {
+    throw new Error(
+      "provisionDb: CORE_SERVICE_TOKEN is not set. Add it to your .env file."
+    );
+  }
+  const response = await fetch(`${coreApiUrl}/api/internal/db/provision`, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${serviceToken}`
+    }
+  });
+  let payload = null;
+  try {
+    payload = await response.json();
+  } catch {
+    payload = null;
+  }
+  if (!response.ok) {
+    const errorMessage = isRecord(payload) ? getString(payload.error) : void 0;
+    throw new Error(
+      `provisionDb: Core returned ${response.status}. ${errorMessage ?? "Unknown error"}`
+    );
+  }
+  const result = parseProvisionResult(payload);
+  const shouldMigrate = options.runMigrations !== false;
+  if (shouldMigrate) {
+    const prismaDir = options.prismaDir ?? path.join(process.cwd(), "prisma");
+    const migrationsDir = path.join(prismaDir, "migrations");
+    if (fs.existsSync(prismaDir) && fs.existsSync(migrationsDir)) {
+      console.log(
+        `[ensera-db] Running migrations for schema: ${result.schemaName}`
+      );
+      try {
+        execSync("npx prisma migrate deploy", {
+          cwd: path.dirname(prismaDir),
+          stdio: "inherit",
+          env: {
+            ...process.env,
+            DATABASE_URL: result.connectionString
+          }
+        });
+        console.log("[ensera-db] Migrations complete");
+      } catch (error) {
+        const message = error instanceof Error ? error.message : "Unknown migration error";
+        throw new Error(`[ensera-db] Migration failed: ${message}`);
+      }
+    } else if (fs.existsSync(prismaDir)) {
+      console.warn(
+        `[ensera-db] No prisma migrations found at ${migrationsDir}. Skipping migrations.`
+      );
+    } else {
+      console.warn(
+        `[ensera-db] No prisma directory found at ${prismaDir}. Skipping migrations.`
+      );
+    }
+  }
+  return result;
+}
 export {
   PluginError,
   assertPluginScope,
   buildDateTime,
   calculateScheduleTime,
+  createCommandRegistry,
+  createCoreRouter,
   createNotificationPublisher,
   forbidClientInstanceId,
   formatTime,
@@ -669,12 +867,14 @@ export {
   isPastDate,
   pluginAuth,
   pluginErrorHandler,
+  provisionDb,
   requireFeature,
   requirePermission,
   requireTabView,
   requireTaskScope,
   resolveEffectiveInstanceId,
   toDateString,
+  withCoreServiceToken,
   withInstanceOnly,
   withInstanceScope,
   withUserAndInstance

package/package.json

@@ -1,54 +1,54 @@
-{
-  "name": "@ensera/plugin-backend",
-  "version": "1.0.0",
-  "description": "Runtime backend SDK for Ensera plugins.",
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "sideEffects": false,
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean --target es2022 --outDir dist",
-    "dev": "tsup src/index.ts --format esm --dts --watch --target es2022 --outDir dist",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
-    "prepublishOnly": "npm run build && npm run typecheck"
-  },
-  "keywords": [
-    "ensera",
-    "backend",
-    "sdk",
-    "plugin",
-    "express"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "jsonwebtoken": "^9.0.0"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.0",
-    "@types/jsonwebtoken": "^9.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "jsonwebtoken": "^9.0.0"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "peerDependencies": {
-    "express": "^4.18.0",
-    "jsonwebtoken": "^9.0.0"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./package.json": "./package.json"
-  }
-}
+{
+  "name": "@ensera/plugin-backend",
+  "version": "1.2.0",
+  "description": "Runtime backend SDK for Ensera plugins.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --target es2022 --outDir dist",
+    "dev": "tsup src/index.ts --format esm --dts --watch --target es2022 --outDir dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepublishOnly": "npm run build && npm run typecheck"
+  },
+  "keywords": [
+    "ensera",
+    "backend",
+    "sdk",
+    "plugin",
+    "express"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "jsonwebtoken": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.0",
+    "@types/jsonwebtoken": "^9.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "jsonwebtoken": "^9.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0",
+    "jsonwebtoken": "^9.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  }
+}