@kahitsan/plugin-sdk 0.4.2 → 0.4.3-staging.25

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { Router, Request, RequestHandler, Response as Response$1, NextFunction, Express } from 'express';
-export { Router } from 'express';
+import { MiddlewareHandler, Context, Hono } from 'hono';
 import pg, { QueryResultRow, QueryResult, PoolClient, Pool } from 'pg';
 import { Server } from 'node:http';
 interface PluginDb {
@@ -96,11 +95,11 @@ type AuthProviderDecl = {
     validatePath: string;
 };
 type AuthService = {
-    requireAuth: RequestHandler;
-    requireWorkspace: RequestHandler;
-    requireRole: (...roles: string[]) => RequestHandler;
-    requireWorkspaceRole: (...roles: string[]) => RequestHandler;
-    requirePermission: (...codes: string[]) => RequestHandler;
+    requireAuth: MiddlewareHandler;
+    requireWorkspace: MiddlewareHandler;
+    requireRole: (...roles: string[]) => MiddlewareHandler;
+    requireWorkspaceRole: (...roles: string[]) => MiddlewareHandler;
+    requirePermission: (...codes: string[]) => MiddlewareHandler;
     registerAuthProvider: (provider: AuthProvider) => void;
 };
 type PluginManifest = {
@@ -188,10 +187,10 @@ type PluginInitInput = {
 };
 type AdditionalMount = {
     basePath: string;
-    router: Router;
+    router: unknown;
 };
 type PluginInitOutput = {
-    router?: Router;
+    router?: unknown;
     additionalMounts?: AdditionalMount[];
     dispose?: () => Promise<void> | void;
 };
@@ -231,10 +230,10 @@ interface JobDefinition {
     run: (ctx: JobContext) => Promise<void> | void;
 }
 declare function defineJob(name: string, run: (ctx: JobContext) => Promise<void> | void): JobDefinition;
-declare function requirePermission(...codes: string[]): (req: Request, res: Response$1, next: NextFunction) => void;
-declare function requireAuth(req: Request, res: Response$1, next: NextFunction): void;
-declare function requireWorkspace(req: Request, res: Response$1, next: NextFunction): void;
-declare function parseIdentity(req: Request, _res: Response$1, next: NextFunction): void;
+declare function requirePermission(...codes: string[]): MiddlewareHandler;
+declare const requireAuth: MiddlewareHandler;
+declare const requireWorkspace: MiddlewareHandler;
+declare const parseIdentity: MiddlewareHandler;
 declare const IDENTITY_HEADER = "x-kserp-identity";
 declare const INTERNAL_SECRET_HEADER = "x-kserp-internal";
 declare const PROTOCOL_VERSION = 1;
@@ -268,7 +267,13 @@ declare const IdentityBrand: unique symbol;
 type Identity = ForwardedIdentity & {
     readonly [IdentityBrand]: true;
 };
-declare function readIdentity(req: Request): Identity | null;
+declare function readIdentity(req: Request | {
+    req: {
+        raw: Request;
+    };
+} | {
+    headers: Headers | Record<string, string | string[] | undefined>;
+}): Identity | null;
 interface WhereOpts {
     where?: string;
     params?: readonly unknown[];
@@ -310,7 +315,7 @@ interface TenantContext {
 }
 declare function runWithTenantContext<T>(ctx: TenantContext, fn: () => T): T;
 declare function applyTenantContext(client: PoolClient, ctx?: TenantContext | undefined): Promise<void>;
-declare function withTenantContext(req: Request, _res: Response$1, next: NextFunction): void;
+declare const withTenantContext: MiddlewareHandler;
 type Engine = "postgres" | "sqlite";
 type ColumnKind = "id" | "string" | "text" | "int" | "bigint" | "float" | "decimal" | "boolean" | "timestamp" | "date" | "json" | "enum";
 type ColumnDefault = "now" | string | number | boolean | null;
@@ -405,9 +410,9 @@ interface MigrationOpts {
     useTransaction?: boolean;
 }
 declare function migration(name: string, up: (db: MigrationBuilder) => Promise<void>, opts?: MigrationOpts): Migration;
-declare function asyncHandler(fn: (req: Request, res: Response$1, next: NextFunction) => unknown | Promise<unknown>): RequestHandler;
+declare function asyncHandler(fn: (c: Context) => unknown | Promise<unknown>): MiddlewareHandler;
 declare function escapeLike(s: string): string;
-declare function checkProtocol(min?: number, max?: number): (req: Request, res: Response$1, next: NextFunction) => void;
+declare function checkProtocol(min?: number, max?: number): MiddlewareHandler;
 type ResourceColumns = Readonly<Record<string, ColumnDef>>;
 type IndexMember = string | {
     readonly ci: string;
@@ -555,13 +560,13 @@ declare function resourceMigrations(resource: DefinedResource): Migration[];
 type DbHandle = Parameters<typeof makeDataSurface>[0];
 interface ResourceRouterDeps {
     db: DbHandle;
-    requireAuth: RequestHandler;
-    requireWorkspace: RequestHandler;
-    requirePermission?: (...codes: string[]) => RequestHandler;
+    requireAuth: MiddlewareHandler;
+    requireWorkspace: MiddlewareHandler;
+    requirePermission?: (...codes: string[]) => MiddlewareHandler;
 }
-declare function buildResourceRouter(resource: DefinedResource, deps: ResourceRouterDeps): Router;
+declare function buildResourceRouter(resource: DefinedResource, deps: ResourceRouterDeps): Hono;
 type ServiceHandler$1 = (args: unknown, ctx: {
-    req: Request;
+    req: unknown;
 }) => Promise<Array<Record<string, unknown>>>;
 declare function buildResourceServices(resource: DefinedResource, deps: {
     db: DbHandle;
@@ -578,13 +583,27 @@ declare function tryCallPlugin<T = unknown>(target: string, method: string, args
     identityHeader?: string;
     sourcePlugin?: string;
 }): Promise<T | null>;
-declare function identityHeaderOf(req: Request): string | undefined;
+declare function identityHeaderOf(req: Request | Context | {
+    headers: Headers | Record<string, string | string[] | undefined>;
+}): string | undefined;
 type ServiceHandler = (args: unknown, ctx: {
-    req: Request;
+    req: unknown;
 }) => Promise<unknown> | unknown;
-declare function mountPluginServices(app: Express, handlers: Record<string, ServiceHandler>, opts: {
-    parseIdentity: RequestHandler;
+declare function mountPluginServices(app: Hono, handlers: Record<string, ServiceHandler>, opts: {
+    parseIdentity: MiddlewareHandler;
 }): void;
+declare function s3Enabled(): boolean;
+declare function s3PublicUrl(key: string): string;
+declare function s3KeyFromUrl(s3Link: string | null | undefined): string | null;
+declare function s3PutObject(key: string, body: Buffer, contentType: string, opts?: {
+    acl?: "public-read" | "private";
+}): Promise<void>;
+declare function s3GetObject(key: string): Promise<{
+    body: Buffer;
+    contentType: string | null;
+}>;
+declare function s3DeleteObject(key: string): Promise<void>;
+declare function s3PresignUrl(key: string, expirySeconds?: number): string;
 interface PluginSettings {
     get<T = unknown>(key: string): Promise<T | undefined>;
     all(): Promise<Record<string, unknown>>;
@@ -664,7 +683,7 @@ interface PluginServerContext {
     plugins?: PluginRpc;
     events?: PluginEvents;
 }
-type PluginRouterFactory = (ctx: PluginServerContext) => Router;
+type PluginRouterFactory = (ctx: PluginServerContext) => Hono;
 type PluginServicesFactory = (ctx: PluginServerContext) => Record<string, ServiceHandler>;
 interface CreatePluginServerOptions {
     importMetaUrl: string;
@@ -678,30 +697,22 @@ interface CreatePluginServerOptions {
     events?: boolean;
     services?: PluginServicesFactory;
     routers?: PluginRouterFactory[];
-    configure?: (app: Express, ctx: PluginServerContext) => void | Promise<void>;
+    configure?: (app: Hono, ctx: PluginServerContext) => void | Promise<void>;
 }
 interface PluginServerHandle {
-    app: Express;
+    app: Hono;
     server: Server;
     ctx?: PluginServerContext;
 }
 declare function createPluginServer(opts: CreatePluginServerOptions): Promise<PluginServerHandle>;
-interface WsSocket {
-    on(event: "message", cb: (data: {
-        toString(): string;
-    }) => void): void;
-    send(data: string): void;
-}
-interface WsServer {
-    on(event: "connection", cb: (socket: WsSocket) => void): void;
-    close(): void;
-}
 interface WsReceiverOptions {
     httpPort: number;
     secret: string;
     host?: string;
 }
-declare function mountWsReceiver(opts: WsReceiverOptions): WsServer | null;
+declare function mountWsReceiver(opts: WsReceiverOptions): {
+    stop: () => void;
+} | null;
 type FlowNodeKind = "data" | "trigger" | "modal" | "load" | "call" | "compute" | "condition" | "commit" | "emit" | "effect" | "terminal";
 interface FlowPort {
     id: string;
@@ -781,5 +792,5 @@ type ExecFlow = Omit<FlowDefinition, "nodes"> & {
     nodes: ExecNode[];
 };
 declare function runFlow(flow: ExecFlow, startId: string, ctx: FlowContext): Promise<void>;
-export { FlowSteps, IDENTITY_HEADER, INTERNAL_SECRET_HEADER, MIGRATION_ADVISORY_LOCK_KEY, MigrationBuilder, PROTOCOL_VERSION, PluginUnavailableError, Types, applyTenantContext, asyncHandler, buildFlow, buildResourceRouter, buildResourceServices, callPlugin, checkInternalSecret, checkProtocol, compileCreateTable, composeWhere, createPlugin, createPluginServer, defineFlow, defineJob, defineResource, defineSchema, edge, escapeLike, identityHeaderOf, indexExpr, loadMigrations, makeDataSurface, makeDatabaseService, migration, mountPluginServices, mountWsReceiver, node, parseIdentity, quoteIdent, readIdentity, requireAuth, requirePermission, requireWorkspace, resolveEngine, resourceMigrations, rollbackMigration, runFlow, runMigrationList, runMigrations, runWithTenantContext, searchFragment, statusFilter, tenant, tryCallPlugin, verifyIdentity, withTenantContext };
+export { FlowSteps, IDENTITY_HEADER, INTERNAL_SECRET_HEADER, MIGRATION_ADVISORY_LOCK_KEY, MigrationBuilder, PROTOCOL_VERSION, PluginUnavailableError, Types, applyTenantContext, asyncHandler, buildFlow, buildResourceRouter, buildResourceServices, callPlugin, checkInternalSecret, checkProtocol, compileCreateTable, composeWhere, createPlugin, createPluginServer, defineFlow, defineJob, defineResource, defineSchema, edge, escapeLike, identityHeaderOf, indexExpr, loadMigrations, makeDataSurface, makeDatabaseService, migration, mountPluginServices, mountWsReceiver, node, parseIdentity, quoteIdent, readIdentity, requireAuth, requirePermission, requireWorkspace, resolveEngine, resourceMigrations, rollbackMigration, runFlow, runMigrationList, runMigrations, runWithTenantContext, s3DeleteObject, s3Enabled, s3GetObject, s3KeyFromUrl, s3PresignUrl, s3PublicUrl, s3PutObject, searchFragment, statusFilter, tenant, tryCallPlugin, verifyIdentity, withTenantContext };
 export type { AdditionalMount, AuthProvider, AuthProviderDecl, AuthService, AuthenticatedUser, BackfillOpts, ColumnDef, ColumnDefault, ColumnKind, ColumnOpts, CompileTableOpts, CoreServices, CreatePluginServerOptions, DataSurface, DecimalOpts, DefinedResource, Engine, EscapeHatch, ExecFlow, ExecNode, FindOpts, FlowContext, FlowDefinition, FlowNode, FlowNodeDef, FlowNodeKind, FlowPort, ForwardedIdentity, Identity, IndexMember, IndexOpts, Logger, MemberDTO, Migration, MigrationContext, MigrationOpts, NodeExec, PermissionsService, PluginAsset, PluginAssets, PluginContext, PluginDb, PluginDefinition, PluginEvents, PluginInitInput, PluginInitOutput, PluginKernel, PluginManifest, PluginPeer, PluginRouterFactory, PluginRpc, PluginServerContext, PluginServerHandle, PluginServicesFactory, PluginSettings, PresignedAsset, ResourceColumns, ResourceCreateSpec, ResourceField, ResourceFields, ResourceFilter, ResourceIndex, ResourceListSpec, ResourcePagination, ResourceRouterDeps, ResourceSearch, ResourceService, ResourceSoftDelete, ResourceSort, ResourceSpec, ResourceUpdateSpec, RunMigrationsOptions, SchemaDef, SqlFragment, StringOpts, TableDef, TenantContext, TenantDb, WhereOpts, WorkspaceDTO, WsReceiverOptions };