@musnows/scriverse 0.7.13 → 0.8.1

package/dist/app.js

@@ -9,8 +9,9 @@ import { rm } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { pipeline } from "node:stream/promises";
 import { z, ZodError } from "zod";
-import { AI_PROVIDER_PROTOCOLS } from "./ai-protocol.js";
+import { AI_PROVIDER_PROTOCOLS, MAX_TOKENS_PARAMETERS } from "./ai-protocol.js";
 import { aiConversationExportContentDisposition, exportAiConversationMarkdown } from "./ai-conversation-export.js";
+import { DEFAULT_AI_CHAT_TAB_LIMIT } from "./ai-chat-tab-limit.js";
 import { DEFAULT_AI_STREAM_IDLE_TIMEOUT_MS } from "./ai-stream-timeout.js";
 import { AttachmentStorage } from "./attachment-storage.js";
 import { AiManager } from "./ai.js";
@@ -20,12 +21,12 @@ import { CredentialVault } from "./credential-vault.js";
 import { Database } from "./database.js";
 import { assertSafeDocxArchive } from "./docx-security.js";
 import { EPUB_MIME_TYPE, epubContentDisposition } from "./epub-export.js";
-import { CREATABLE_ANALYSIS_TASK_TYPES, DRAFT_SETTING_MODULES, TASK_TYPES } from "./domain.js";
+import { CHARACTER_GENDERS, CREATABLE_ANALYSIS_TASK_TYPES, DRAFT_SETTING_MODULES, TASK_TYPES } from "./domain.js";
 import { AppError } from "./errors.js";
 import { isOfficialGoogleVertexBaseUrl, parseGoogleServiceAccount } from "./google-vertex-auth.js";
 import { HYBRID_SEARCH_TYPES, MAXIMUM_WORK_SEARCH_QUERY_LENGTH, readableHybridSearchTypes } from "./hybrid-search.js";
 import { applyImportFileHints, parseNovelText } from "./parser.js";
-import { aiConversationTaskTypes, attachmentPermissionModules, RECYCLE_BIN_RETENTION_DAYS, Store, versionedEntityTypes } from "./store.js";
+import { aiConversationTaskTypes, attachmentPermissionModules, RECYCLE_BIN_RETENTION_DAYS, Store, versionedEntityTypes, WORK_AGENT_TOOL_IDS } from "./store.js";
 import { paginated, parsePagination } from "./pagination.js";
 import { normalizeUploadFileName } from "./utils.js";
 import { assertSafeAiEndpoint, assertSafeS3Endpoint, createApiRateLimitMiddleware, createAuthenticationRateLimitMiddleware, createBasicAuthMiddleware, createCaptchaRateLimitMiddleware, createExpensiveApiRateLimitMiddleware, createSameOriginMiddleware, createSecurityHeadersMiddleware, createUploadRateLimitMiddleware, enforceCaseInsensitiveRouting, normalizeApiPath, resolveTrustProxySetting, verifySetupToken } from "./security.js";
@@ -39,10 +40,14 @@ import { S3BackupManager } from "./s3-backup.js";
 import { APP_VERSION } from "./version.js";
 import { ReleaseUpdateChecker } from "./release-update.js";
 import { DEFAULT_IMAGE_UPLOAD_LIMITS, formatUploadLimit } from "./upload-limits.js";
-import { canReadWorkModule, canWriteWorkModule, fullWorkModulePermissions, proseReplacementPermissionModules } from "./work-permissions.js";
+import { canReadWorkModule, canWriteWorkModule, chapterAnnotationPermissionModule, fullWorkModulePermissions, proseReplacementPermissionModules } from "./work-permissions.js";
 import { CollaborationPresence, editorPageKey, entityEditorPageKey, modulePageKey, presencePageKinds } from "./collaboration-presence.js";
 import { PresenceStore } from "./presence-store.js";
 import { analysisTaskReadModules, clearSessionCookie, createCliApiScopeMiddleware, createUserSessionMiddleware, createWorkAuthorizationMiddleware, relationshipAnalysisReadModules, setSessionCookie, UserAuthService } from "./user-auth.js";
+const chapterAnnotationKinds = ["note", "todo"];
+function readableChapterAnnotationKinds(permissions) {
+    return chapterAnnotationKinds.filter((kind) => canReadWorkModule(permissions, chapterAnnotationPermissionModule(kind)));
+}
 const nonEmpty = z.string().trim().min(1);
 const identifier = z.string().trim().min(1).max(200);
 const idempotencyKeySchema = z.string().trim().min(16).max(128)
