@zihanw/pi-forge 0.3.2 → 0.4.0

package/src/sillytavern-importer/report.ts

@@ -1,202 +0,0 @@
-import type { PromptStackItem } from "../types.ts";
-import {
-	displayMacroName,
-	MACRO_NEEDS_MIGRATION,
-	type MacroDetection,
-	NATIVE_MACRO_NOTES,
-	NATIVE_MACROS,
-} from "./macros.ts";
-import type { PromptConversionDisabledCounts, RegexScriptReport } from "./types.ts";
-
-export interface SillyTavernImportReportInput {
-	fileName: string;
-	sourcePath: string;
-	characterId: number;
-	stackId: string;
-	styleName: string;
-	totalPrompts: number;
-	orderItemCount: number;
-	items: PromptStackItem[];
-	macroUsage: MacroDetection;
-	disabledCount: PromptConversionDisabledCounts;
-	missingIdentifiers: string[];
-	regexScripts?: RegexScriptReport;
-	variables: Record<string, string>;
-	usesLastUserMessage: boolean;
-}
-
-export function buildSillyTavernImportReport(input: SillyTavernImportReportInput): string {
-	const reportLines: string[] = [];
-	reportLines.push(`# SillyTavern Import Report: ${input.fileName}`);
-	reportLines.push("");
-	reportLines.push(`- **Source file**: ${input.sourcePath}`);
-	reportLines.push(`- **Character ID**: ${input.characterId}`);
-	reportLines.push(`- **Output stack ID**: ${input.stackId}`);
-	reportLines.push(`- **Names behavior**: ${input.styleName}`);
-	reportLines.push(`- **Total prompts in source**: ${input.totalPrompts}`);
-	reportLines.push(`- **Items in prompt_order**: ${input.orderItemCount}`);
-	reportLines.push(`- **Converted items**: ${input.items.length}`);
-	reportLines.push("");
-
-	if (input.macroUsage.commentsStripped > 0) {
-		reportLines.push(`- **Comments stripped**: ${input.macroUsage.commentsStripped} ST comment blocks removed`);
-	}
-	if (input.macroUsage.trimStripped > 0) {
-		reportLines.push(`- **Trim markers removed**: ${input.macroUsage.trimStripped} {{trim}} markers (ST formatting hint)`);
-	}
-	reportLines.push("");
-
-	if (input.disabledCount.marker > 0 || input.disabledCount.empty > 0 || input.disabledCount.orderDisable > 0) {
-		reportLines.push("## Skipped items");
-		reportLines.push("");
-		if (input.disabledCount.marker > 0) {
-			reportLines.push(`- ${input.disabledCount.marker} marker items (charDescription, worldInfo, etc.) — handled by Pi/ST runtime, not needed in prompt stack`);
-		}
-		if (input.disabledCount.empty > 0) {
-			reportLines.push(`- ${input.disabledCount.empty} items with empty or missing content`);
-		}
-		if (input.disabledCount.orderDisable > 0) {
-			reportLines.push(`- ${input.disabledCount.orderDisable} items disabled in prompt_order`);
-		}
-		reportLines.push("");
-	}
-
-	if (input.missingIdentifiers.length > 0) {
-		reportLines.push("## ⚠️ Missing identifiers in prompts array");
-		reportLines.push("");
-		for (const id of input.missingIdentifiers) {
-			reportLines.push(`- \`${id}\` (referenced in prompt_order but not found in prompts)`);
-		}
-		reportLines.push("");
-	}
-
-	if (input.regexScripts && input.regexScripts.total > 0) {
-		reportLines.push("## SillyTavern regex scripts");
-		reportLines.push("");
-		reportLines.push(`- **Total scripts**: ${input.regexScripts.total}`);
-		reportLines.push(`- **Enabled scripts**: ${input.regexScripts.enabled}`);
-		reportLines.push(`- **Disabled scripts**: ${input.regexScripts.disabled}`);
-		reportLines.push(`- **Prompt-only**: ${input.regexScripts.promptOnly}`);
-		reportLines.push(`- **Markdown-only / display-only**: ${input.regexScripts.markdownOnly}`);
-		reportLines.push(`- **Prompt + markdown mixed**: ${input.regexScripts.mixed}`);
-		if (input.regexScripts.unspecified > 0) {
-			reportLines.push(`- **Enabled with unspecified mode**: ${input.regexScripts.unspecified}`);
-		}
-		reportLines.push(`- **Converted to pi-forge rules**: ${input.regexScripts.converted}`);
-		reportLines.push("");
-		reportLines.push("| Script | Enabled | Mode | Converted | Warnings | Find regex | Replacement preview |");
-		reportLines.push("|--------|---------|------|-----------|----------|------------|---------------------|");
-		for (const script of input.regexScripts.scripts) {
-			const converted = script.convertedRuleId ? `yes: ${script.convertedRuleId}` : script.conversionNote ?? "no";
-			const warnings = script.conversionWarnings.length > 0 ? script.conversionWarnings.join("; ") : "-";
-			reportLines.push(`| ${markdownTableCell(script.name)} | ${script.enabled ? "yes" : "no"} | ${script.mode} | ${markdownTableCell(converted)} | ${markdownTableCell(warnings)} | ${markdownTableCell(script.findRegex)} | ${markdownTableCell(script.replaceString)} |`);
-		}
-		reportLines.push("");
-		const warningEntries = input.regexScripts.scripts.filter((script) => script.conversionWarnings.length > 0);
-		if (warningEntries.length > 0) {
-			reportLines.push("Conversion warnings:");
-			for (const script of warningEntries) {
-				for (const warning of script.conversionWarnings) {
-					reportLines.push(`- ${script.name}: ${warning}`);
-				}
-			}
-			reportLines.push("");
-		}
-		reportLines.push("pi-forge does not run SillyTavern markdown rewriting, DOM/browser automation, CSS/HTML decoration, toasts, embedded JavaScript, or UI panel behavior.");
-		if (input.regexScripts.converted > 0) {
-			reportLines.push("Enabled and disabled prompt-only deterministic regex scripts were converted to `regex.rules` with `stage: \"history\"`, `effect: \"outgoing\"`, JavaScript replacement syntax, and preserved SillyTavern metadata under `source.sillytavern`. History-stage depth is relative to the filtered chat history inserted at the `chat-history` slot, matching SillyTavern's chat-relative depth, and rules do not touch the compiled system prompt. Use `stage: \"compiled\"` manually for global prompt transforms.");
-		}
-		reportLines.push("Markdown-only, mixed prompt/markdown, unspecified, invalid, or unsupported regex scripts remain report-only and require manual review.");
-		reportLines.push("");
-	}
-
-	if (Object.keys(input.variables).length > 0) {
-		reportLines.push("## Auto-populated variables");
-		reportLines.push("");
-		reportLines.push("These ST built-in macros were auto-populated as static variables with placeholder values:");
-		reportLines.push("");
-		for (const [key, val] of Object.entries(input.variables)) {
-			reportLines.push(`- \`${key}\` = \`${val}\` — replace with your character/persona name`);
-		}
-		reportLines.push("");
-		reportLines.push("Edit `stack.variables` in the stack JSON or web editor to set real values.");
-		reportLines.push("");
-	}
-
-	const migrationEntries = Object.entries(input.macroUsage.migrationNeeded).sort(([, a], [, b]) => b - a);
-	if (migrationEntries.length > 0) {
-		reportLines.push("## ⚠️ Macros needing manual migration");
-		reportLines.push("");
-		reportLines.push("These ST macros appear in the preset but have no direct pi-forge equivalent:");
-		reportLines.push("");
-		for (const [name, count] of migrationEntries) {
-			const note = MACRO_NEEDS_MIGRATION[name] ?? "no mapping available";
-			reportLines.push(`- **\`{{${displayMacroName(name)}}}\`** (${count} occurrence${count > 1 ? "s" : ""}) — ${note}`);
-		}
-		reportLines.push("");
-	}
-
-	const nativeDetected = [...input.macroUsage.detected].filter((macro) => NATIVE_MACROS.has(macro));
-	if (nativeDetected.length > 0) {
-		reportLines.push("## Handled macros");
-		reportLines.push("");
-		for (const name of nativeDetected) {
-			const displayName = displayMacroName(name);
-			if (name === "char" || name === "user") {
-				reportLines.push(`- \`{{${displayName}}}\` → auto-populated as static variable`);
-			} else if (name === "lastusermessage") {
-				reportLines.push(`- \`{{${displayName}}}\` → handled by pi-forge runtime (chat-history slot)`);
-			} else if (NATIVE_MACRO_NOTES[name]) {
-				reportLines.push(`- \`{{${displayName}}}\` → ${NATIVE_MACRO_NOTES[name]}`);
-			} else {
-				reportLines.push(`- \`{{${displayName}}}\` → handled natively by pi-forge`);
-			}
-		}
-		reportLines.push("");
-	}
-
-	reportLines.push("## Item mapping");
-	reportLines.push("");
-	reportLines.push("| # | ST Identifier | ST Name | pi-forge ID | Role | Enabled | Kind |");
-	reportLines.push("|---|--------------|---------|-------------|------|---------|------|");
-
-	for (const item of input.items) {
-		const stId = (item.source as Record<string, unknown> | undefined)?.previousId ?? "—";
-		const stName = item.name ?? "—";
-		const enabled = item.enabled !== false ? "✓" : "✗";
-		const kind = item.kind;
-		reportLines.push(`| ${item.id} | ${stId} | ${stName} | ${item.id} | ${item.role ?? "—"} | ${enabled} | ${kind} |`);
-	}
-
-	reportLines.push("");
-	reportLines.push("## General notes");
-	reportLines.push("");
-
-	if (input.usesLastUserMessage) {
-		reportLines.push("- Auto-detected `{{lastUserMessage}}` in post-history content. `chat-history` slot set with `includeLastUserMessage: false`.");
-	}
-
-	if (input.macroUsage.commentsStripped > 0 || input.macroUsage.trimStripped > 0) {
-		reportLines.push(`- ${input.macroUsage.commentsStripped} ST comment blocks and ${input.macroUsage.trimStripped} TRIM markers were stripped during import.`);
-	}
-
-	reportLines.push("- All items are assigned sequential numeric IDs. Original SillyTavern identifiers are preserved in `source.previousId`.");
-	reportLines.push("- Marker items for world info, character description, persona, scenario, and dialogue examples are omitted — these are handled by the SillyTavern frontend and have no direct pi-forge equivalent.");
-	reportLines.push(`- The stack is set with \`autoActivate: false\`. Use \`/preset use ${input.stackId}\` to activate.`);
-	reportLines.push("");
-	reportLines.push("## Suggested next steps");
-	reportLines.push("");
-	reportLines.push("1. Set real values for auto-populated variables by editing `stack.variables`.");
-	reportLines.push("2. Review items with migration-needed macros and rewrite for pi-forge's macro system.");
-	reportLines.push("3. Consider adding a `variables` slot for template variable visibility.");
-	reportLines.push(`4. Run \`/preset validate ${input.stackId}\` to check for issues.`);
-
-	return reportLines.join("\n");
-}
-
-function markdownTableCell(value: unknown): string {
-	if (typeof value !== "string" || !value.trim()) return "-";
-	const collapsed = value.replace(/\s+/g, " ").trim();
-	const truncated = collapsed.length > 96 ? `${collapsed.slice(0, 93)}...` : collapsed;
-	return truncated.replace(/\|/g, "\\|");
-}

