docrev 0.8.1 → 0.8.5

package/lib/{trackchanges.js → trackchanges.ts}

@@ -8,11 +8,31 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { execSync } from 'child_process';
 import AdmZip from 'adm-zip';
+import type { TrackChangeMarker } from './types.js';
+
+interface PrepareOptions {
+  author?: string;
+}
+
+interface PrepareResult {
+  text: string;
+  markers: TrackChangeMarker[];
+}
+
+interface ApplyResult {
+  success: boolean;
+  message: string;
+  stats?: {
+    insertions: number;
+    deletions: number;
+    substitutions: number;
+  };
+}
 
 /**
  * Escape XML special characters
  */
-function escapeXml(str) {
+function escapeXml(str: string): string {
   return str
     .replace(/&/g, '&')
     .replace(/</g, '&lt;')
@@ -25,14 +45,13 @@ function escapeXml(str) {
  * Prepare text with CriticMarkup annotations for track changes
  * Replaces annotations with markers that can be processed in DOCX
  *
- * @param {string} text - Text with CriticMarkup annotations
- * @param {object} options - Options
- * @param {string} options.author - Default author for track changes
- * @returns {{text: string, markers: Array}} Processed text and marker info
+ * @param text - Text with CriticMarkup annotations
+ * @param options - Options
+ * @returns Processed text and marker info
  */
-export function prepareForTrackChanges(text, options = {}) {
+export function prepareForTrackChanges(text: string, options: PrepareOptions = {}): PrepareResult {
   const { author = 'Reviewer' } = options;
-  const markers = [];
+  const markers: TrackChangeMarker[] = [];
   let markerId = 0;
 
   let result = text;
@@ -100,21 +119,26 @@ export function prepareForTrackChanges(text, options = {}) {
 /**
  * Apply track changes markers to a Word document
  *
- * @param {string} docxPath - Path to input DOCX file
- * @param {Array} markers - Markers from prepareForTrackChanges
- * @param {string} outputPath - Path for output DOCX file
- * @returns {Promise<{success: boolean, message: string}>}
+ * @param docxPath - Path to input DOCX file
+ * @param markers - Markers from prepareForTrackChanges
+ * @param outputPath - Path for output DOCX file
+ * @returns Result with success status and message
  */
-export async function applyTrackChangesToDocx(docxPath, markers, outputPath) {
+export async function applyTrackChangesToDocx(
+  docxPath: string,
+  markers: TrackChangeMarker[],
+  outputPath: string
+): Promise<ApplyResult> {
   if (!fs.existsSync(docxPath)) {
     return { success: false, message: `File not found: ${docxPath}` };
   }
 
-  let zip;
+  let zip: AdmZip;
   try {
     zip = new AdmZip(docxPath);
   } catch (err) {
-    return { success: false, message: `Invalid DOCX file: ${err.message}` };
+    const error = err as Error;
+    return { success: false, message: `Invalid DOCX file: ${error.message}` };
   }
 
   // Read document.xml
@@ -141,7 +165,7 @@ export async function applyTrackChangesToDocx(docxPath, markers, outputPath) {
     } else if (marker.type === 'delete') {
       replacement = `<w:del w:id="${marker.id}" w:author="${escapedAuthor}" w:date="${now}"><w:r><w:delText>${escapedContent}</w:delText></w:r></w:del>`;
     } else if (marker.type === 'substitute') {
-      const escapedReplacement = escapeXml(marker.replacement);
+      const escapedReplacement = escapeXml(marker.replacement || '');
       replacement = `<w:del w:id="${marker.id}" w:author="${escapedAuthor}" w:date="${now}"><w:r><w:delText>${escapedContent}</w:delText></w:r></w:del><w:ins w:id="${marker.id + 1000}" w:author="${escapedAuthor}" w:date="${now}"><w:r><w:t>${escapedReplacement}</w:t></w:r></w:ins>`;
     }
 
@@ -173,13 +197,16 @@ export async function applyTrackChangesToDocx(docxPath, markers, outputPath) {
 /**
  * Build a Word document with track changes from annotated markdown
  *
- * @param {string} mdPath - Path to markdown file with CriticMarkup
- * @param {string} docxPath - Output path for Word document
- * @param {object} options - Options
- * @param {string} options.author - Author name for track changes
- * @returns {Promise<{success: boolean, message: string}>}
+ * @param mdPath - Path to markdown file with CriticMarkup
+ * @param docxPath - Output path for Word document
+ * @param options - Options
+ * @returns Result with success status and message
  */
-export async function buildWithTrackChanges(mdPath, docxPath, options = {}) {
+export async function buildWithTrackChanges(
+  mdPath: string,
+  docxPath: string,
+  options: PrepareOptions = {}
+): Promise<ApplyResult> {
   const { author = 'Author' } = options;
 
   if (!fs.existsSync(mdPath)) {
@@ -197,7 +224,8 @@ export async function buildWithTrackChanges(mdPath, docxPath, options = {}) {
       execSync(`pandoc "${mdPath}" -o "${docxPath}"`, { encoding: 'utf-8' });
       return { success: true, message: `Created ${docxPath}` };
     } catch (err) {
-      return { success: false, message: err.message };
+      const error = err as Error;
+      return { success: false, message: error.message };
     }
   }
 
@@ -224,6 +252,7 @@ export async function buildWithTrackChanges(mdPath, docxPath, options = {}) {
     // Clean up on error
     if (fs.existsSync(tempMd)) fs.unlinkSync(tempMd);
     if (fs.existsSync(tempDocx)) fs.unlinkSync(tempDocx);
-    return { success: false, message: err.message };
+    const error = err as Error;
+    return { success: false, message: error.message };
   }
 }

package/lib/types.ts

@@ -0,0 +1,509 @@
+/**
+ * Shared TypeScript type definitions for docrev
+ * Extracted from types/index.d.ts for internal use
+ */
+
+// ============================================
+// Annotations
+// ============================================
+
+export interface Annotation {
+  type: 'insert' | 'delete' | 'substitute' | 'comment' | 'highlight';
+  match: string;
+  content: string;
+  replacement?: string;
+  author?: string;
+  position: number;
+  line: number;
+  before?: string;
+  after?: string;
+  resolved?: boolean;
+}
+
+export interface Comment extends Annotation {
+  type: 'comment';
+  author: string;
+  resolved: boolean;
+}
+
+export interface AnnotationCounts {
+  inserts: number;
+  deletes: number;
+  substitutes: number;
+  comments: number;
+  total: number;
+}
+
+export interface StripOptions {
+  keepComments?: boolean;
+}
+
+export interface CommentFilterOptions {
+  pendingOnly?: boolean;
+  resolvedOnly?: boolean;
+}
+
+// ============================================
+// Build
+// ============================================
+
+export interface Author {
+  name: string;
+  affiliation?: string;
+  email?: string;
+  orcid?: string;
+}
+
+export interface CrossrefConfig {
+  figureTitle?: string;
+  tableTitle?: string;
+  figPrefix?: string | string[];
+  tblPrefix?: string | string[];
+}
+
+export interface PdfConfig {
+  documentclass?: string;
+  fontsize?: string;
+  geometry?: string;
+  linestretch?: number;
+  toc?: boolean;
+}
+
+export interface DocxConfig {
+  reference?: string;
+  keepComments?: boolean;
+  toc?: boolean;
+}
+
+export interface BuildConfig {
+  title?: string;
+  authors?: Author[];
+  sections?: string[];
+  bibliography?: string;
+  csl?: string;
+  crossref?: CrossrefConfig;
+  pdf?: PdfConfig;
+  docx?: DocxConfig;
+  postprocess?: { [key: string]: string };
+  _configPath?: string;
+  [key: string]: unknown;
+}
+
+export interface BuildResult {
+  format: string;
+  output: string;
+  success: boolean;
+  error?: string;
+}
+
+// ============================================
+// Citations
+// ============================================
+
+export interface Citation {
+  key: string;
+  line: number;
+  file: string;
+}
+
+export interface CitationValidation {
+  valid: Citation[];
+  missing: Citation[];
+  unused: string[];
+  duplicates: Array<{ key: string; count: number; locations: Citation[] }>;
+}
+
+export interface CitationStats {
+  totalCitations: number;
+  uniqueCited: number;
+  valid: number;
+  missing: number;
+  missingKeys: string[];
+  bibEntries: number;
+  unused: number;
+  unusedKeys: string[];
+}
+
+// ============================================
+// Crossref
+// ============================================
+
+export interface RefNumber {
+  num: number;
+  isSupp: boolean;
+  suffix: string | null;
+}
+
+export interface HardcodedRef {
+  type: 'fig' | 'tbl' | 'eq';
+  match: string;
+  numbers: RefNumber[];
+  position: number;
+}
+
+export interface DynamicRef {
+  type: 'fig' | 'tbl' | 'eq';
+  label: string;
+  match: string;
+  position: number;
+}
+
+export interface FigureInfo {
+  label: string;
+  num: number;
+  isSupp: boolean;
+  file: string;
+}
+
+export interface Registry {
+  figures: Map<string, FigureInfo>;
+  tables: Map<string, FigureInfo>;
+  equations: Map<string, FigureInfo>;
+  byNumber: {
+    fig: Map<number, string>;
+    figS: Map<number, string>;
+    tbl: Map<number, string>;
+    tblS: Map<number, string>;
+    eq: Map<number, string>;
+  };
+}
+
+export interface RefStatus {
+  dynamic: DynamicRef[];
+  hardcoded: HardcodedRef[];
+  anchors: { figures: number; tables: number; equations: number };
+}
+
+export interface ConversionResult {
+  converted: string;
+  conversions: Array<{ from: string; to: string }>;
+  warnings: string[];
+}
+
+// ============================================
+// DOI
+// ============================================
+
+export interface BibEntry {
+  key: string;
+  type: string;
+  doi: string | null;
+  title: string;
+  authorRaw: string;
+  year: number | null;
+  journal: string;
+  skip: boolean;
+  expectDoi: boolean;
+  noDoi: boolean;
+  line: number;
+}
+
+export interface DoiCheckResult {
+  valid: boolean;
+  source?: 'crossref' | 'datacite';
+  metadata?: {
+    title: string;
+    authors: string[];
+    year: number;
+    journal: string;
+    type?: string;
+  };
+  error?: string;
+}
+
+export interface BibtexFetchResult {
+  success: boolean;
+  bibtex?: string;
+  error?: string;
+}
+
+export interface DoiLookupResult {
+  found: boolean;
+  doi?: string;
+  confidence?: 'low' | 'medium' | 'high';
+  score?: number;
+  metadata?: {
+    title: string;
+    authors: string[];
+    year: number;
+    journal: string;
+  };
+  alternatives?: Array<{
+    doi: string;
+    title: string;
+    score: number;
+  }>;
+  error?: string;
+}
+
+export interface BibCheckResult {
+  entries: Array<BibEntry & { status: string; message?: string; metadata?: object }>;
+  valid: number;
+  invalid: number;
+  missing: number;
+  skipped: number;
+}
+
+// ============================================
+// Equations
+// ============================================
+
+export interface Equation {
+  type: 'inline' | 'display';
+  content: string;
+  line: number;
+  file: string;
+}
+
+export interface EquationStats {
+  total: number;
+  display: number;
+  inline: number;
+  byFile: Array<{ file: string; display: number; inline: number }>;
+}
+
+export interface WordEquationResult {
+  success: boolean;
+  equations: Array<{
+    type: 'inline' | 'display' | 'unknown';
+    latex: string | null;
+    position: number;
+    line?: number;
+    raw?: string;
+    error?: string;
+  }>;
+  error?: string;
+}
+
+// ============================================
+// Git
+// ============================================
+
+export interface FileChange {
+  added: number;
+  removed: number;
+  changes: Array<{ added?: boolean; removed?: boolean; value: string }>;
+}
+
+export interface CommitInfo {
+  hash: string;
+  date: string;
+  author: string;
+  message: string;
+}
+
+export interface ChangedFile {
+  file: string;
+  status: 'added' | 'deleted' | 'modified';
+}
+
+export interface BlameEntry {
+  line: number;
+  author: string;
+  date: string;
+  hash: string;
+  content: string;
+}
+
+export interface AuthorStats {
+  lines: number;
+  percentage: number;
+}
+
+export interface ContributorStats {
+  lines: number;
+  files: number;
+}
+
+// ============================================
+// Journals
+// ============================================
+
+export interface JournalRequirements {
+  wordLimit?: { main?: number; abstract?: number };
+  references?: { max?: number; doiRequired?: boolean };
+  figures?: { max?: number };
+  tables?: { max?: number };
+  sections?: string[];
+  formatting?: object;
+}
+
+export interface JournalProfile {
+  name: string;
+  url: string;
+  requirements: JournalRequirements;
+}
+
+export interface ValidationResult {
+  journal: string;
+  valid: boolean;
+  wordCount: { main: number; abstract: number; limit: { main: number; abstract: number } };
+  figures: { count: number; max: number };
+  tables: { count: number; max: number };
+  references: { count: number; max: number };
+  sections: { found: string[]; missing: string[]; required: string[] };
+  errors: string[];
+  warnings: string[];
+}
+
+// ============================================
+// Merge
+// ============================================
+
+export interface ReviewerChange {
+  reviewer: string;
+  type: 'insert' | 'delete' | 'replace';
+  start: number;
+  end: number;
+  oldText: string;
+  newText: string;
+}
+
+export interface Conflict {
+  id: string;
+  start: number;
+  end: number;
+  original: string;
+  changes: ReviewerChange[];
+  section?: string;
+  line?: number;
+  resolved: string | null;
+}
+
+export interface MergeResult {
+  merged: string;
+  conflicts: Conflict[];
+  stats: {
+    reviewers: number;
+    totalChanges: number;
+    nonConflicting: number;
+    conflicts: number;
+    comments: number;
+  };
+  originalText: string;
+}
+
+// ============================================
+// Sections
+// ============================================
+
+export interface SectionConfig {
+  header: string;
+  aliases?: string[];
+  order?: number;
+}
+
+export interface SectionsConfig {
+  version: number;
+  description?: string;
+  sections: Record<string, SectionConfig>;
+}
+
+export interface ExtractedSection {
+  file: string;
+  header: string;
+  content: string;
+  matched: boolean;
+}
+
+// ============================================
+// Word
+// ============================================
+
+export interface WordComment {
+  id: string;
+  author: string;
+  date?: string;
+  text: string;
+}
+
+export interface WordMetadata {
+  title?: string;
+  author?: string;
+  created?: string;
+  modified?: string;
+}
+
+export interface CommentAnchor {
+  text: string;
+  context: string;
+}
+
+export interface WordContent {
+  text: string;
+  html: string;
+}
+
+export interface TrackChangesResult {
+  hasTrackChanges: boolean;
+  content: string | null;
+  stats: { insertions: number; deletions: number };
+}
+
+// ============================================
+// TrackChanges
+// ============================================
+
+export interface TrackChangeMarker {
+  id: number;
+  type: 'insert' | 'delete' | 'substitute' | 'comment';
+  content: string;
+  author: string;
+  replacement?: string;
+}
+
+// ============================================
+// Spelling
+// ============================================
+
+export interface SpellingIssue {
+  word: string;
+  line: number;
+  column: number;
+  file?: string;
+  suggestions?: string[];
+}
+
+export interface SpellingResult {
+  misspelled: SpellingIssue[];
+  possibleNames: SpellingIssue[];
+}
+
+// ============================================
+// Config
+// ============================================
+
+export interface UserConfig {
+  userName?: string;
+  defaultSections?: string[];
+}
+
+// ============================================
+// DOI Cache
+// ============================================
+
+export interface DoiCacheEntry {
+  result: DoiCheckResult | DoiLookupResult;
+  timestamp: number;
+}
+
+export interface DoiCache {
+  entries: Record<string, DoiCacheEntry>;
+  version: number;
+}
+
+export interface DoiCacheStats {
+  size: number;
+  path: string;
+}
+
+// ============================================
+// Errors
+// ============================================
+
+export interface ErrorInfo {
+  code: string;
+  message: string;
+  help?: string;
+  cause?: Error;
+}