ai-world-sdk 1.3.3 → 1.3.6

package/dist/database-requests.d.ts

@@ -1,151 +0,0 @@
-/**
- * Database Request Client
- * 数据库请求客户端
- * 通过后端 /api/database 提交建表/迁移请求，查看请求列表和详情
- * 所有登录用户可提交请求，管理员可审核
- */
-export interface DatabaseRequestClientConfig {
-    baseUrl?: string;
-    token?: string;
-    headers?: Record<string, string>;
-}
-export type RequestType = "create" | "migrate";
-export type RequestStatus = "pending" | "approved" | "rejected";
-export interface ColumnDefinition {
-    name: string;
-    type: string;
-    primary_key?: boolean;
-    auto_increment?: boolean;
-    nullable?: boolean;
-    default?: unknown;
-    length?: number;
-    precision?: number;
-    scale?: number;
-}
-export interface IndexDefinition {
-    name: string;
-    columns: string[];
-    unique?: boolean;
-}
-export interface ForeignKeyDefinition {
-    column: string;
-    references_table: string;
-    references_column: string;
-    on_delete?: string;
-}
-export interface SchemaDefinition {
-    columns: ColumnDefinition[];
-    indexes?: IndexDefinition[];
-    foreign_keys?: ForeignKeyDefinition[];
-}
-export interface SubmitCreateRequestOptions {
-    tableName: string;
-    schemaDefinition: SchemaDefinition;
-    description?: string;
-}
-export interface SubmitMigrateRequestOptions {
-    tableName: string;
-    migrationSql: string;
-    description?: string;
-}
-export interface DatabaseRequestInfo {
-    id: number;
-    requester_id: number;
-    plugin_id: string;
-    table_name: string;
-    request_type: RequestType;
-    schema_definition: SchemaDefinition | null;
-    migration_sql: string | null;
-    description: string | null;
-    status: RequestStatus;
-    reviewer_id: number | null;
-    review_comment: string | null;
-    created_at: string;
-    reviewed_at: string | null;
-}
-export interface ListRequestsOptions {
-    status?: RequestStatus;
-    page?: number;
-    pageSize?: number;
-}
-/**
- * Database Request Client
- * 数据库请求客户端类
- *
- * @example
- * ```typescript
- * import { DatabaseRequestClient, sdkConfig } from 'ai-world-sdk';
- *
- * sdkConfig.setPluginId('my-plugin');
- * const dbRequests = new DatabaseRequestClient();
- *
- * // 提交建表请求
- * const req = await dbRequests.submitCreateRequest({
- *   tableName: 'user_scores',
- *   schemaDefinition: {
- *     columns: [
- *       { name: 'id', type: 'integer', primary_key: true, auto_increment: true, nullable: false },
- *       { name: 'user_id', type: 'integer', nullable: false },
- *       { name: 'score', type: 'float', nullable: false },
- *     ],
- *     indexes: [{ name: 'idx_user_id', columns: ['user_id'] }],
- *   },
- *   description: '用户评分表',
- * });
- *
- * // 提交迁移请求
- * const migrateReq = await dbRequests.submitMigrateRequest({
- *   tableName: 'user_scores',
- *   migrationSql: 'ALTER TABLE my_plugin_user_scores ADD COLUMN level INTEGER DEFAULT 0;',
- *   description: '添加 level 字段',
- * });
- *
- * // 列出我的请求
- * const list = await dbRequests.listRequests({ status: 'pending' });
- *
- * // 获取请求详情
- * const detail = await dbRequests.getRequest(req.id);
- *
- * // 获取请求总数
- * const total = await dbRequests.getRequestCount({ status: 'pending' });
- * ```
- */
-export declare class DatabaseRequestClient {
-    private baseUrl;
-    private headers;
-    constructor(config?: DatabaseRequestClientConfig);
-    private getPluginId;
-    private handleErrorResponse;
-    /**
-     * Submit a table creation request
-     * 提交建表请求
-     */
-    submitCreateRequest(options: SubmitCreateRequestOptions): Promise<DatabaseRequestInfo>;
-    /**
-     * Submit a migration request
-     * 提交迁移请求
-     */
-    submitMigrateRequest(options: SubmitMigrateRequestOptions): Promise<DatabaseRequestInfo>;
-    /**
-     * List requests (admin sees all, regular users see own)
-     * 列出请求列表（管理员看全部，普通用户看自己的）
-     */
-    listRequests(options?: ListRequestsOptions): Promise<DatabaseRequestInfo[]>;
-    /**
-     * Get request count
-     * 获取请求总数
-     */
-    getRequestCount(options?: {
-        status?: RequestStatus;
-    }): Promise<number>;
-    /**
-     * Get request detail by ID
-     * 获取请求详情
-     */
-    getRequest(requestId: number): Promise<DatabaseRequestInfo>;
-    /**
-     * Review a request (approve/reject) - requires can_manage_database permission
-     * 审核请求（通过/拒绝）- 需要 can_manage_database 权限
-     */
-    reviewRequest(requestId: number, action: "approve" | "reject", comment?: string): Promise<DatabaseRequestInfo>;
-}