package/src/sillytavern-importer/types.ts

@@ -1,120 +0,0 @@
-import type { PromptRegexRule, PromptStack, PromptStackItem } from "../types.ts";
-
-export interface StPreset {
-	prompts?: StPromptDef[];
-	prompt_order?: StPromptOrderEntry[];
-	extensions?: {
-		regex_scripts?: unknown[];
-		[key: string]: unknown;
-	};
-	names_behavior?: number;
-	preset_name?: string;
-	name?: string;
-	[key: string]: unknown;
-}
-
-export interface StPromptDef {
-	identifier: string;
-	name?: string;
-	role?: string;
-	content?: string;
-	system_prompt?: boolean;
-	marker?: boolean;
-	enabled?: boolean;
-}
-
-export interface StPromptOrderEntry {
-	character_id: number;
-	order?: StOrderItem[];
-}
-
-export interface StOrderItem {
-	identifier: string;
-	enabled: boolean;
-}
-
-export interface StRegexScript {
-	script_name?: string;
-	scriptName?: string;
-	name?: string;
-	disabled?: boolean;
-	promptOnly?: boolean;
-	markdownOnly?: boolean;
-	findRegex?: string;
-	replaceString?: string;
-	trimStrings?: unknown;
-	substituteRegex?: unknown;
-	placement?: unknown;
-	minDepth?: unknown;
-	maxDepth?: unknown;
-	runOnEdit?: unknown;
-	[key: string]: unknown;
-}
-
-export interface StConversionItem {
-	def: StPromptDef;
-	orderEnabled: boolean;
-	orderIndex: number;
-}
-
-export type RegexScriptMode = "prompt-only" | "markdown-only" | "prompt+markdown" | "unspecified" | "disabled";
-
-export interface RegexScriptReportEntry {
-	name: string;
-	mode: RegexScriptMode;
-	enabled: boolean;
-	promptOnly: boolean;
-	markdownOnly: boolean;
-	findRegex?: string;
-	replaceString?: string;
-	trimStrings?: string[];
-	placement?: number[];
-	substituteRegex?: number;
-	minDepth?: number;
-	maxDepth?: number;
-	convertedRuleId?: string;
-	conversionNote?: string;
-	conversionWarnings: string[];
-}
-
-export interface RegexScriptReport {
-	total: number;
-	enabled: number;
-	disabled: number;
-	promptOnly: number;
-	markdownOnly: number;
-	mixed: number;
-	unspecified: number;
-	converted: number;
-	scripts: RegexScriptReportEntry[];
-	rules: PromptRegexRule[];
-}
-
-export interface PromptConversionDisabledCounts {
-	marker: number;
-	empty: number;
-	orderDisable: number;
-}
-
-export interface PromptConversionResult {
-	items: PromptStackItem[];
-	usesLastUserMessage: boolean;
-	disabledCount: PromptConversionDisabledCounts;
-}
-
-export interface SillyTavernImportResult {
-	stack: PromptStack;
-	report: string;
-}
-
-export interface SillyTavernImportError {
-	error: string;
-}
-
-export type SillyTavernImportOutcome = SillyTavernImportResult | SillyTavernImportError;
-
-export interface SillyTavernConvertOptions {
-	sourceName?: string;
-	sourcePath?: string;
-	characterId?: number;
-}

