@rohal12/twee-ts 1.7.0 → 1.9.0

package/dist/index.d.cts

@@ -161,6 +161,11 @@ interface SFAIndex {
     twine1: SFAIndexEntry[];
     twine2: SFAIndexEntry[];
 }
+interface FileCacheEntry {
+    readonly mtimeMs: number;
+    readonly passages: readonly Passage[];
+    readonly diagnostics: readonly Diagnostic[];
+}
 interface TweeTsConfig {
     sources?: string[];
     output?: string;
@@ -193,6 +198,11 @@ declare function compile(options: CompileOptions): Promise<CompileResult>;
  * Compile and write to a file.
  */
 declare function compileToFile(options: CompileToFileOptions): Promise<CompileResult>;
+/**
+ * Compile with incremental caching support.
+ * Plugins and advanced users can manage their own cache and changed-file tracking.
+ */
+declare function compileIncremental(options: CompileOptions, cache: Map<string, FileCacheEntry>, changedFiles?: ReadonlySet<string>): Promise<CompileResult>;
 /**
  * Watch for file changes and recompile.
  */
@@ -411,5 +421,21 @@ declare function fetchDirectFormat(url: string): Promise<StoryFormatInfo>;
 declare function resolveRemoteFormat(name: string, version: string, indices?: string[], urls?: string[]): Promise<StoryFormatInfo | undefined>;
 /** Discover all cached remote formats. Returns a Map like discoverFormats(). */
 declare function discoverCachedFormats(): Map<string, StoryFormatInfo>;
+/** Info about a cached format entry with size and modification date. */
+interface CachedFormatEntry {
+    readonly name: string;
+    readonly version: string;
+    readonly sizeBytes: number;
+    readonly modifiedAt: Date;
+}
+/** List all cached formats with size and modification date. */
+declare function listCachedFormats(): readonly CachedFormatEntry[];
+/** Clear all cached formats, or only those matching a given name. Returns the number of entries removed. */
+declare function clearCachedFormats(name?: string): number;
+/** Get total cache size in bytes and format count. */
+declare function getCacheSize(): {
+    totalBytes: number;
+    count: number;
+};
 
-export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type LintResult, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getFormatSearchDirs, lint, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.d.ts

@@ -161,6 +161,11 @@ interface SFAIndex {
     twine1: SFAIndexEntry[];
     twine2: SFAIndexEntry[];
 }
+interface FileCacheEntry {
+    readonly mtimeMs: number;
+    readonly passages: readonly Passage[];
+    readonly diagnostics: readonly Diagnostic[];
+}
 interface TweeTsConfig {
     sources?: string[];
     output?: string;
@@ -193,6 +198,11 @@ declare function compile(options: CompileOptions): Promise<CompileResult>;
  * Compile and write to a file.
  */
 declare function compileToFile(options: CompileToFileOptions): Promise<CompileResult>;
+/**
+ * Compile with incremental caching support.
+ * Plugins and advanced users can manage their own cache and changed-file tracking.
+ */
+declare function compileIncremental(options: CompileOptions, cache: Map<string, FileCacheEntry>, changedFiles?: ReadonlySet<string>): Promise<CompileResult>;
 /**
  * Watch for file changes and recompile.
  */
@@ -411,5 +421,21 @@ declare function fetchDirectFormat(url: string): Promise<StoryFormatInfo>;
 declare function resolveRemoteFormat(name: string, version: string, indices?: string[], urls?: string[]): Promise<StoryFormatInfo | undefined>;
 /** Discover all cached remote formats. Returns a Map like discoverFormats(). */
 declare function discoverCachedFormats(): Map<string, StoryFormatInfo>;
+/** Info about a cached format entry with size and modification date. */
+interface CachedFormatEntry {
+    readonly name: string;
+    readonly version: string;
+    readonly sizeBytes: number;
+    readonly modifiedAt: Date;
+}
+/** List all cached formats with size and modification date. */
+declare function listCachedFormats(): readonly CachedFormatEntry[];
+/** Clear all cached formats, or only those matching a given name. Returns the number of entries removed. */
+declare function clearCachedFormats(name?: string): number;
+/** Get total cache size in bytes and format count. */
+declare function getCacheSize(): {
+    totalBytes: number;
+    count: number;
+};
 
-export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type LintResult, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getFormatSearchDirs, lint, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.js

@@ -1853,7 +1853,7 @@ function modifyHead(html, modulePaths, headFile, diagnostics) {
 }
 
 // src/remote-formats.ts
-import { mkdirSync, readFileSync as readFileSync3, writeFileSync, existsSync, readdirSync as readdirSync3, statSync as statSync4 } from "fs";
+import { mkdirSync, readFileSync as readFileSync3, writeFileSync, existsSync, readdirSync as readdirSync3, statSync as statSync4, rmSync } from "fs";
 import { join as join4 } from "path";
 import { homedir as homedir2 } from "os";
 var DEFAULT_SFA_INDICES = [
@@ -2084,6 +2084,75 @@ function discoverCachedFormats() {
   }
   return formats;
 }
+function listCachedFormats() {
+  const cacheDir = getCacheDir();
+  const entries = [];
+  try {
+    if (!existsSync(cacheDir)) return entries;
+  } catch {
+    return entries;
+  }
+  let names;
+  try {
+    names = readdirSync3(cacheDir);
+  } catch {
+    return entries;
+  }
+  for (const name of names) {
+    const nameDir = join4(cacheDir, name);
+    try {
+      if (!statSync4(nameDir).isDirectory()) continue;
+    } catch {
+      continue;
+    }
+    let versions;
+    try {
+      versions = readdirSync3(nameDir);
+    } catch {
+      continue;
+    }
+    for (const version of versions) {
+      const formatPath = join4(nameDir, version, "format.js");
+      try {
+        const stat = statSync4(formatPath);
+        entries.push({
+          name,
+          version,
+          sizeBytes: stat.size,
+          modifiedAt: stat.mtime
+        });
+      } catch {
+      }
+    }
+  }
+  return entries;
+}
+function clearCachedFormats(name) {
+  const cacheDir = getCacheDir();
+  if (!existsSync(cacheDir)) return 0;
+  if (!name) {
+    const entries = listCachedFormats();
+    const count2 = entries.length;
+    rmSync(cacheDir, { recursive: true, force: true });
+    return count2;
+  }
+  const nameDir = join4(cacheDir, name);
+  if (!existsSync(nameDir)) return 0;
+  let versions;
+  try {
+    versions = readdirSync3(nameDir);
+  } catch {
+    return 0;
+  }
+  const count = versions.length;
+  rmSync(nameDir, { recursive: true, force: true });
+  return count;
+}
+function getCacheSize() {
+  const entries = listCachedFormats();
+  const totalBytes = entries.reduce((sum, e) => sum + e.sizeBytes, 0);
+  return { totalBytes, count: entries.length };
+}
 
 // src/compiler.ts
 var CREATOR_NAME3 = "Twee-ts";
@@ -2104,6 +2173,9 @@ async function compileToFile(options) {
   writeFileSync2(options.outFile, result.output, "utf-8");
   return result;
 }
+async function compileIncremental(options, cache, changedFiles) {
+  return buildOutput(options, cache, changedFiles);
+}
 async function watch(options) {
   const controller = new AbortController();
   const cache = /* @__PURE__ */ new Map();
@@ -2554,7 +2626,9 @@ export {
   TweeLexer,
   TweeTsError,
   applyTagAliases,
+  clearCachedFormats,
   compile,
+  compileIncremental,
   compileToFile,
   discoverCachedFormats,
   discoverFormats,
@@ -2563,8 +2637,10 @@ export {
   formatLintReport,
   generateIFID,
   getCacheDir,
+  getCacheSize,
   getFormatSearchDirs,
   lint,
+  listCachedFormats,
   loadConfig,
   loadConfigFile,
   parseFormatJSON,