package/dist/database-requests.js

@@ -1,242 +0,0 @@
-"use strict";
-/**
- * Database Request Client
- * 数据库请求客户端
- * 通过后端 /api/database 提交建表/迁移请求，查看请求列表和详情
- * 所有登录用户可提交请求，管理员可审核
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseRequestClient = void 0;
-const config_1 = require("./config");
-const log_1 = require("./log");
-// ==================== DatabaseRequestClient ====================
-/**
- * Database Request Client
- * 数据库请求客户端类
- *
- * @example
- * ```typescript
- * import { DatabaseRequestClient, sdkConfig } from 'ai-world-sdk';
- *
- * sdkConfig.setPluginId('my-plugin');
- * const dbRequests = new DatabaseRequestClient();
- *
- * // 提交建表请求
- * const req = await dbRequests.submitCreateRequest({
- *   tableName: 'user_scores',
- *   schemaDefinition: {
- *     columns: [
- *       { name: 'id', type: 'integer', primary_key: true, auto_increment: true, nullable: false },
- *       { name: 'user_id', type: 'integer', nullable: false },
- *       { name: 'score', type: 'float', nullable: false },
- *     ],
- *     indexes: [{ name: 'idx_user_id', columns: ['user_id'] }],
- *   },
- *   description: '用户评分表',
- * });
- *
- * // 提交迁移请求
- * const migrateReq = await dbRequests.submitMigrateRequest({
- *   tableName: 'user_scores',
- *   migrationSql: 'ALTER TABLE my_plugin_user_scores ADD COLUMN level INTEGER DEFAULT 0;',
- *   description: '添加 level 字段',
- * });
- *
- * // 列出我的请求
- * const list = await dbRequests.listRequests({ status: 'pending' });
- *
- * // 获取请求详情
- * const detail = await dbRequests.getRequest(req.id);
- *
- * // 获取请求总数
- * const total = await dbRequests.getRequestCount({ status: 'pending' });
- * ```
- */
-class DatabaseRequestClient {
-    constructor(config = {}) {
-        this.baseUrl =
-            config.baseUrl ||
-                config_1.sdkConfig.getServerUrl() ||
-                (typeof window !== "undefined" ? window.location.origin : "");
-        const globalHeaders = config_1.sdkConfig.getHeaders();
-        const globalToken = config.token || config_1.sdkConfig.getToken();
-        this.headers = {
-            "Content-Type": "application/json",
-            ...globalHeaders,
-            ...config.headers,
-        };
-        if (globalToken) {
-            this.headers["Authorization"] = `Bearer ${globalToken}`;
-        }
-    }
-    getPluginId() {
-        const pluginId = this.headers["X-Plugin-Id"] || config_1.sdkConfig.getPluginId();
-        if (!pluginId) {
-            throw new Error("Plugin ID is required. Set it via sdkConfig.setPluginId() or pass pluginId in headers.");
-        }
-        return pluginId;
-    }
-    async handleErrorResponse(response) {
-        let errorMessage = `Request failed: ${response.status} ${response.statusText}`;
-        try {
-            const errorText = await response.text();
-            const errorJson = JSON.parse(errorText);
-            errorMessage = errorJson.detail || errorMessage;
-        }
-        catch {
-            // ignore parse error
-        }
-        throw new Error(errorMessage);
-    }
-    /**
-     * Submit a table creation request
-     * 提交建表请求
-     */
-    async submitCreateRequest(options) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const pluginId = this.getPluginId();
-        const body = {
-            plugin_id: pluginId,
-            table_name: options.tableName,
-            request_type: "create",
-            schema_definition: options.schemaDefinition,
-            description: options.description,
-        };
-        const apiUrl = `${this.baseUrl}/api/database/table-requests`;
-        (0, log_1.debugLog)("Submit create request:", body);
-        (0, log_1.logRequest)("POST", apiUrl, this.headers, body);
-        const response = await fetch(apiUrl, {
-            method: "POST",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result;
-    }
-    /**
-     * Submit a migration request
-     * 提交迁移请求
-     */
-    async submitMigrateRequest(options) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const pluginId = this.getPluginId();
-        const body = {
-            plugin_id: pluginId,
-            table_name: options.tableName,
-            request_type: "migrate",
-            migration_sql: options.migrationSql,
-            description: options.description,
-        };
-        const apiUrl = `${this.baseUrl}/api/database/table-requests`;
-        (0, log_1.debugLog)("Submit migrate request:", body);
-        (0, log_1.logRequest)("POST", apiUrl, this.headers, body);
-        const response = await fetch(apiUrl, {
-            method: "POST",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result;
-    }
-    /**
-     * List requests (admin sees all, regular users see own)
-     * 列出请求列表（管理员看全部，普通用户看自己的）
-     */
-    async listRequests(options = {}) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const params = new URLSearchParams();
-        if (options.status)
-            params.append("status", options.status);
-        if (options.page)
-            params.append("page", String(options.page));
-        if (options.pageSize)
-            params.append("page_size", String(options.pageSize));
-        const apiUrl = `${this.baseUrl}/api/database/table-requests?${params.toString()}`;
-        (0, log_1.debugLog)("List requests:", options);
-        (0, log_1.logRequest)("GET", apiUrl, this.headers);
-        const response = await fetch(apiUrl, {
-            method: "GET",
-            headers: this.headers,
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result;
-    }
-    /**
-     * Get request count
-     * 获取请求总数
-     */
-    async getRequestCount(options = {}) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const params = new URLSearchParams();
-        if (options.status)
-            params.append("status", options.status);
-        const apiUrl = `${this.baseUrl}/api/database/table-requests/count?${params.toString()}`;
-        (0, log_1.debugLog)("Get request count:", options);
-        (0, log_1.logRequest)("GET", apiUrl, this.headers);
-        const response = await fetch(apiUrl, {
-            method: "GET",
-            headers: this.headers,
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result.total;
-    }
-    /**
-     * Get request detail by ID
-     * 获取请求详情
-     */
-    async getRequest(requestId) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const apiUrl = `${this.baseUrl}/api/database/table-requests/${requestId}`;
-        (0, log_1.debugLog)("Get request detail:", { requestId });
-        (0, log_1.logRequest)("GET", apiUrl, this.headers);
-        const response = await fetch(apiUrl, {
-            method: "GET",
-            headers: this.headers,
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result;
-    }
-    /**
-     * Review a request (approve/reject) - requires can_manage_database permission
-     * 审核请求（通过/拒绝）- 需要 can_manage_database 权限
-     */
-    async reviewRequest(requestId, action, comment) {
-        config_1.sdkConfig.ensureVersionCompatible();
-        const body = { action, comment };
-        const apiUrl = `${this.baseUrl}/api/database/table-requests/${requestId}`;
-        (0, log_1.debugLog)("Review request:", { requestId, ...body });
-        (0, log_1.logRequest)("PATCH", apiUrl, this.headers, body);
-        const response = await fetch(apiUrl, {
-            method: "PATCH",
-            headers: this.headers,
-            body: JSON.stringify(body),
-        });
-        if (!response.ok) {
-            await this.handleErrorResponse(response);
-        }
-        const result = (await response.json());
-        (0, log_1.logResponse)(response.status, response.statusText, response.headers, result);
-        return result;
-    }
-}
-exports.DatabaseRequestClient = DatabaseRequestClient;

package/skills/ai-world-sdk/docs/database-requests.md

@@ -1,68 +0,0 @@
-# 数据库请求
-
-通过 `DatabaseRequestClient` 提交建表/迁移请求、查看请求列表和详情。所有登录用户可提交请求，管理员审核通过后自动执行。
-
-## 基本用法
-
-```typescript
-import { DatabaseRequestClient, sdkConfig } from 'ai-world-sdk';
-
-sdkConfig.setPluginId('my-plugin');
-const dbRequests = new DatabaseRequestClient();
-
-// 提交建表请求
-const req = await dbRequests.submitCreateRequest({
-  tableName: 'user_scores',
-  schemaDefinition: {
-    columns: [
-      { name: 'id', type: 'integer', primary_key: true, auto_increment: true, nullable: false },
-      { name: 'user_id', type: 'integer', nullable: false },
-      { name: 'score', type: 'float', nullable: false },
-    ],
-    indexes: [{ name: 'idx_user_id', columns: ['user_id'] }],
-  },
-  description: '用户评分表',
-});
-
-// 提交迁移请求
-await dbRequests.submitMigrateRequest({
-  tableName: 'user_scores',
-  migrationSql: 'ALTER TABLE my_plugin_user_scores ADD COLUMN level INTEGER DEFAULT 0;',
-  description: '添加 level 字段',
-});
-
-// 列出请求（普通用户看自己的，管理员看全部）
-const list = await dbRequests.listRequests({ status: 'pending', page: 1, pageSize: 20 });
-
-// 获取请求总数
-const total = await dbRequests.getRequestCount({ status: 'pending' });
-
-// 获取请求详情
-const detail = await dbRequests.getRequest(req.id);
-
-// 审核请求（需 can_manage_database 权限）
-await dbRequests.reviewRequest(req.id, 'approve', '审核通过');
-```
-
-## 表名规则
-
-- 实际表名 = `{pluginId}_{tableName}`
-- 只允许 `[a-z0-9_]`
-
-## 列类型白名单
-
-integer, bigint, varchar, text, boolean, float, decimal, date, datetime, timestamp, json, jsonb
-
-## 迁移 SQL 限制
-
-禁止: DROP DATABASE, TRUNCATE, DROP SCHEMA
-
-## API 端点
-
-| 方法 | 路径 | 说明 |
-|------|------|------|
-| POST | `/api/database/table-requests` | 提交建表/迁移请求 |
-| GET | `/api/database/table-requests` | 列出请求 |
-| GET | `/api/database/table-requests/count` | 请求总数 |
-| GET | `/api/database/table-requests/{id}` | 请求详情 |
-| PATCH | `/api/database/table-requests/{id}` | 审核请求 |