package/src/sillytavern-importer.ts

@@ -1,152 +0,0 @@
-import { readFileSync } from "node:fs";
-import { basename } from "node:path";
-import { convertPromptItems } from "./sillytavern-importer/items.ts";
-import { detectMacros } from "./sillytavern-importer/macros.ts";
-import {
-	buildConversionItems,
-	buildPromptMap,
-	findMissingIdentifiers,
-	selectCharacterEntry,
-} from "./sillytavern-importer/prompt-order.ts";
-import { summarizeRegexScripts } from "./sillytavern-importer/regex.ts";
-import { buildSillyTavernImportReport } from "./sillytavern-importer/report.ts";
-import type {
-	SillyTavernConvertOptions,
-	SillyTavernImportOutcome,
-	StPreset,
-} from "./sillytavern-importer/types.ts";
-import type { PromptStack } from "./types.ts";
-
-export type {
-	SillyTavernConvertOptions,
-	SillyTavernImportError,
-	SillyTavernImportOutcome,
-	SillyTavernImportResult,
-} from "./sillytavern-importer/types.ts";
-
-export function importSillyTavernPreset(
-	filePath: string,
-	characterId?: number,
-): SillyTavernImportOutcome {
-	let raw: unknown;
-	try {
-		raw = JSON.parse(readFileSync(filePath, "utf8"));
-	} catch (err) {
-		return { error: `Failed to read or parse ${filePath}: ${err instanceof Error ? err.message : String(err)}` };
-	}
-
-	if (!raw || typeof raw !== "object" || Array.isArray(raw)) {
-		return { error: "Preset root must be a JSON object." };
-	}
-
-	return convertSillyTavernPreset(raw, { sourceName: filePath, sourcePath: filePath, characterId });
-}
-
-export function convertSillyTavernPreset(
-	raw: unknown,
-	options: SillyTavernConvertOptions = {},
-): SillyTavernImportOutcome {
-	if (!raw || typeof raw !== "object" || Array.isArray(raw)) {
-		return { error: "Preset root must be a JSON object." };
-	}
-
-	const preset = raw as StPreset;
-	const fallbackName = typeof preset.preset_name === "string" && preset.preset_name.trim()
-		? preset.preset_name
-		: typeof preset.name === "string" && preset.name.trim()
-			? preset.name
-			: "imported.json";
-	const sourceName = options.sourceName ?? fallbackName;
-	const sourcePath = options.sourcePath ?? sourceName;
-	const allPrompts = preset.prompts ?? [];
-	const promptOrder = preset.prompt_order ?? [];
-	const regexScripts = summarizeRegexScripts(preset);
-
-	if (allPrompts.length === 0) {
-		return { error: "Preset has no prompts array." };
-	}
-
-	const selectedEntry = selectCharacterEntry(promptOrder, options.characterId);
-	if (!selectedEntry) {
-		const ids = promptOrder.map((entry) => entry.character_id);
-		if (ids.length === 0) {
-			return { error: "Preset has no prompt_order entries. Choose a character_id and retry." };
-		}
-		return {
-			error: `Multiple character configs found: [${ids.join(", ")}]. Choose a character_id and retry.`,
-		};
-	}
-
-	const promptMap = buildPromptMap(allPrompts);
-	const conversionItems = buildConversionItems(selectedEntry, promptMap);
-	const macroUsage = detectMacros(conversionItems);
-	const { items, disabledCount, usesLastUserMessage: itemUsesLastUserMessage } = convertPromptItems(conversionItems);
-	const missingIdentifiers = findMissingIdentifiers(selectedEntry, promptMap);
-	const fileName = basename(sourceName).replace(/\.json$/i, "") || "imported";
-	const styleName = preset.names_behavior === 1 ? "names" : preset.names_behavior === 2 ? "nonames" : "default";
-	const stackId = normalizeStackId(fileName);
-	const variables = buildStaticVariables(macroUsage.detected);
-	let usesLastUserMessage = itemUsesLastUserMessage;
-
-	const stack: PromptStack = {
-		schemaVersion: 1,
-		type: "pi-forge.prompt-stack",
-		id: stackId,
-		name: preset.preset_name || preset.name || fileName,
-		autoActivate: false,
-		mode: "replace",
-		variables: Object.keys(variables).length > 0 ? variables : undefined,
-		context: { allowDuplicateChatHistory: false },
-		regex: regexScripts && regexScripts.rules.length > 0 ? { schemaVersion: 1, rules: regexScripts.rules } : undefined,
-		items,
-		import: {
-			source: "sillytavern",
-			sourceFile: fileName,
-			characterId: selectedEntry.character_id,
-			convertedAt: new Date().toISOString(),
-		},
-	};
-
-	if (macroUsage.detected.has("lastusermessage")) usesLastUserMessage = true;
-	if (usesLastUserMessage) {
-		const chatHistoryItem = items.find(
-			(item) => item.kind === "slot" && item.slot === "chat-history",
-		);
-		if (chatHistoryItem && chatHistoryItem.kind === "slot") {
-			chatHistoryItem.options = { includeLastUserMessage: false };
-		}
-	}
-
-	const report = buildSillyTavernImportReport({
-		fileName,
-		sourcePath,
-		characterId: selectedEntry.character_id,
-		stackId,
-		styleName: `${styleName} (ST value ${preset.names_behavior ?? "?"})`,
-		totalPrompts: allPrompts.length,
-		orderItemCount: selectedEntry.order?.length ?? 0,
-		items,
-		macroUsage,
-		disabledCount,
-		missingIdentifiers,
-		regexScripts,
-		variables,
-		usesLastUserMessage,
-	});
-
-	return {
-		stack,
-		report,
-	};
-}
-
-function normalizeStackId(fileName: string): string {
-	return fileName.replace(/[^a-zA-Z0-9_-]/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "").toLowerCase() || "imported";
-}
-
-function buildStaticVariables(detectedMacros: Set<string>): Record<string, string> {
-	const variables: Record<string, string> = {};
-	if (detectedMacros.has("char")) variables.char = "{{char}}";
-	if (detectedMacros.has("user")) variables.user = "{{user}}";
-	return variables;
-}