@@ -109,6 +114,8 @@ const memberRoleValueSchema = z.enum(["editor", "settings-editor", "viewer"]);
 const moduleAccessSchema = z.enum(["none", "read", "write"]);
 const modulePermissionsSchema = z.object({
     prose: moduleAccessSchema,
+    comments: moduleAccessSchema.optional(),
+    todos: moduleAccessSchema.optional(),
     drafts: moduleAccessSchema.optional(),
     settings: moduleAccessSchema,
     characters: moduleAccessSchema,
@@ -123,6 +130,8 @@ const modulePermissionsSchema = z.object({
     "ai-settings": moduleAccessSchema
 }).strict().transform((permissions) => ({
     ...permissions,
+    comments: permissions.comments ?? permissions.prose,
+    todos: permissions.todos ?? permissions.prose,
     drafts: permissions.drafts ?? (permissions.prose === "write" && permissions.settings === "write"
         ? "write"
         : permissions.prose === "none" || permissions.settings === "none" ? "none" : "read")
@@ -189,7 +198,8 @@ const settingSchema = z.object({
 const globalReplaceSchema = z.object({
     find: z.string().min(1).max(500),
     replacement: z.string().max(200_000),
-    scope: z.enum(["prose", "settings", "prose-and-settings"])
+    scope: z.enum(["prose", "settings", "prose-and-settings"]),
+    volumeId: identifier.nullable().optional()
 }).strict();
 const draftSchema = z.object({
     draftType: z.enum(["prose", "setting"]),
@@ -200,6 +210,7 @@ const draftSchema = z.object({
 }).strict();
 const characterSchema = z.object({
     name: nonEmpty.max(200),
+    gender: z.enum(CHARACTER_GENDERS).optional(),
     isDead: z.boolean().optional(),
     code: z.string().trim().max(200).optional(),
     aliases: z.array(z.string().trim().min(1).max(200)).max(100).optional(),
@@ -344,6 +355,7 @@ const providerBaseSchema = z.object({
     baseUrl: z.string().url().refine((value) => value.startsWith("http://") || value.startsWith("https://"), "接口地址必须使用 HTTP 或 HTTPS"),
     apiKey: z.string().trim().min(1).max(50_000),
     protocol: z.enum(AI_PROVIDER_PROTOCOLS).optional(),
+    maxTokensParameter: z.enum(MAX_TOKENS_PARAMETERS).optional(),
     status: z.enum(["enabled", "disabled"]).optional(),
     note: z.string().max(10_000).optional(),
     concurrencyLimit: z.number().int().min(1).max(100).optional(),
@@ -396,6 +408,7 @@ const modelSchema = z.object({
     outputNote: z.string().max(10_000).optional(),
     preset: jsonObject.optional(),
     thinkingEnabled: z.boolean().optional(),
+    thinkingEffort: z.enum(["default", "low", "medium", "high", "xhigh", "max"]).optional(),
     multimodalEnabled: z.boolean().optional(),
     imageToolDefault: z.boolean().optional(),
     enabled: z.boolean().optional(),
@@ -536,11 +549,12 @@ const workAiSettingsSchema = z.object({
     autoRunBatchLimit: z.number().int().min(1).max(200).optional(),
     autoRunDailyTaskLimit: z.number().int().min(0).max(10_000).optional(),
     autoRunFailureThreshold: z.number().int().min(1).max(10).optional(),
+    autoRunStabilityDelayMinutes: z.number().int().min(1).max(120).optional(),
     bookSummaryContextPercent: z.number().int().min(1).max(90).optional(),
     contextCompactThreshold: z.number().int().min(50).max(90).optional(),
     agentToolCallLimit: z.number().int().min(5).optional(),
     agentToolCallGlobalMultiplier: z.number().int().min(1).max(6).optional(),
-    agentTools: z.array(z.enum(["story_index", "read_chapters", "grep", "search_story_entities", "read_character_sections", "search_drafts", "image"])).max(7).optional(),
+    agentTools: z.array(z.enum(WORK_AGENT_TOOL_IDS)).max(WORK_AGENT_TOOL_IDS.length).optional(),
     alwaysIncludeSettingInfo: z.boolean().optional(),
     titleGenerationModelId: z.string().trim().max(200).optional(),
     imageToolModelId: identifier.nullable().optional()
@@ -605,8 +619,8 @@ const relationshipAnalysisScopeSchema = z.object({
     if (scope.volumeIds && new Set(scope.volumeIds).size !== scope.volumeIds.length) {
         context.addIssue({ code: z.ZodIssueCode.custom, path: ["volumeIds"], message: "分卷不能重复选择" });
     }
-    if (scope.includeAllSettings && scope.type !== "book") {
-        context.addIssue({ code: z.ZodIssueCode.custom, path: ["includeAllSettings"], message: "包含所有设定仅支持全书人物关系分析" });
+    if (scope.includeAllSettings && scope.type !== "book" && scope.type !== "chapter") {
+        context.addIssue({ code: z.ZodIssueCode.custom, path: ["includeAllSettings"], message: "包含所有设定仅支持全书或指定章节人物关系分析" });
     }
     if (scope.characterIds && new Set(scope.characterIds).size !== scope.characterIds.length) {
         context.addIssue({ code: z.ZodIssueCode.custom, path: ["characterIds"], message: "被分析角色不能重复" });
@@ -926,12 +940,18 @@ function redactAiConversationMessage(item, permissions) {
     if (!message)
         return item;
     if (permissions.prose !== "none") {
-        if (permissions.characters !== "none")
-            return item;
         const metadata = recordValue(message.metadata);
-        if (!metadata || !("mentionCharacterIds" in metadata))
+        if (!metadata)
+            return item;
+        const readableMetadata = { ...metadata };
+        if (permissions.characters === "none")
+            delete readableMetadata.mentionCharacterIds;
+        if (permissions.races === "none")
+            delete readableMetadata.mentionRaceIds;
+        if (permissions.organizations === "none")
+            delete readableMetadata.mentionOrganizationIds;
+        if (Object.keys(readableMetadata).length === Object.keys(metadata).length)
             return item;
-        const { mentionCharacterIds: _mentionCharacterIds, ...readableMetadata } = metadata;
         return { ...message, metadata: readableMetadata };
     }
     return {
@@ -949,6 +969,13 @@ function redactAiConversation(record, permissions) {
     const result = {
         ...scopedRecord
     };
+    if (result.roleplayCharacter) {
+        result.agentTools = [
+            ...(permissions.characters !== "none" ? ["recall_self"] : []),
+            ...(permissions.characters !== "none" && permissions.relationships !== "none" ? ["recall_relationship"] : []),
+            "calculate_time"
+        ];
+    }
     if ((permissions.prose === "none" || permissions.characters === "none") && Array.isArray(result.messages)) {
         result.messages = result.messages.map((item) => redactAiConversationMessage(item, permissions));
     }
@@ -1007,6 +1034,7 @@ function redactVersionSnapshots(value, mapper) {
 }
 export function createRuntime(options) {
     const uploadLimits = options.uploadLimits ?? DEFAULT_IMAGE_UPLOAD_LIMITS;
+    const aiChatTabLimit = options.aiChatTabLimit ?? DEFAULT_AI_CHAT_TAB_LIMIT;
     logger.info("runtime.initializing", {
         databasePath: options.databasePath,
         serveUi: options.serveUi ?? true,
@@ -1124,7 +1152,11 @@ export function createRuntime(options) {
             read: requiredModules,
             write: ["ai-analysis"]
         }, false, actor?.allowAdminAccess ?? false);
-    }, attachmentStorage, { interactiveStreamIdleTimeoutMs: options.aiStreamIdleTimeoutMs ?? DEFAULT_AI_STREAM_IDLE_TIMEOUT_MS });
+    }, attachmentStorage, {
+        interactiveStreamIdleTimeoutMs: options.aiStreamIdleTimeoutMs ?? DEFAULT_AI_STREAM_IDLE_TIMEOUT_MS,
+        retryPolicy: options.aiRetryPolicy,
+        retrySleep: options.aiRetrySleep
+    });
     const app = express();
     enforceCaseInsensitiveRouting(app);
     const upload = multer({
@@ -1160,9 +1192,11 @@ export function createRuntime(options) {
             status: "ok",
             bootId,
             version: APP_VERSION,
+            versionLabel: options.betaVersionLabel ?? null,
             protocol: "openai-chat-completions",
             protocols: [...AI_PROVIDER_PROTOCOLS],
             development: options.developmentServer === true,
+            aiChatTabLimit,
             uploadLimits
         });
     });
@@ -1589,12 +1623,23 @@ export function createRuntime(options) {
         const pagination = parsePagination(request.query);
         data(response, pagination ? store.listChapterInsightsPage(request.params.chapterId, pagination) : store.listChapterInsights(request.params.chapterId));
     });
-    app.get("/api/chapters/:chapterId/annotations", (request, response) => data(response, store.listChapterAnnotations(request.params.chapterId)));
+    app.get("/api/chapters/:chapterId/annotation-counts", (request, response) => {
+        const permissions = requestPermissions(request);
+        data(response, store.listChapterAnnotationCounts(request.params.chapterId, readableChapterAnnotationKinds(permissions)));
+    });
+    app.get("/api/chapters/:chapterId/annotations", (request, response) => {
+        const line = request.query.line === undefined
+            ? undefined
+            : parse(z.coerce.number().int().positive().max(100_000), request.query.line);
+        const permissions = requestPermissions(request);
+        data(response, store.listChapterAnnotations(request.params.chapterId, readableChapterAnnotationKinds(permissions), line));
+    });
     app.get("/api/works/:workId/chapter-annotations", (request, response) => {
         const pagination = parsePagination(request.query);
+        const permissions = requestPermissions(request, request.params.workId);
         data(response, pagination
-            ? store.listWorkChapterAnnotationsPage(request.params.workId, pagination)
-            : store.listWorkChapterAnnotations(request.params.workId));
+            ? store.listWorkChapterAnnotationsPage(request.params.workId, pagination, readableChapterAnnotationKinds(permissions))
+            : store.listWorkChapterAnnotations(request.params.workId, readableChapterAnnotationKinds(permissions)));
     });
     app.post("/api/chapters/:chapterId/annotations", (request, response) => {
         const input = parse(z.object({
@@ -2173,9 +2218,16 @@ export function createRuntime(options) {
         }
         data(response, await ai.previewRelationshipSources(request.params.workId, input.scope, input.modelId));
     });
-    app.post("/api/works/:workId/tasks", (request, response) => {
+    app.post("/api/works/:workId/tasks", async (request, response) => {
         const input = parse(analysisTaskSchema, request.body);
-        data(response, redactTaskCharacterNames(ai.createTask(request.params.workId, input), requestPermissions(request, request.params.workId)), 201);
+        const permissions = requestPermissions(request, request.params.workId);
+        const deniedModules = analysisTaskReadModules(input.taskType, input.scope).filter((module) => permissions[module] === "none");
+        if (deniedModules.length > 0) {
+            throw new AppError(403, "WORK_MODULE_READ_DENIED", "你没有读取创建分析任务所需资料模块的权限", {
+                modules: deniedModules
+            });
+        }
+        data(response, redactTaskCharacterNames(await ai.createTask(request.params.workId, input), permissions), 201);
     });
     app.post("/api/works/:workId/tasks/auto-run", (request, response) => {
         const permissions = requestPermissions(request, request.params.workId);
@@ -2223,7 +2275,7 @@ export function createRuntime(options) {
             allowAdminAccess: request.authMethod !== "api-key"
         } : undefined), requestPermissions(request)));
     });
-    app.post("/api/tasks/:taskId/rerun", (request, response) => {
+    app.post("/api/tasks/:taskId/rerun", async (request, response) => {
         const input = parse(z.object({ modelId: identifier.optional() }).strict(), request.body ?? {});
         const task = store.getTask(request.params.taskId);
         const permissions = requestPermissions(request, String(task.workId));
@@ -2233,7 +2285,7 @@ export function createRuntime(options) {
                 modules: deniedModules
             });
         }
-        data(response, redactTaskCharacterNames(ai.rerunTask(request.params.taskId, input.modelId), requestPermissions(request)), 201);
+        data(response, redactTaskCharacterNames(await ai.rerunTask(request.params.taskId, input.modelId), requestPermissions(request)), 201);
     });
     app.post("/api/tasks/:taskId/cancel", (request, response) => data(response, redactTaskCharacterNames(ai.cancelTask(request.params.taskId), requestPermissions(request))));
     app.post("/api/tasks/:taskId/character-extraction/apply", (request, response) => {
@@ -2353,6 +2405,8 @@ export function createRuntime(options) {
             else
                 ai.scheduleAutoRun(workId);
         }
+        if (input.autoRunStabilityDelayMinutes !== undefined)
+            ai.rescheduleChapterAnalysisTasks(workId);
         data(response, updated);
     });
     app.get("/api/works/:workId/ai-conversations", (request, response) => {
@@ -2680,6 +2734,8 @@ export function createRuntime(options) {
                     ...(resolvedScope.characterIds ?? []),
                     ...(resolvedScope.mentionCharacterIds ?? [])
                 ])];
+            const mentionRaceIds = [...new Set(resolvedScope.raceIds ?? [])];
+            const mentionOrganizationIds = [...new Set(resolvedScope.organizationIds ?? [])];
             const begun = store.beginAiConversationStreamRequest({
                 workId: request.params.workId,
                 conversationId,
@@ -2690,9 +2746,11 @@ export function createRuntime(options) {
                     content: input.instruction,
                     citations,
                     ...(input.currentMessageId ? { existingMessageId: input.currentMessageId } : {}),
-                    ...((modelId || mentionCharacterIds.length) ? { metadata: {
+                    ...((modelId || mentionCharacterIds.length || mentionRaceIds.length || mentionOrganizationIds.length) ? { metadata: {
                             ...(modelId ? { modelId } : {}),
-                            ...(mentionCharacterIds.length ? { mentionCharacterIds } : {})
+                            ...(mentionCharacterIds.length ? { mentionCharacterIds } : {}),
+                            ...(mentionRaceIds.length ? { mentionRaceIds } : {}),
+                            ...(mentionOrganizationIds.length ? { mentionOrganizationIds } : {})
                         } } : {})
                 }
             });