@tekki-forge/runtime-api 0.1.0

package/dist/controllers.d.ts

@@ -0,0 +1,309 @@
+import type { Request, Response } from "express";
+import type { ForgeRequestContext } from "./extension.js";
+import { ForgeService } from "./service.js";
+export declare const FORGE_SERVICE = "FORGE_SERVICE";
+type ForgeRequest = Request & {
+    forgeContext?: Promise<ForgeRequestContext>;
+};
+/**
+ * Resolve (once per request) the caller's session, roles and organization. Use it in plugin controllers.
+ * API keys only work on resource endpoints: plugin routes refuse them.
+ */
+export declare function requestContext(service: ForgeService, req: ForgeRequest): Promise<ForgeRequestContext>;
+/** Framework endpoints that are not tied to a single resource. Registered before resources. */
+export declare class SystemController {
+    private readonly forge;
+    constructor(forge: ForgeService);
+    health(): {
+        status: string;
+    };
+    /** Public client configuration (e.g. which social sign-in buttons to show). */
+    config(): {
+        socialProviders: string[];
+    };
+    me(req: ForgeRequest): Promise<{
+        apiKey?: {
+            id: string;
+            name: string;
+            scopes: string[];
+        } | undefined;
+        user: {
+            id: string;
+            name: string;
+            email: string;
+            role?: string | null;
+        } | null;
+        roles: string[];
+        organizationId: string | null;
+        impersonating: boolean;
+        teamIds: string[];
+    }>;
+    stats(req: ForgeRequest): Promise<{
+        data: {
+            entity: string;
+            path: string;
+            label: string;
+            count: number;
+        }[];
+    }>;
+    /** Widgets declared in `dashboard`, computed within the caller's permissions. `widgets: null` = default dashboard. */
+    dashboard(req: ForgeRequest): Promise<{
+        widgets: null;
+    } | {
+        widgets: {
+            [x: string]: any;
+        }[];
+    }>;
+    /** ⌘K search across every readable entity. */
+    search(req: ForgeRequest, query: Record<string, unknown>): Promise<{
+        data: import("./search.js").SearchGroup[];
+    }>;
+    savedViews(req: ForgeRequest, resource: string): Promise<{
+        data: any;
+    }>;
+    createSavedView(req: ForgeRequest, body: Record<string, unknown>): Promise<{
+        id: any;
+        resource: any;
+        name: any;
+        query: any;
+        shared: any;
+        mine: boolean;
+        createdAt: any;
+    }>;
+    updateSavedView(req: ForgeRequest, id: string, body: Record<string, unknown>): Promise<{
+        id: any;
+        resource: any;
+        name: any;
+        query: any;
+        shared: any;
+        mine: boolean;
+        createdAt: any;
+    }>;
+    deleteSavedView(req: ForgeRequest, id: string): Promise<void>;
+    users(req: ForgeRequest, query: Record<string, unknown>): Promise<{
+        data: any;
+    }>;
+    teams(req: ForgeRequest): Promise<{
+        data: {
+            id: any;
+            name: any;
+            description: any;
+            members: any;
+            createdAt: any;
+        }[];
+    }>;
+    teamLookup(req: ForgeRequest, query: Record<string, unknown>): Promise<{
+        data: {
+            id: any;
+            label: any;
+        }[];
+    }>;
+    createTeam(req: ForgeRequest, body: Record<string, unknown>): Promise<{
+        id: any;
+        name: any;
+        description: any;
+        members: number;
+        createdAt: any;
+    }>;
+    updateTeam(req: ForgeRequest, id: string, body: Record<string, unknown>): Promise<{
+        id: any;
+        name: any;
+        description: any;
+    }>;
+    deleteTeam(req: ForgeRequest, id: string): Promise<void>;
+    teamMembers(req: ForgeRequest, id: string): Promise<{
+        data: {
+            id: any;
+            userId: any;
+            name: any;
+            email: any;
+            addedAt: any;
+        }[];
+    }>;
+    addTeamMember(req: ForgeRequest, id: string, body: Record<string, unknown>): Promise<{
+        id: any;
+        userId: string;
+        teamId: string;
+    }>;
+    removeTeamMember(req: ForgeRequest, id: string, userId: string): Promise<void>;
+    apiKeys(req: ForgeRequest): Promise<{
+        data: {
+            id: any;
+            name: any;
+            prefix: any;
+            scopes: any;
+            role: any;
+            expiresAt: any;
+            lastUsedAt: any;
+            revokedAt: any;
+            createdAt: any;
+            createdBy: {
+                id: any;
+                name: any;
+                email: any;
+            } | null;
+            status: string;
+        }[];
+    }>;
+    /** The plain key is only in this response. */
+    createApiKey(req: ForgeRequest, body: Record<string, unknown>): Promise<{
+        key: string;
+        apiKey: ReturnType<typeof import("./api-keys.js").presentApiKey>;
+    }>;
+    /** Revokes the key (kept for the audit log). */
+    revokeApiKey(req: ForgeRequest, id: string): Promise<{
+        id: any;
+        name: any;
+        prefix: any;
+        scopes: any;
+        role: any;
+        expiresAt: any;
+        lastUsedAt: any;
+        revokedAt: any;
+        createdAt: any;
+        createdBy: {
+            id: any;
+            name: any;
+            email: any;
+        } | null;
+        status: string;
+    }>;
+    notifications(req: ForgeRequest, query: Record<string, unknown>): Promise<{
+        data: any;
+        unread: any;
+        meta: {
+            page: number;
+            pageSize: number;
+            total: any;
+            pages: number;
+        };
+    }>;
+    markRead(req: ForgeRequest, body: Record<string, unknown>): Promise<{
+        updated: any;
+    }>;
+    /** Server-sent events: live notifications for the signed-in user. */
+    stream(req: ForgeRequest, res: Response): Promise<void>;
+    auditLogs(req: ForgeRequest, query: Record<string, unknown>): Promise<{
+        data: any;
+        meta: {
+            page: number;
+            pageSize: number;
+            total: any;
+            pages: number;
+        };
+    }>;
+}
+/** One generic controller serves every entity; the `:resource` segment selects its IR. */
+export declare class ResourceController {
+    private readonly forge;
+    constructor(forge: ForgeService);
+    list(resource: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        data: any[];
+        meta: {
+            page: number;
+            pageSize: number;
+            total: any;
+            pages: number;
+        };
+    }>;
+    create(resource: string, body: unknown, req: ForgeRequest): Promise<{
+        [x: string]: any;
+    }>;
+    lookup(resource: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        data: any;
+    }>;
+    export(resource: string, query: Record<string, unknown>, req: ForgeRequest, res: Response): Promise<string>;
+    /** CSV import (rows already mapped to field names by the client; at most 1000 per request). */
+    import(resource: string, body: unknown, req: ForgeRequest): Promise<{
+        dryRun: boolean;
+        summary: {
+            create: number;
+            update: number;
+            errors: number;
+            skipped: number;
+            created?: undefined;
+            updated?: undefined;
+        } | {
+            created: number;
+            updated: number;
+            errors: number;
+            skipped: number;
+            create?: undefined;
+            update?: undefined;
+        };
+        rows: import("./import.js").ImportRowResult[];
+    }>;
+    bulkDelete(resource: string, body: unknown, req: ForgeRequest): Promise<{
+        deleted: number;
+    }>;
+    get(resource: string, id: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        [x: string]: any;
+    }>;
+    update(resource: string, id: string, body: unknown, req: ForgeRequest): Promise<{
+        [x: string]: any;
+    }>;
+    remove(resource: string, id: string, req: ForgeRequest): Promise<void>;
+    restore(resource: string, id: string, req: ForgeRequest): Promise<{
+        [x: string]: any;
+    }>;
+    transition(resource: string, id: string, transition: string, body: unknown, req: ForgeRequest): Promise<{
+        [x: string]: any;
+    }>;
+    action(resource: string, id: string, action: string, body: unknown, req: ForgeRequest): Promise<{
+        ok: boolean;
+        result: {} | null;
+    }>;
+    /** Comments on a record (entities with `features: { comments: true }`). */
+    comments(resource: string, id: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        data: any;
+        meta: {
+            page: number;
+            pageSize: number;
+            total: any;
+            pages: number;
+        };
+    }>;
+    createComment(resource: string, id: string, body: unknown, req: ForgeRequest): Promise<{
+        id: any;
+        body: any;
+        mentions: any;
+        author: {
+            id: any;
+            name: any;
+            image: any;
+        } | null;
+        createdAt: any;
+        editedAt: any;
+        canEdit: boolean;
+        canDelete: boolean;
+    }>;
+    /** People the caller can @mention on this record (`?search=`). */
+    mentionable(resource: string, id: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        data: {
+            id: any;
+            name: any;
+            image: any;
+        }[];
+    }>;
+    updateComment(resource: string, id: string, commentId: string, body: unknown, req: ForgeRequest): Promise<{
+        id: any;
+        body: any;
+        mentions: any;
+        author: {
+            id: any;
+            name: any;
+            image: any;
+        } | null;
+        createdAt: any;
+        editedAt: any;
+        canEdit: boolean;
+        canDelete: boolean;
+    }>;
+    deleteComment(resource: string, id: string, commentId: string, req: ForgeRequest): Promise<void>;
+    /** Audit history and comments of a record, newest first (`?before=<nextCursor>&limit=`). */
+    timeline(resource: string, id: string, query: Record<string, unknown>, req: ForgeRequest): Promise<{
+        data: import("./comments.js").TimelineEvent[];
+        nextCursor: string | null;
+    }>;
+}
+export {};