@utilix-tech/sdk 0.88.0 → 0.89.0

package/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 Full release notes for all Utilix surfaces (browser tools, REST API, SDKs, MCP server) live at [utilix.tech/changelog](https://utilix.tech/changelog). This file tracks just this package.
 
+## 0.89.0
+- Add `checkAcronymExpansion` (acronym-expansion-checker): scan text for acronyms and flag any used before being expanded on first mention, recognizing both the "full term (ACRONYM)" and "ACRONYM (full term)" conventions, with acronyms never expanded anywhere reported separately.
+
 ## 0.88.0
 - Add `validateMermaidSyntax` (mermaid-syntax-validator): check a Mermaid diagram definition for syntax errors with line numbers, including an unterminated subgraph, unbalanced node brackets, a malformed edge arrow, and a sequence-diagram participant referenced before its explicit declaration.
 - Add `calculateAnnuityPayout` (annuity-payout-calculator): solve the standard annuity formula in either direction, the periodic payout a lump sum funds, or the lump sum required to fund a target payout, for an ordinary or annuity-due structure.

package/README.md

@@ -1,6 +1,6 @@
 # @utilix-tech/sdk
 
-**727 developer utility functions for Node.js: runs locally, no API key required.**
+**728 developer utility functions for Node.js: runs locally, no API key required.**
 
 [![npm version](https://img.shields.io/npm/v/@utilix-tech/sdk?style=flat-square&color=cb3837)](https://www.npmjs.com/package/@utilix-tech/sdk)
 [![npm downloads](https://img.shields.io/npm/dm/@utilix-tech/sdk?style=flat-square)](https://www.npmjs.com/package/@utilix-tech/sdk)
@@ -161,7 +161,8 @@ import { convertCase, slugify, countWords, generateWords, generateParagraphs,
          escapeString, htmlToMarkdown, applyOps, detectPassiveVoice, scoreReadability,
          detectFillerWords, detectWordyPhrases, checkOxfordCommaConsistency,
          calculateStringDistance, analyzeSentenceLengths,
-         analyzeKeywordDensity, searchEmoji, getEmojiByShortcode } from "@utilix-tech/sdk/text";
+         analyzeKeywordDensity, searchEmoji, getEmojiByShortcode,
+         checkAcronymExpansion } from "@utilix-tech/sdk/text";
 
 convertCase("hello world", "camelCase");   // "helloWorld"
 convertCase("hello world", "PascalCase");  // "HelloWorld"
@@ -214,6 +215,10 @@ getEmojiByShortcode(":joy:");  // { emoji: "😂", name: "face with tears of joy
 // Keyword/phrase frequency and density (occurrences per 100 words); ngramSize 2 or 3 for phrases
 analyzeKeywordDensity("machine learning models power machine learning systems");
 // { totalWords: 7, uniqueKeywords: 5, ngramSize: 1, keywords: [{ keyword: "learning", count: 2, density: 28.6 }, ...] }
+
+// Flag an acronym used before it is expanded on first mention, and any never expanded at all
+checkAcronymExpansion("The API returned an error. The Application Programming Interface (API) was patched.");
+// { acronyms: [{ acronym: "API", occurrences: 2, usedBeforeExpansion: true, ... }], issues: [{ type: "used-before-expansion", ... }] }
 ```
 
 ---

package/dist/{chunk-FB6CCFR5.js → chunk-YQJ7CEUL.js}

@@ -18,6 +18,7 @@ __export(text_exports, {
   applyOps: () => applyOps,
   calculateStringDistance: () => calculateStringDistance,
   centerText: () => centerText,
+  checkAcronymExpansion: () => checkAcronymExpansion,
   checkDashUsage: () => checkDashUsage,
   checkOxfordCommaConsistency: () => checkOxfordCommaConsistency,
   convertAll: () => convertAll,
@@ -3267,5 +3268,67 @@ function checkDashUsage(text) {
     issues
   };
 }
+var ACRONYM_TOKEN_RE = /\b[A-Z][A-Z0-9]{1,9}\b/g;
+var ACRONYM_IN_PARENS_RE = /\(([A-Z][A-Z0-9]{1,9})\)/g;
+var ACRONYM_THEN_EXPANSION_RE = /\b([A-Z][A-Z0-9]{1,9})\b\s*\(([a-zA-Z][^()]{1,100})\)/g;
+function acronymContextSnippet(text, index, matchLen) {
+  const start = Math.max(0, index - 25);
+  const end = Math.min(text.length, index + matchLen + 25);
+  const body = text.slice(start, end).replace(/\s+/g, " ").trim();
+  return (start > 0 ? "\u2026" : "") + body + (end < text.length ? "\u2026" : "");
+}
+function checkAcronymExpansion(text) {
+  const definedAt = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_IN_PARENS_RE)) {
+    const acronym = m[1];
+    const idx = (m.index ?? 0) + 1;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  for (const m of text.matchAll(ACRONYM_THEN_EXPANSION_RE)) {
+    const acronym = m[1];
+    const idx = m.index ?? 0;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  const occurrencesByAcronym = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_TOKEN_RE)) {
+    const acronym = m[0];
+    const idx = m.index ?? 0;
+    const list = occurrencesByAcronym.get(acronym);
+    if (list) list.push(idx);
+    else occurrencesByAcronym.set(acronym, [idx]);
+  }
+  const acronyms = [];
+  const issues = [];
+  for (const [acronym, indicesUnsorted] of occurrencesByAcronym) {
+    const indices = [...indicesUnsorted].sort((a, b) => a - b);
+    const firstUsedAt = indices[0];
+    const expandedAt = definedAt.has(acronym) ? definedAt.get(acronym) : null;
+    const earlyUse = expandedAt !== null ? indices.find((i) => i < expandedAt) : void 0;
+    const usedBeforeExpansion = earlyUse !== void 0;
+    acronyms.push({ acronym, occurrences: indices.length, firstUsedAt, expandedAt, usedBeforeExpansion });
+    if (usedBeforeExpansion) {
+      issues.push({
+        type: "used-before-expansion",
+        acronym,
+        index: earlyUse,
+        context: acronymContextSnippet(text, earlyUse, acronym.length),
+        message: `"${acronym}" is used here before it's expanded later in the document (at character ${expandedAt}).`
+      });
+    } else if (expandedAt === null) {
+      issues.push({
+        type: "never-expanded",
+        acronym,
+        index: firstUsedAt,
+        context: acronymContextSnippet(text, firstUsedAt, acronym.length),
+        message: `"${acronym}" is never expanded anywhere in this document.`
+      });
+    }
+  }
+  acronyms.sort((a, b) => a.firstUsedAt - b.firstUsedAt);
+  issues.sort((a, b) => a.index - b.index);
+  return { acronyms, issues };
+}
 
-export { CASE_FORMATS, DEFAULT_CONVERT_OPTIONS, EMOJI_TABLE, ESCAPE_MODES, LINE_OPS, MORSE_CODE, addBorder, analyzeKeywordDensity, analyzeSentenceLengths, analyzeText, applyOp, applyOps, calculateStringDistance, centerText, checkDashUsage, checkOxfordCommaConsistency, convertAll, convertCase, countWords, csvToHtml, csvToMarkdown, detectDelimiter, detectFillerWords, detectPassiveVoice, detectWordyPhrases, diffLines, diffLinesSimple, diffStats, escapeAll, escapeString, extractHeadings, formatReadingTime, generate, generateDiff, generateHtmlTable, generateMarkdownTable, generateParagraphs, generateSentences, generateWords, getAvailableFonts, getEmojiByCategory, getEmojiByChar, getEmojiByShortcode, getEmojiCategories, getMorseForChar, getMorseTiming, htmlToMarkdown, isValidMorse, markdownToHtml, morseToText, numberToOrdinal, numberToRoman, numberToWords, ordinalWords, parseDiff, parseTableData, readabilityScore, renderMarkdown, romanToNumber, scoreReadability, searchEmoji, sentenceCount, slugify, slugifyAll, syllableCount, textToAscii, textToMorse, text_exports, unescapeString, wordFrequency };
+export { CASE_FORMATS, DEFAULT_CONVERT_OPTIONS, EMOJI_TABLE, ESCAPE_MODES, LINE_OPS, MORSE_CODE, addBorder, analyzeKeywordDensity, analyzeSentenceLengths, analyzeText, applyOp, applyOps, calculateStringDistance, centerText, checkAcronymExpansion, checkDashUsage, checkOxfordCommaConsistency, convertAll, convertCase, countWords, csvToHtml, csvToMarkdown, detectDelimiter, detectFillerWords, detectPassiveVoice, detectWordyPhrases, diffLines, diffLinesSimple, diffStats, escapeAll, escapeString, extractHeadings, formatReadingTime, generate, generateDiff, generateHtmlTable, generateMarkdownTable, generateParagraphs, generateSentences, generateWords, getAvailableFonts, getEmojiByCategory, getEmojiByChar, getEmojiByShortcode, getEmojiCategories, getMorseForChar, getMorseTiming, htmlToMarkdown, isValidMorse, markdownToHtml, morseToText, numberToOrdinal, numberToRoman, numberToWords, ordinalWords, parseDiff, parseTableData, readabilityScore, renderMarkdown, romanToNumber, scoreReadability, searchEmoji, sentenceCount, slugify, slugifyAll, syllableCount, textToAscii, textToMorse, text_exports, unescapeString, wordFrequency };

package/dist/index.cjs

@@ -2319,6 +2319,7 @@ __export(text_exports, {
   applyOps: () => applyOps,
   calculateStringDistance: () => calculateStringDistance,
   centerText: () => centerText,
+  checkAcronymExpansion: () => checkAcronymExpansion,
   checkDashUsage: () => checkDashUsage,
   checkOxfordCommaConsistency: () => checkOxfordCommaConsistency,
   convertAll: () => convertAll,
@@ -5568,6 +5569,68 @@ function checkDashUsage(text) {
     issues
   };
 }
+var ACRONYM_TOKEN_RE = /\b[A-Z][A-Z0-9]{1,9}\b/g;
+var ACRONYM_IN_PARENS_RE = /\(([A-Z][A-Z0-9]{1,9})\)/g;
+var ACRONYM_THEN_EXPANSION_RE = /\b([A-Z][A-Z0-9]{1,9})\b\s*\(([a-zA-Z][^()]{1,100})\)/g;
+function acronymContextSnippet(text, index, matchLen) {
+  const start = Math.max(0, index - 25);
+  const end = Math.min(text.length, index + matchLen + 25);
+  const body = text.slice(start, end).replace(/\s+/g, " ").trim();
+  return (start > 0 ? "\u2026" : "") + body + (end < text.length ? "\u2026" : "");
+}
+function checkAcronymExpansion(text) {
+  const definedAt = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_IN_PARENS_RE)) {
+    const acronym = m[1];
+    const idx = (m.index ?? 0) + 1;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  for (const m of text.matchAll(ACRONYM_THEN_EXPANSION_RE)) {
+    const acronym = m[1];
+    const idx = m.index ?? 0;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  const occurrencesByAcronym = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_TOKEN_RE)) {
+    const acronym = m[0];
+    const idx = m.index ?? 0;
+    const list = occurrencesByAcronym.get(acronym);
+    if (list) list.push(idx);
+    else occurrencesByAcronym.set(acronym, [idx]);
+  }
+  const acronyms = [];
+  const issues = [];
+  for (const [acronym, indicesUnsorted] of occurrencesByAcronym) {
+    const indices = [...indicesUnsorted].sort((a, b) => a - b);
+    const firstUsedAt = indices[0];
+    const expandedAt = definedAt.has(acronym) ? definedAt.get(acronym) : null;
+    const earlyUse = expandedAt !== null ? indices.find((i) => i < expandedAt) : void 0;
+    const usedBeforeExpansion = earlyUse !== void 0;
+    acronyms.push({ acronym, occurrences: indices.length, firstUsedAt, expandedAt, usedBeforeExpansion });
+    if (usedBeforeExpansion) {
+      issues.push({
+        type: "used-before-expansion",
+        acronym,
+        index: earlyUse,
+        context: acronymContextSnippet(text, earlyUse, acronym.length),
+        message: `"${acronym}" is used here before it's expanded later in the document (at character ${expandedAt}).`
+      });
+    } else if (expandedAt === null) {
+      issues.push({
+        type: "never-expanded",
+        acronym,
+        index: firstUsedAt,
+        context: acronymContextSnippet(text, firstUsedAt, acronym.length),
+        message: `"${acronym}" is never expanded anywhere in this document.`
+      });
+    }
+  }
+  acronyms.sort((a, b) => a.firstUsedAt - b.firstUsedAt);
+  issues.sort((a, b) => a.index - b.index);
+  return { acronyms, issues };
+}
 
 // src/tools/data.ts
 var data_exports = {};

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 export { j as json } from './json-Ca6gZCNB.cjs';
 export { e as encoding } from './encoding-Dk3wpmb3.cjs';
 export { h as hashing } from './hashing-CJjlvqS_.cjs';
-export { t as text } from './text-xY5MJwr0.cjs';
+export { t as text } from './text-DOopHoK3.cjs';
 export { d as data } from './data-Cz1Q0sg0.cjs';
 export { g as generators } from './generators-DAXXrMvG.cjs';
 export { t as time } from './time-VMAy_SrV.cjs';

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { j as json } from './json-Ca6gZCNB.js';
 export { e as encoding } from './encoding-Dk3wpmb3.js';
 export { h as hashing } from './hashing-CJjlvqS_.js';
-export { t as text } from './text-xY5MJwr0.js';
+export { t as text } from './text-DOopHoK3.js';
 export { d as data } from './data-Cz1Q0sg0.js';
 export { g as generators } from './generators-DAXXrMvG.js';
 export { t as time } from './time-VMAy_SrV.js';

package/dist/index.js

@@ -10,7 +10,7 @@ export { ai_agent_exports as ai_agent } from './chunk-5VVC7BHS.js';
 export { json_exports as json } from './chunk-WUOZHCIC.js';
 export { encoding_exports as encoding } from './chunk-DOWQZUTP.js';
 export { hashing_exports as hashing } from './chunk-PET2CGTH.js';
-export { text_exports as text } from './chunk-FB6CCFR5.js';
+export { text_exports as text } from './chunk-YQJ7CEUL.js';
 export { data_exports as data } from './chunk-CUQDHXUX.js';
 export { generators_exports as generators } from './chunk-422ICOZX.js';
 export { time_exports as time } from './chunk-6EJVNQSY.js';

package/dist/{text-xY5MJwr0.d.cts → text-DOopHoK3.d.cts}

@@ -26,6 +26,7 @@
  *   - keyword-density-analyzer: analyzeKeywordDensity
  *   - emoji-lookup    : searchEmoji, getEmojiByShortcode, getEmojiByChar, getEmojiByCategory, getEmojiCategories, EMOJI_TABLE
  *   - em-dash-usage-checker: checkDashUsage
+ *   - acronym-expansion-checker: checkAcronymExpansion
  */
 interface WordCountResult {
     words: number;
@@ -484,7 +485,43 @@ interface DashUsageResult {
  * pasted alongside prose can occasionally be flagged.
  */
 declare function checkDashUsage(text: string): DashUsageResult;
+type AcronymIssueType = 'used-before-expansion' | 'never-expanded';
+interface AcronymIssue {
+    type: AcronymIssueType;
+    acronym: string;
+    index: number;
+    context: string;
+    message: string;
+}
+interface AcronymUsage {
+    acronym: string;
+    occurrences: number;
+    firstUsedAt: number;
+    expandedAt: number | null;
+    usedBeforeExpansion: boolean;
+}
+interface AcronymCheckResult {
+    acronyms: AcronymUsage[];
+    issues: AcronymIssue[];
+}
+/**
+ * Scan text for acronyms (2-10 character all-caps tokens) and flag any that
+ * are used before being expanded on first mention, per standard technical
+ * writing style guides. Recognizes both expansion conventions: the full term
+ * followed by the acronym in parentheses ("Application Programming Interface
+ * (API)"), and the acronym followed by its expansion in parentheses ("API
+ * (Application Programming Interface)"). An acronym with no expansion found
+ * anywhere in the text is reported separately as never expanded, rather than
+ * as used too early. Pure regex heuristic, not a dictionary of real acronyms:
+ * a proper noun styled in all caps, a Roman numeral, or a pluralized acronym
+ * like "APIs" can be missed or misread.
+ */
+declare function checkAcronymExpansion(text: string): AcronymCheckResult;
 
+type text_AcronymCheckResult = AcronymCheckResult;
+type text_AcronymIssue = AcronymIssue;
+type text_AcronymIssueType = AcronymIssueType;
+type text_AcronymUsage = AcronymUsage;
 type text_AsciiFont = AsciiFont;
 type text_AsciiOptions = AsciiOptions;
 declare const text_CASE_FORMATS: typeof CASE_FORMATS;
@@ -544,6 +581,7 @@ declare const text_applyOp: typeof applyOp;
 declare const text_applyOps: typeof applyOps;
 declare const text_calculateStringDistance: typeof calculateStringDistance;
 declare const text_centerText: typeof centerText;
+declare const text_checkAcronymExpansion: typeof checkAcronymExpansion;
 declare const text_checkDashUsage: typeof checkDashUsage;
 declare const text_checkOxfordCommaConsistency: typeof checkOxfordCommaConsistency;
 declare const text_convertAll: typeof convertAll;
@@ -600,7 +638,7 @@ declare const text_textToMorse: typeof textToMorse;
 declare const text_unescapeString: typeof unescapeString;
 declare const text_wordFrequency: typeof wordFrequency;
 declare namespace text {
-  export { type text_AsciiFont as AsciiFont, type text_AsciiOptions as AsciiOptions, text_CASE_FORMATS as CASE_FORMATS, type text_CaseFormat as CaseFormat, type text_ConvertOptions as ConvertOptions, text_DEFAULT_CONVERT_OPTIONS as DEFAULT_CONVERT_OPTIONS, type text_DashIssue as DashIssue, type text_DashIssueType as DashIssueType, type text_DashUsageResult as DashUsageResult, type text_DiffFile as DiffFile, type text_DiffHunk as DiffHunk, type text_DiffLine as DiffLine, type text_DiffResult as DiffResult, type text_DiffType as DiffType, type text_DiffViewerLine as DiffViewerLine, text_EMOJI_TABLE as EMOJI_TABLE, text_ESCAPE_MODES as ESCAPE_MODES, type text_EmojiEntry as EmojiEntry, type text_EscapeMode as EscapeMode, type text_FillerCategory as FillerCategory, type text_FillerMatch as FillerMatch, type text_FillerWordResult as FillerWordResult, type text_KeywordDensityEntry as KeywordDensityEntry, type text_KeywordDensityOptions as KeywordDensityOptions, type text_KeywordDensityResult as KeywordDensityResult, text_LINE_OPS as LINE_OPS, type text_LineOp as LineOp, type text_LineType as LineType, type text_LoremUnit as LoremUnit, text_MORSE_CODE as MORSE_CODE, type text_MarkdownResult as MarkdownResult, type text_MorseOptions as MorseOptions, type text_OxfordCommaInstance as OxfordCommaInstance, type text_OxfordCommaResult as OxfordCommaResult, type text_ParsedDiff as ParsedDiff, type text_ParsedTable as ParsedTable, type text_PassiveVoiceMatch as PassiveVoiceMatch, type text_PassiveVoiceResult as PassiveVoiceResult, type text_PassiveVoiceSentence as PassiveVoiceSentence, type text_ReadabilityResult as ReadabilityResult, type text_ReadabilityScore as ReadabilityScore, type text_SentenceLengthBucket as SentenceLengthBucket, type text_SentenceLengthDistribution as SentenceLengthDistribution, type text_SlugSeparator as SlugSeparator, type text_StringDistanceMode as StringDistanceMode, type text_StringDistanceResult as StringDistanceResult, type text_TableOptions as TableOptions, type text_TextAnalysis as TextAnalysis, type text_WordCountResult as WordCountResult, type text_WordyPhraseMatch as WordyPhraseMatch, type text_WordyPhraseResult as WordyPhraseResult, text_addBorder as addBorder, text_analyzeKeywordDensity as analyzeKeywordDensity, text_analyzeSentenceLengths as analyzeSentenceLengths, text_analyzeText as analyzeText, text_applyOp as applyOp, text_applyOps as applyOps, text_calculateStringDistance as calculateStringDistance, text_centerText as centerText, text_checkDashUsage as checkDashUsage, text_checkOxfordCommaConsistency as checkOxfordCommaConsistency, text_convertAll as convertAll, text_convertCase as convertCase, text_countWords as countWords, text_csvToHtml as csvToHtml, text_csvToMarkdown as csvToMarkdown, text_detectDelimiter as detectDelimiter, text_detectFillerWords as detectFillerWords, text_detectPassiveVoice as detectPassiveVoice, text_detectWordyPhrases as detectWordyPhrases, text_diffLines as diffLines, text_diffLinesSimple as diffLinesSimple, text_diffStats as diffStats, text_escapeAll as escapeAll, text_escapeString as escapeString, text_extractHeadings as extractHeadings, text_formatReadingTime as formatReadingTime, text_generate as generate, text_generateDiff as generateDiff, text_generateHtmlTable as generateHtmlTable, text_generateMarkdownTable as generateMarkdownTable, text_generateParagraphs as generateParagraphs, text_generateSentences as generateSentences, text_generateWords as generateWords, text_getAvailableFonts as getAvailableFonts, text_getEmojiByCategory as getEmojiByCategory, text_getEmojiByChar as getEmojiByChar, text_getEmojiByShortcode as getEmojiByShortcode, text_getEmojiCategories as getEmojiCategories, text_getMorseForChar as getMorseForChar, text_getMorseTiming as getMorseTiming, text_htmlToMarkdown as htmlToMarkdown, text_isValidMorse as isValidMorse, text_markdownToHtml as markdownToHtml, text_morseToText as morseToText, text_numberToOrdinal as numberToOrdinal, text_numberToRoman as numberToRoman, text_numberToWords as numberToWords, text_ordinalWords as ordinalWords, text_parseDiff as parseDiff, text_parseTableData as parseTableData, text_readabilityScore as readabilityScore, text_renderMarkdown as renderMarkdown, text_romanToNumber as romanToNumber, text_scoreReadability as scoreReadability, text_searchEmoji as searchEmoji, text_sentenceCount as sentenceCount, text_slugify as slugify, text_slugifyAll as slugifyAll, text_syllableCount as syllableCount, text_textToAscii as textToAscii, text_textToMorse as textToMorse, text_unescapeString as unescapeString, text_wordFrequency as wordFrequency };
+  export { type text_AcronymCheckResult as AcronymCheckResult, type text_AcronymIssue as AcronymIssue, type text_AcronymIssueType as AcronymIssueType, type text_AcronymUsage as AcronymUsage, type text_AsciiFont as AsciiFont, type text_AsciiOptions as AsciiOptions, text_CASE_FORMATS as CASE_FORMATS, type text_CaseFormat as CaseFormat, type text_ConvertOptions as ConvertOptions, text_DEFAULT_CONVERT_OPTIONS as DEFAULT_CONVERT_OPTIONS, type text_DashIssue as DashIssue, type text_DashIssueType as DashIssueType, type text_DashUsageResult as DashUsageResult, type text_DiffFile as DiffFile, type text_DiffHunk as DiffHunk, type text_DiffLine as DiffLine, type text_DiffResult as DiffResult, type text_DiffType as DiffType, type text_DiffViewerLine as DiffViewerLine, text_EMOJI_TABLE as EMOJI_TABLE, text_ESCAPE_MODES as ESCAPE_MODES, type text_EmojiEntry as EmojiEntry, type text_EscapeMode as EscapeMode, type text_FillerCategory as FillerCategory, type text_FillerMatch as FillerMatch, type text_FillerWordResult as FillerWordResult, type text_KeywordDensityEntry as KeywordDensityEntry, type text_KeywordDensityOptions as KeywordDensityOptions, type text_KeywordDensityResult as KeywordDensityResult, text_LINE_OPS as LINE_OPS, type text_LineOp as LineOp, type text_LineType as LineType, type text_LoremUnit as LoremUnit, text_MORSE_CODE as MORSE_CODE, type text_MarkdownResult as MarkdownResult, type text_MorseOptions as MorseOptions, type text_OxfordCommaInstance as OxfordCommaInstance, type text_OxfordCommaResult as OxfordCommaResult, type text_ParsedDiff as ParsedDiff, type text_ParsedTable as ParsedTable, type text_PassiveVoiceMatch as PassiveVoiceMatch, type text_PassiveVoiceResult as PassiveVoiceResult, type text_PassiveVoiceSentence as PassiveVoiceSentence, type text_ReadabilityResult as ReadabilityResult, type text_ReadabilityScore as ReadabilityScore, type text_SentenceLengthBucket as SentenceLengthBucket, type text_SentenceLengthDistribution as SentenceLengthDistribution, type text_SlugSeparator as SlugSeparator, type text_StringDistanceMode as StringDistanceMode, type text_StringDistanceResult as StringDistanceResult, type text_TableOptions as TableOptions, type text_TextAnalysis as TextAnalysis, type text_WordCountResult as WordCountResult, type text_WordyPhraseMatch as WordyPhraseMatch, type text_WordyPhraseResult as WordyPhraseResult, text_addBorder as addBorder, text_analyzeKeywordDensity as analyzeKeywordDensity, text_analyzeSentenceLengths as analyzeSentenceLengths, text_analyzeText as analyzeText, text_applyOp as applyOp, text_applyOps as applyOps, text_calculateStringDistance as calculateStringDistance, text_centerText as centerText, text_checkAcronymExpansion as checkAcronymExpansion, text_checkDashUsage as checkDashUsage, text_checkOxfordCommaConsistency as checkOxfordCommaConsistency, text_convertAll as convertAll, text_convertCase as convertCase, text_countWords as countWords, text_csvToHtml as csvToHtml, text_csvToMarkdown as csvToMarkdown, text_detectDelimiter as detectDelimiter, text_detectFillerWords as detectFillerWords, text_detectPassiveVoice as detectPassiveVoice, text_detectWordyPhrases as detectWordyPhrases, text_diffLines as diffLines, text_diffLinesSimple as diffLinesSimple, text_diffStats as diffStats, text_escapeAll as escapeAll, text_escapeString as escapeString, text_extractHeadings as extractHeadings, text_formatReadingTime as formatReadingTime, text_generate as generate, text_generateDiff as generateDiff, text_generateHtmlTable as generateHtmlTable, text_generateMarkdownTable as generateMarkdownTable, text_generateParagraphs as generateParagraphs, text_generateSentences as generateSentences, text_generateWords as generateWords, text_getAvailableFonts as getAvailableFonts, text_getEmojiByCategory as getEmojiByCategory, text_getEmojiByChar as getEmojiByChar, text_getEmojiByShortcode as getEmojiByShortcode, text_getEmojiCategories as getEmojiCategories, text_getMorseForChar as getMorseForChar, text_getMorseTiming as getMorseTiming, text_htmlToMarkdown as htmlToMarkdown, text_isValidMorse as isValidMorse, text_markdownToHtml as markdownToHtml, text_morseToText as morseToText, text_numberToOrdinal as numberToOrdinal, text_numberToRoman as numberToRoman, text_numberToWords as numberToWords, text_ordinalWords as ordinalWords, text_parseDiff as parseDiff, text_parseTableData as parseTableData, text_readabilityScore as readabilityScore, text_renderMarkdown as renderMarkdown, text_romanToNumber as romanToNumber, text_scoreReadability as scoreReadability, text_searchEmoji as searchEmoji, text_sentenceCount as sentenceCount, text_slugify as slugify, text_slugifyAll as slugifyAll, text_syllableCount as syllableCount, text_textToAscii as textToAscii, text_textToMorse as textToMorse, text_unescapeString as unescapeString, text_wordFrequency as wordFrequency };
 }
 
-export { analyzeKeywordDensity as $, type AsciiFont as A, type ParsedTable as B, CASE_FORMATS as C, DEFAULT_CONVERT_OPTIONS as D, EMOJI_TABLE as E, type FillerCategory as F, type PassiveVoiceMatch as G, type PassiveVoiceResult as H, type PassiveVoiceSentence as I, type ReadabilityScore as J, type KeywordDensityEntry as K, LINE_OPS as L, MORSE_CODE as M, type SentenceLengthDistribution as N, type OxfordCommaInstance as O, type ParsedDiff as P, type SlugSeparator as Q, type ReadabilityResult as R, type SentenceLengthBucket as S, type StringDistanceMode as T, type StringDistanceResult as U, type TableOptions as V, type TextAnalysis as W, type WordCountResult as X, type WordyPhraseMatch as Y, type WordyPhraseResult as Z, addBorder as _, type AsciiOptions as a, analyzeSentenceLengths as a0, analyzeText as a1, applyOp as a2, applyOps as a3, calculateStringDistance as a4, centerText as a5, checkDashUsage as a6, checkOxfordCommaConsistency as a7, convertAll as a8, convertCase as a9, getMorseForChar as aA, getMorseTiming as aB, htmlToMarkdown as aC, isValidMorse as aD, markdownToHtml as aE, morseToText as aF, numberToOrdinal as aG, numberToRoman as aH, numberToWords as aI, ordinalWords as aJ, parseDiff as aK, parseTableData as aL, readabilityScore as aM, renderMarkdown as aN, romanToNumber as aO, scoreReadability as aP, searchEmoji as aQ, sentenceCount as aR, slugify as aS, slugifyAll as aT, syllableCount as aU, textToAscii as aV, textToMorse as aW, unescapeString as aX, wordFrequency as aY, countWords as aa, csvToHtml as ab, csvToMarkdown as ac, detectDelimiter as ad, detectFillerWords as ae, detectPassiveVoice as af, detectWordyPhrases as ag, diffLines as ah, diffLinesSimple as ai, diffStats as aj, escapeAll as ak, escapeString as al, extractHeadings as am, formatReadingTime as an, generate as ao, generateDiff as ap, generateHtmlTable as aq, generateMarkdownTable as ar, generateParagraphs as as, generateSentences as at, generateWords as au, getAvailableFonts as av, getEmojiByCategory as aw, getEmojiByChar as ax, getEmojiByShortcode as ay, getEmojiCategories as az, type CaseFormat as b, type ConvertOptions as c, type DashIssue as d, type DashIssueType as e, type DashUsageResult as f, type DiffFile as g, type DiffHunk as h, type DiffLine as i, type DiffResult as j, type DiffType as k, type DiffViewerLine as l, ESCAPE_MODES as m, type EmojiEntry as n, type EscapeMode as o, type FillerMatch as p, type FillerWordResult as q, type KeywordDensityOptions as r, type KeywordDensityResult as s, text as t, type LineOp as u, type LineType as v, type LoremUnit as w, type MarkdownResult as x, type MorseOptions as y, type OxfordCommaResult as z };
+export { type WordCountResult as $, type AcronymCheckResult as A, type LoremUnit as B, CASE_FORMATS as C, DEFAULT_CONVERT_OPTIONS as D, EMOJI_TABLE as E, type FillerCategory as F, type MarkdownResult as G, type MorseOptions as H, type OxfordCommaResult as I, type ParsedTable as J, type KeywordDensityEntry as K, LINE_OPS as L, MORSE_CODE as M, type PassiveVoiceMatch as N, type OxfordCommaInstance as O, type ParsedDiff as P, type PassiveVoiceResult as Q, type PassiveVoiceSentence as R, type ReadabilityResult as S, type ReadabilityScore as T, type SentenceLengthBucket as U, type SentenceLengthDistribution as V, type SlugSeparator as W, type StringDistanceMode as X, type StringDistanceResult as Y, type TableOptions as Z, type TextAnalysis as _, type AcronymIssue as a, textToMorse as a$, type WordyPhraseMatch as a0, type WordyPhraseResult as a1, addBorder as a2, analyzeKeywordDensity as a3, analyzeSentenceLengths as a4, analyzeText as a5, applyOp as a6, applyOps as a7, calculateStringDistance as a8, centerText as a9, getAvailableFonts as aA, getEmojiByCategory as aB, getEmojiByChar as aC, getEmojiByShortcode as aD, getEmojiCategories as aE, getMorseForChar as aF, getMorseTiming as aG, htmlToMarkdown as aH, isValidMorse as aI, markdownToHtml as aJ, morseToText as aK, numberToOrdinal as aL, numberToRoman as aM, numberToWords as aN, ordinalWords as aO, parseDiff as aP, parseTableData as aQ, readabilityScore as aR, renderMarkdown as aS, romanToNumber as aT, scoreReadability as aU, searchEmoji as aV, sentenceCount as aW, slugify as aX, slugifyAll as aY, syllableCount as aZ, textToAscii as a_, checkAcronymExpansion as aa, checkDashUsage as ab, checkOxfordCommaConsistency as ac, convertAll as ad, convertCase as ae, countWords as af, csvToHtml as ag, csvToMarkdown as ah, detectDelimiter as ai, detectFillerWords as aj, detectPassiveVoice as ak, detectWordyPhrases as al, diffLines as am, diffLinesSimple as an, diffStats as ao, escapeAll as ap, escapeString as aq, extractHeadings as ar, formatReadingTime as as, generate as at, generateDiff as au, generateHtmlTable as av, generateMarkdownTable as aw, generateParagraphs as ax, generateSentences as ay, generateWords as az, type AcronymIssueType as b, unescapeString as b0, wordFrequency as b1, type AcronymUsage as c, type AsciiFont as d, type AsciiOptions as e, type CaseFormat as f, type ConvertOptions as g, type DashIssue as h, type DashIssueType as i, type DashUsageResult as j, type DiffFile as k, type DiffHunk as l, type DiffLine as m, type DiffResult as n, type DiffType as o, type DiffViewerLine as p, ESCAPE_MODES as q, type EmojiEntry as r, type EscapeMode as s, text as t, type FillerMatch as u, type FillerWordResult as v, type KeywordDensityOptions as w, type KeywordDensityResult as x, type LineOp as y, type LineType as z };

package/dist/{text-xY5MJwr0.d.ts → text-DOopHoK3.d.ts}

@@ -26,6 +26,7 @@
  *   - keyword-density-analyzer: analyzeKeywordDensity
  *   - emoji-lookup    : searchEmoji, getEmojiByShortcode, getEmojiByChar, getEmojiByCategory, getEmojiCategories, EMOJI_TABLE
  *   - em-dash-usage-checker: checkDashUsage
+ *   - acronym-expansion-checker: checkAcronymExpansion
  */
 interface WordCountResult {
     words: number;
@@ -484,7 +485,43 @@ interface DashUsageResult {
  * pasted alongside prose can occasionally be flagged.
  */
 declare function checkDashUsage(text: string): DashUsageResult;
+type AcronymIssueType = 'used-before-expansion' | 'never-expanded';
+interface AcronymIssue {
+    type: AcronymIssueType;
+    acronym: string;
+    index: number;
+    context: string;
+    message: string;
+}
+interface AcronymUsage {
+    acronym: string;
+    occurrences: number;
+    firstUsedAt: number;
+    expandedAt: number | null;
+    usedBeforeExpansion: boolean;
+}
+interface AcronymCheckResult {
+    acronyms: AcronymUsage[];
+    issues: AcronymIssue[];
+}
+/**
+ * Scan text for acronyms (2-10 character all-caps tokens) and flag any that
+ * are used before being expanded on first mention, per standard technical
+ * writing style guides. Recognizes both expansion conventions: the full term
+ * followed by the acronym in parentheses ("Application Programming Interface
+ * (API)"), and the acronym followed by its expansion in parentheses ("API
+ * (Application Programming Interface)"). An acronym with no expansion found
+ * anywhere in the text is reported separately as never expanded, rather than
+ * as used too early. Pure regex heuristic, not a dictionary of real acronyms:
+ * a proper noun styled in all caps, a Roman numeral, or a pluralized acronym
+ * like "APIs" can be missed or misread.
+ */
+declare function checkAcronymExpansion(text: string): AcronymCheckResult;
 
+type text_AcronymCheckResult = AcronymCheckResult;
+type text_AcronymIssue = AcronymIssue;
+type text_AcronymIssueType = AcronymIssueType;
+type text_AcronymUsage = AcronymUsage;
 type text_AsciiFont = AsciiFont;
 type text_AsciiOptions = AsciiOptions;
 declare const text_CASE_FORMATS: typeof CASE_FORMATS;
@@ -544,6 +581,7 @@ declare const text_applyOp: typeof applyOp;
 declare const text_applyOps: typeof applyOps;
 declare const text_calculateStringDistance: typeof calculateStringDistance;
 declare const text_centerText: typeof centerText;
+declare const text_checkAcronymExpansion: typeof checkAcronymExpansion;
 declare const text_checkDashUsage: typeof checkDashUsage;
 declare const text_checkOxfordCommaConsistency: typeof checkOxfordCommaConsistency;
 declare const text_convertAll: typeof convertAll;
@@ -600,7 +638,7 @@ declare const text_textToMorse: typeof textToMorse;
 declare const text_unescapeString: typeof unescapeString;
 declare const text_wordFrequency: typeof wordFrequency;
 declare namespace text {
-  export { type text_AsciiFont as AsciiFont, type text_AsciiOptions as AsciiOptions, text_CASE_FORMATS as CASE_FORMATS, type text_CaseFormat as CaseFormat, type text_ConvertOptions as ConvertOptions, text_DEFAULT_CONVERT_OPTIONS as DEFAULT_CONVERT_OPTIONS, type text_DashIssue as DashIssue, type text_DashIssueType as DashIssueType, type text_DashUsageResult as DashUsageResult, type text_DiffFile as DiffFile, type text_DiffHunk as DiffHunk, type text_DiffLine as DiffLine, type text_DiffResult as DiffResult, type text_DiffType as DiffType, type text_DiffViewerLine as DiffViewerLine, text_EMOJI_TABLE as EMOJI_TABLE, text_ESCAPE_MODES as ESCAPE_MODES, type text_EmojiEntry as EmojiEntry, type text_EscapeMode as EscapeMode, type text_FillerCategory as FillerCategory, type text_FillerMatch as FillerMatch, type text_FillerWordResult as FillerWordResult, type text_KeywordDensityEntry as KeywordDensityEntry, type text_KeywordDensityOptions as KeywordDensityOptions, type text_KeywordDensityResult as KeywordDensityResult, text_LINE_OPS as LINE_OPS, type text_LineOp as LineOp, type text_LineType as LineType, type text_LoremUnit as LoremUnit, text_MORSE_CODE as MORSE_CODE, type text_MarkdownResult as MarkdownResult, type text_MorseOptions as MorseOptions, type text_OxfordCommaInstance as OxfordCommaInstance, type text_OxfordCommaResult as OxfordCommaResult, type text_ParsedDiff as ParsedDiff, type text_ParsedTable as ParsedTable, type text_PassiveVoiceMatch as PassiveVoiceMatch, type text_PassiveVoiceResult as PassiveVoiceResult, type text_PassiveVoiceSentence as PassiveVoiceSentence, type text_ReadabilityResult as ReadabilityResult, type text_ReadabilityScore as ReadabilityScore, type text_SentenceLengthBucket as SentenceLengthBucket, type text_SentenceLengthDistribution as SentenceLengthDistribution, type text_SlugSeparator as SlugSeparator, type text_StringDistanceMode as StringDistanceMode, type text_StringDistanceResult as StringDistanceResult, type text_TableOptions as TableOptions, type text_TextAnalysis as TextAnalysis, type text_WordCountResult as WordCountResult, type text_WordyPhraseMatch as WordyPhraseMatch, type text_WordyPhraseResult as WordyPhraseResult, text_addBorder as addBorder, text_analyzeKeywordDensity as analyzeKeywordDensity, text_analyzeSentenceLengths as analyzeSentenceLengths, text_analyzeText as analyzeText, text_applyOp as applyOp, text_applyOps as applyOps, text_calculateStringDistance as calculateStringDistance, text_centerText as centerText, text_checkDashUsage as checkDashUsage, text_checkOxfordCommaConsistency as checkOxfordCommaConsistency, text_convertAll as convertAll, text_convertCase as convertCase, text_countWords as countWords, text_csvToHtml as csvToHtml, text_csvToMarkdown as csvToMarkdown, text_detectDelimiter as detectDelimiter, text_detectFillerWords as detectFillerWords, text_detectPassiveVoice as detectPassiveVoice, text_detectWordyPhrases as detectWordyPhrases, text_diffLines as diffLines, text_diffLinesSimple as diffLinesSimple, text_diffStats as diffStats, text_escapeAll as escapeAll, text_escapeString as escapeString, text_extractHeadings as extractHeadings, text_formatReadingTime as formatReadingTime, text_generate as generate, text_generateDiff as generateDiff, text_generateHtmlTable as generateHtmlTable, text_generateMarkdownTable as generateMarkdownTable, text_generateParagraphs as generateParagraphs, text_generateSentences as generateSentences, text_generateWords as generateWords, text_getAvailableFonts as getAvailableFonts, text_getEmojiByCategory as getEmojiByCategory, text_getEmojiByChar as getEmojiByChar, text_getEmojiByShortcode as getEmojiByShortcode, text_getEmojiCategories as getEmojiCategories, text_getMorseForChar as getMorseForChar, text_getMorseTiming as getMorseTiming, text_htmlToMarkdown as htmlToMarkdown, text_isValidMorse as isValidMorse, text_markdownToHtml as markdownToHtml, text_morseToText as morseToText, text_numberToOrdinal as numberToOrdinal, text_numberToRoman as numberToRoman, text_numberToWords as numberToWords, text_ordinalWords as ordinalWords, text_parseDiff as parseDiff, text_parseTableData as parseTableData, text_readabilityScore as readabilityScore, text_renderMarkdown as renderMarkdown, text_romanToNumber as romanToNumber, text_scoreReadability as scoreReadability, text_searchEmoji as searchEmoji, text_sentenceCount as sentenceCount, text_slugify as slugify, text_slugifyAll as slugifyAll, text_syllableCount as syllableCount, text_textToAscii as textToAscii, text_textToMorse as textToMorse, text_unescapeString as unescapeString, text_wordFrequency as wordFrequency };
+  export { type text_AcronymCheckResult as AcronymCheckResult, type text_AcronymIssue as AcronymIssue, type text_AcronymIssueType as AcronymIssueType, type text_AcronymUsage as AcronymUsage, type text_AsciiFont as AsciiFont, type text_AsciiOptions as AsciiOptions, text_CASE_FORMATS as CASE_FORMATS, type text_CaseFormat as CaseFormat, type text_ConvertOptions as ConvertOptions, text_DEFAULT_CONVERT_OPTIONS as DEFAULT_CONVERT_OPTIONS, type text_DashIssue as DashIssue, type text_DashIssueType as DashIssueType, type text_DashUsageResult as DashUsageResult, type text_DiffFile as DiffFile, type text_DiffHunk as DiffHunk, type text_DiffLine as DiffLine, type text_DiffResult as DiffResult, type text_DiffType as DiffType, type text_DiffViewerLine as DiffViewerLine, text_EMOJI_TABLE as EMOJI_TABLE, text_ESCAPE_MODES as ESCAPE_MODES, type text_EmojiEntry as EmojiEntry, type text_EscapeMode as EscapeMode, type text_FillerCategory as FillerCategory, type text_FillerMatch as FillerMatch, type text_FillerWordResult as FillerWordResult, type text_KeywordDensityEntry as KeywordDensityEntry, type text_KeywordDensityOptions as KeywordDensityOptions, type text_KeywordDensityResult as KeywordDensityResult, text_LINE_OPS as LINE_OPS, type text_LineOp as LineOp, type text_LineType as LineType, type text_LoremUnit as LoremUnit, text_MORSE_CODE as MORSE_CODE, type text_MarkdownResult as MarkdownResult, type text_MorseOptions as MorseOptions, type text_OxfordCommaInstance as OxfordCommaInstance, type text_OxfordCommaResult as OxfordCommaResult, type text_ParsedDiff as ParsedDiff, type text_ParsedTable as ParsedTable, type text_PassiveVoiceMatch as PassiveVoiceMatch, type text_PassiveVoiceResult as PassiveVoiceResult, type text_PassiveVoiceSentence as PassiveVoiceSentence, type text_ReadabilityResult as ReadabilityResult, type text_ReadabilityScore as ReadabilityScore, type text_SentenceLengthBucket as SentenceLengthBucket, type text_SentenceLengthDistribution as SentenceLengthDistribution, type text_SlugSeparator as SlugSeparator, type text_StringDistanceMode as StringDistanceMode, type text_StringDistanceResult as StringDistanceResult, type text_TableOptions as TableOptions, type text_TextAnalysis as TextAnalysis, type text_WordCountResult as WordCountResult, type text_WordyPhraseMatch as WordyPhraseMatch, type text_WordyPhraseResult as WordyPhraseResult, text_addBorder as addBorder, text_analyzeKeywordDensity as analyzeKeywordDensity, text_analyzeSentenceLengths as analyzeSentenceLengths, text_analyzeText as analyzeText, text_applyOp as applyOp, text_applyOps as applyOps, text_calculateStringDistance as calculateStringDistance, text_centerText as centerText, text_checkAcronymExpansion as checkAcronymExpansion, text_checkDashUsage as checkDashUsage, text_checkOxfordCommaConsistency as checkOxfordCommaConsistency, text_convertAll as convertAll, text_convertCase as convertCase, text_countWords as countWords, text_csvToHtml as csvToHtml, text_csvToMarkdown as csvToMarkdown, text_detectDelimiter as detectDelimiter, text_detectFillerWords as detectFillerWords, text_detectPassiveVoice as detectPassiveVoice, text_detectWordyPhrases as detectWordyPhrases, text_diffLines as diffLines, text_diffLinesSimple as diffLinesSimple, text_diffStats as diffStats, text_escapeAll as escapeAll, text_escapeString as escapeString, text_extractHeadings as extractHeadings, text_formatReadingTime as formatReadingTime, text_generate as generate, text_generateDiff as generateDiff, text_generateHtmlTable as generateHtmlTable, text_generateMarkdownTable as generateMarkdownTable, text_generateParagraphs as generateParagraphs, text_generateSentences as generateSentences, text_generateWords as generateWords, text_getAvailableFonts as getAvailableFonts, text_getEmojiByCategory as getEmojiByCategory, text_getEmojiByChar as getEmojiByChar, text_getEmojiByShortcode as getEmojiByShortcode, text_getEmojiCategories as getEmojiCategories, text_getMorseForChar as getMorseForChar, text_getMorseTiming as getMorseTiming, text_htmlToMarkdown as htmlToMarkdown, text_isValidMorse as isValidMorse, text_markdownToHtml as markdownToHtml, text_morseToText as morseToText, text_numberToOrdinal as numberToOrdinal, text_numberToRoman as numberToRoman, text_numberToWords as numberToWords, text_ordinalWords as ordinalWords, text_parseDiff as parseDiff, text_parseTableData as parseTableData, text_readabilityScore as readabilityScore, text_renderMarkdown as renderMarkdown, text_romanToNumber as romanToNumber, text_scoreReadability as scoreReadability, text_searchEmoji as searchEmoji, text_sentenceCount as sentenceCount, text_slugify as slugify, text_slugifyAll as slugifyAll, text_syllableCount as syllableCount, text_textToAscii as textToAscii, text_textToMorse as textToMorse, text_unescapeString as unescapeString, text_wordFrequency as wordFrequency };
 }
 
-export { analyzeKeywordDensity as $, type AsciiFont as A, type ParsedTable as B, CASE_FORMATS as C, DEFAULT_CONVERT_OPTIONS as D, EMOJI_TABLE as E, type FillerCategory as F, type PassiveVoiceMatch as G, type PassiveVoiceResult as H, type PassiveVoiceSentence as I, type ReadabilityScore as J, type KeywordDensityEntry as K, LINE_OPS as L, MORSE_CODE as M, type SentenceLengthDistribution as N, type OxfordCommaInstance as O, type ParsedDiff as P, type SlugSeparator as Q, type ReadabilityResult as R, type SentenceLengthBucket as S, type StringDistanceMode as T, type StringDistanceResult as U, type TableOptions as V, type TextAnalysis as W, type WordCountResult as X, type WordyPhraseMatch as Y, type WordyPhraseResult as Z, addBorder as _, type AsciiOptions as a, analyzeSentenceLengths as a0, analyzeText as a1, applyOp as a2, applyOps as a3, calculateStringDistance as a4, centerText as a5, checkDashUsage as a6, checkOxfordCommaConsistency as a7, convertAll as a8, convertCase as a9, getMorseForChar as aA, getMorseTiming as aB, htmlToMarkdown as aC, isValidMorse as aD, markdownToHtml as aE, morseToText as aF, numberToOrdinal as aG, numberToRoman as aH, numberToWords as aI, ordinalWords as aJ, parseDiff as aK, parseTableData as aL, readabilityScore as aM, renderMarkdown as aN, romanToNumber as aO, scoreReadability as aP, searchEmoji as aQ, sentenceCount as aR, slugify as aS, slugifyAll as aT, syllableCount as aU, textToAscii as aV, textToMorse as aW, unescapeString as aX, wordFrequency as aY, countWords as aa, csvToHtml as ab, csvToMarkdown as ac, detectDelimiter as ad, detectFillerWords as ae, detectPassiveVoice as af, detectWordyPhrases as ag, diffLines as ah, diffLinesSimple as ai, diffStats as aj, escapeAll as ak, escapeString as al, extractHeadings as am, formatReadingTime as an, generate as ao, generateDiff as ap, generateHtmlTable as aq, generateMarkdownTable as ar, generateParagraphs as as, generateSentences as at, generateWords as au, getAvailableFonts as av, getEmojiByCategory as aw, getEmojiByChar as ax, getEmojiByShortcode as ay, getEmojiCategories as az, type CaseFormat as b, type ConvertOptions as c, type DashIssue as d, type DashIssueType as e, type DashUsageResult as f, type DiffFile as g, type DiffHunk as h, type DiffLine as i, type DiffResult as j, type DiffType as k, type DiffViewerLine as l, ESCAPE_MODES as m, type EmojiEntry as n, type EscapeMode as o, type FillerMatch as p, type FillerWordResult as q, type KeywordDensityOptions as r, type KeywordDensityResult as s, text as t, type LineOp as u, type LineType as v, type LoremUnit as w, type MarkdownResult as x, type MorseOptions as y, type OxfordCommaResult as z };
+export { type WordCountResult as $, type AcronymCheckResult as A, type LoremUnit as B, CASE_FORMATS as C, DEFAULT_CONVERT_OPTIONS as D, EMOJI_TABLE as E, type FillerCategory as F, type MarkdownResult as G, type MorseOptions as H, type OxfordCommaResult as I, type ParsedTable as J, type KeywordDensityEntry as K, LINE_OPS as L, MORSE_CODE as M, type PassiveVoiceMatch as N, type OxfordCommaInstance as O, type ParsedDiff as P, type PassiveVoiceResult as Q, type PassiveVoiceSentence as R, type ReadabilityResult as S, type ReadabilityScore as T, type SentenceLengthBucket as U, type SentenceLengthDistribution as V, type SlugSeparator as W, type StringDistanceMode as X, type StringDistanceResult as Y, type TableOptions as Z, type TextAnalysis as _, type AcronymIssue as a, textToMorse as a$, type WordyPhraseMatch as a0, type WordyPhraseResult as a1, addBorder as a2, analyzeKeywordDensity as a3, analyzeSentenceLengths as a4, analyzeText as a5, applyOp as a6, applyOps as a7, calculateStringDistance as a8, centerText as a9, getAvailableFonts as aA, getEmojiByCategory as aB, getEmojiByChar as aC, getEmojiByShortcode as aD, getEmojiCategories as aE, getMorseForChar as aF, getMorseTiming as aG, htmlToMarkdown as aH, isValidMorse as aI, markdownToHtml as aJ, morseToText as aK, numberToOrdinal as aL, numberToRoman as aM, numberToWords as aN, ordinalWords as aO, parseDiff as aP, parseTableData as aQ, readabilityScore as aR, renderMarkdown as aS, romanToNumber as aT, scoreReadability as aU, searchEmoji as aV, sentenceCount as aW, slugify as aX, slugifyAll as aY, syllableCount as aZ, textToAscii as a_, checkAcronymExpansion as aa, checkDashUsage as ab, checkOxfordCommaConsistency as ac, convertAll as ad, convertCase as ae, countWords as af, csvToHtml as ag, csvToMarkdown as ah, detectDelimiter as ai, detectFillerWords as aj, detectPassiveVoice as ak, detectWordyPhrases as al, diffLines as am, diffLinesSimple as an, diffStats as ao, escapeAll as ap, escapeString as aq, extractHeadings as ar, formatReadingTime as as, generate as at, generateDiff as au, generateHtmlTable as av, generateMarkdownTable as aw, generateParagraphs as ax, generateSentences as ay, generateWords as az, type AcronymIssueType as b, unescapeString as b0, wordFrequency as b1, type AcronymUsage as c, type AsciiFont as d, type AsciiOptions as e, type CaseFormat as f, type ConvertOptions as g, type DashIssue as h, type DashIssueType as i, type DashUsageResult as j, type DiffFile as k, type DiffHunk as l, type DiffLine as m, type DiffResult as n, type DiffType as o, type DiffViewerLine as p, ESCAPE_MODES as q, type EmojiEntry as r, type EscapeMode as s, text as t, type FillerMatch as u, type FillerWordResult as v, type KeywordDensityOptions as w, type KeywordDensityResult as x, type LineOp as y, type LineType as z };

package/dist/tools/text.cjs

@@ -3196,6 +3196,68 @@ function checkDashUsage(text) {
     issues
   };
 }
+var ACRONYM_TOKEN_RE = /\b[A-Z][A-Z0-9]{1,9}\b/g;
+var ACRONYM_IN_PARENS_RE = /\(([A-Z][A-Z0-9]{1,9})\)/g;
+var ACRONYM_THEN_EXPANSION_RE = /\b([A-Z][A-Z0-9]{1,9})\b\s*\(([a-zA-Z][^()]{1,100})\)/g;
+function acronymContextSnippet(text, index, matchLen) {
+  const start = Math.max(0, index - 25);
+  const end = Math.min(text.length, index + matchLen + 25);
+  const body = text.slice(start, end).replace(/\s+/g, " ").trim();
+  return (start > 0 ? "\u2026" : "") + body + (end < text.length ? "\u2026" : "");
+}
+function checkAcronymExpansion(text) {
+  const definedAt = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_IN_PARENS_RE)) {
+    const acronym = m[1];
+    const idx = (m.index ?? 0) + 1;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  for (const m of text.matchAll(ACRONYM_THEN_EXPANSION_RE)) {
+    const acronym = m[1];
+    const idx = m.index ?? 0;
+    const existing = definedAt.get(acronym);
+    if (existing === void 0 || idx < existing) definedAt.set(acronym, idx);
+  }
+  const occurrencesByAcronym = /* @__PURE__ */ new Map();
+  for (const m of text.matchAll(ACRONYM_TOKEN_RE)) {
+    const acronym = m[0];
+    const idx = m.index ?? 0;
+    const list = occurrencesByAcronym.get(acronym);
+    if (list) list.push(idx);
+    else occurrencesByAcronym.set(acronym, [idx]);
+  }
+  const acronyms = [];
+  const issues = [];
+  for (const [acronym, indicesUnsorted] of occurrencesByAcronym) {
+    const indices = [...indicesUnsorted].sort((a, b) => a - b);
+    const firstUsedAt = indices[0];
+    const expandedAt = definedAt.has(acronym) ? definedAt.get(acronym) : null;
+    const earlyUse = expandedAt !== null ? indices.find((i) => i < expandedAt) : void 0;
+    const usedBeforeExpansion = earlyUse !== void 0;
+    acronyms.push({ acronym, occurrences: indices.length, firstUsedAt, expandedAt, usedBeforeExpansion });
+    if (usedBeforeExpansion) {
+      issues.push({
+        type: "used-before-expansion",
+        acronym,
+        index: earlyUse,
+        context: acronymContextSnippet(text, earlyUse, acronym.length),
+        message: `"${acronym}" is used here before it's expanded later in the document (at character ${expandedAt}).`
+      });
+    } else if (expandedAt === null) {
+      issues.push({
+        type: "never-expanded",
+        acronym,
+        index: firstUsedAt,
+        context: acronymContextSnippet(text, firstUsedAt, acronym.length),
+        message: `"${acronym}" is never expanded anywhere in this document.`
+      });
+    }
+  }
+  acronyms.sort((a, b) => a.firstUsedAt - b.firstUsedAt);
+  issues.sort((a, b) => a.index - b.index);
+  return { acronyms, issues };
+}
 
 exports.CASE_FORMATS = CASE_FORMATS;
 exports.DEFAULT_CONVERT_OPTIONS = DEFAULT_CONVERT_OPTIONS;
@@ -3211,6 +3273,7 @@ exports.applyOp = applyOp;
 exports.applyOps = applyOps;
 exports.calculateStringDistance = calculateStringDistance;
 exports.centerText = centerText;
+exports.checkAcronymExpansion = checkAcronymExpansion;
 exports.checkDashUsage = checkDashUsage;
 exports.checkOxfordCommaConsistency = checkOxfordCommaConsistency;
 exports.convertAll = convertAll;

package/dist/tools/text.d.cts

@@ -1 +1 @@
-export { A as AsciiFont, a as AsciiOptions, C as CASE_FORMATS, b as CaseFormat, c as ConvertOptions, D as DEFAULT_CONVERT_OPTIONS, d as DashIssue, e as DashIssueType, f as DashUsageResult, g as DiffFile, h as DiffHunk, i as DiffLine, j as DiffResult, k as DiffType, l as DiffViewerLine, E as EMOJI_TABLE, m as ESCAPE_MODES, n as EmojiEntry, o as EscapeMode, F as FillerCategory, p as FillerMatch, q as FillerWordResult, K as KeywordDensityEntry, r as KeywordDensityOptions, s as KeywordDensityResult, L as LINE_OPS, u as LineOp, v as LineType, w as LoremUnit, M as MORSE_CODE, x as MarkdownResult, y as MorseOptions, O as OxfordCommaInstance, z as OxfordCommaResult, P as ParsedDiff, B as ParsedTable, G as PassiveVoiceMatch, H as PassiveVoiceResult, I as PassiveVoiceSentence, R as ReadabilityResult, J as ReadabilityScore, S as SentenceLengthBucket, N as SentenceLengthDistribution, Q as SlugSeparator, T as StringDistanceMode, U as StringDistanceResult, V as TableOptions, W as TextAnalysis, X as WordCountResult, Y as WordyPhraseMatch, Z as WordyPhraseResult, _ as addBorder, $ as analyzeKeywordDensity, a0 as analyzeSentenceLengths, a1 as analyzeText, a2 as applyOp, a3 as applyOps, a4 as calculateStringDistance, a5 as centerText, a6 as checkDashUsage, a7 as checkOxfordCommaConsistency, a8 as convertAll, a9 as convertCase, aa as countWords, ab as csvToHtml, ac as csvToMarkdown, ad as detectDelimiter, ae as detectFillerWords, af as detectPassiveVoice, ag as detectWordyPhrases, ah as diffLines, ai as diffLinesSimple, aj as diffStats, ak as escapeAll, al as escapeString, am as extractHeadings, an as formatReadingTime, ao as generate, ap as generateDiff, aq as generateHtmlTable, ar as generateMarkdownTable, as as generateParagraphs, at as generateSentences, au as generateWords, av as getAvailableFonts, aw as getEmojiByCategory, ax as getEmojiByChar, ay as getEmojiByShortcode, az as getEmojiCategories, aA as getMorseForChar, aB as getMorseTiming, aC as htmlToMarkdown, aD as isValidMorse, aE as markdownToHtml, aF as morseToText, aG as numberToOrdinal, aH as numberToRoman, aI as numberToWords, aJ as ordinalWords, aK as parseDiff, aL as parseTableData, aM as readabilityScore, aN as renderMarkdown, aO as romanToNumber, aP as scoreReadability, aQ as searchEmoji, aR as sentenceCount, aS as slugify, aT as slugifyAll, aU as syllableCount, aV as textToAscii, aW as textToMorse, aX as unescapeString, aY as wordFrequency } from '../text-xY5MJwr0.cjs';
+export { A as AcronymCheckResult, a as AcronymIssue, b as AcronymIssueType, c as AcronymUsage, d as AsciiFont, e as AsciiOptions, C as CASE_FORMATS, f as CaseFormat, g as ConvertOptions, D as DEFAULT_CONVERT_OPTIONS, h as DashIssue, i as DashIssueType, j as DashUsageResult, k as DiffFile, l as DiffHunk, m as DiffLine, n as DiffResult, o as DiffType, p as DiffViewerLine, E as EMOJI_TABLE, q as ESCAPE_MODES, r as EmojiEntry, s as EscapeMode, F as FillerCategory, u as FillerMatch, v as FillerWordResult, K as KeywordDensityEntry, w as KeywordDensityOptions, x as KeywordDensityResult, L as LINE_OPS, y as LineOp, z as LineType, B as LoremUnit, M as MORSE_CODE, G as MarkdownResult, H as MorseOptions, O as OxfordCommaInstance, I as OxfordCommaResult, P as ParsedDiff, J as ParsedTable, N as PassiveVoiceMatch, Q as PassiveVoiceResult, R as PassiveVoiceSentence, S as ReadabilityResult, T as ReadabilityScore, U as SentenceLengthBucket, V as SentenceLengthDistribution, W as SlugSeparator, X as StringDistanceMode, Y as StringDistanceResult, Z as TableOptions, _ as TextAnalysis, $ as WordCountResult, a0 as WordyPhraseMatch, a1 as WordyPhraseResult, a2 as addBorder, a3 as analyzeKeywordDensity, a4 as analyzeSentenceLengths, a5 as analyzeText, a6 as applyOp, a7 as applyOps, a8 as calculateStringDistance, a9 as centerText, aa as checkAcronymExpansion, ab as checkDashUsage, ac as checkOxfordCommaConsistency, ad as convertAll, ae as convertCase, af as countWords, ag as csvToHtml, ah as csvToMarkdown, ai as detectDelimiter, aj as detectFillerWords, ak as detectPassiveVoice, al as detectWordyPhrases, am as diffLines, an as diffLinesSimple, ao as diffStats, ap as escapeAll, aq as escapeString, ar as extractHeadings, as as formatReadingTime, at as generate, au as generateDiff, av as generateHtmlTable, aw as generateMarkdownTable, ax as generateParagraphs, ay as generateSentences, az as generateWords, aA as getAvailableFonts, aB as getEmojiByCategory, aC as getEmojiByChar, aD as getEmojiByShortcode, aE as getEmojiCategories, aF as getMorseForChar, aG as getMorseTiming, aH as htmlToMarkdown, aI as isValidMorse, aJ as markdownToHtml, aK as morseToText, aL as numberToOrdinal, aM as numberToRoman, aN as numberToWords, aO as ordinalWords, aP as parseDiff, aQ as parseTableData, aR as readabilityScore, aS as renderMarkdown, aT as romanToNumber, aU as scoreReadability, aV as searchEmoji, aW as sentenceCount, aX as slugify, aY as slugifyAll, aZ as syllableCount, a_ as textToAscii, a$ as textToMorse, b0 as unescapeString, b1 as wordFrequency } from '../text-DOopHoK3.cjs';

package/dist/tools/text.d.ts

@@ -1 +1 @@
-export { A as AsciiFont, a as AsciiOptions, C as CASE_FORMATS, b as CaseFormat, c as ConvertOptions, D as DEFAULT_CONVERT_OPTIONS, d as DashIssue, e as DashIssueType, f as DashUsageResult, g as DiffFile, h as DiffHunk, i as DiffLine, j as DiffResult, k as DiffType, l as DiffViewerLine, E as EMOJI_TABLE, m as ESCAPE_MODES, n as EmojiEntry, o as EscapeMode, F as FillerCategory, p as FillerMatch, q as FillerWordResult, K as KeywordDensityEntry, r as KeywordDensityOptions, s as KeywordDensityResult, L as LINE_OPS, u as LineOp, v as LineType, w as LoremUnit, M as MORSE_CODE, x as MarkdownResult, y as MorseOptions, O as OxfordCommaInstance, z as OxfordCommaResult, P as ParsedDiff, B as ParsedTable, G as PassiveVoiceMatch, H as PassiveVoiceResult, I as PassiveVoiceSentence, R as ReadabilityResult, J as ReadabilityScore, S as SentenceLengthBucket, N as SentenceLengthDistribution, Q as SlugSeparator, T as StringDistanceMode, U as StringDistanceResult, V as TableOptions, W as TextAnalysis, X as WordCountResult, Y as WordyPhraseMatch, Z as WordyPhraseResult, _ as addBorder, $ as analyzeKeywordDensity, a0 as analyzeSentenceLengths, a1 as analyzeText, a2 as applyOp, a3 as applyOps, a4 as calculateStringDistance, a5 as centerText, a6 as checkDashUsage, a7 as checkOxfordCommaConsistency, a8 as convertAll, a9 as convertCase, aa as countWords, ab as csvToHtml, ac as csvToMarkdown, ad as detectDelimiter, ae as detectFillerWords, af as detectPassiveVoice, ag as detectWordyPhrases, ah as diffLines, ai as diffLinesSimple, aj as diffStats, ak as escapeAll, al as escapeString, am as extractHeadings, an as formatReadingTime, ao as generate, ap as generateDiff, aq as generateHtmlTable, ar as generateMarkdownTable, as as generateParagraphs, at as generateSentences, au as generateWords, av as getAvailableFonts, aw as getEmojiByCategory, ax as getEmojiByChar, ay as getEmojiByShortcode, az as getEmojiCategories, aA as getMorseForChar, aB as getMorseTiming, aC as htmlToMarkdown, aD as isValidMorse, aE as markdownToHtml, aF as morseToText, aG as numberToOrdinal, aH as numberToRoman, aI as numberToWords, aJ as ordinalWords, aK as parseDiff, aL as parseTableData, aM as readabilityScore, aN as renderMarkdown, aO as romanToNumber, aP as scoreReadability, aQ as searchEmoji, aR as sentenceCount, aS as slugify, aT as slugifyAll, aU as syllableCount, aV as textToAscii, aW as textToMorse, aX as unescapeString, aY as wordFrequency } from '../text-xY5MJwr0.js';
+export { A as AcronymCheckResult, a as AcronymIssue, b as AcronymIssueType, c as AcronymUsage, d as AsciiFont, e as AsciiOptions, C as CASE_FORMATS, f as CaseFormat, g as ConvertOptions, D as DEFAULT_CONVERT_OPTIONS, h as DashIssue, i as DashIssueType, j as DashUsageResult, k as DiffFile, l as DiffHunk, m as DiffLine, n as DiffResult, o as DiffType, p as DiffViewerLine, E as EMOJI_TABLE, q as ESCAPE_MODES, r as EmojiEntry, s as EscapeMode, F as FillerCategory, u as FillerMatch, v as FillerWordResult, K as KeywordDensityEntry, w as KeywordDensityOptions, x as KeywordDensityResult, L as LINE_OPS, y as LineOp, z as LineType, B as LoremUnit, M as MORSE_CODE, G as MarkdownResult, H as MorseOptions, O as OxfordCommaInstance, I as OxfordCommaResult, P as ParsedDiff, J as ParsedTable, N as PassiveVoiceMatch, Q as PassiveVoiceResult, R as PassiveVoiceSentence, S as ReadabilityResult, T as ReadabilityScore, U as SentenceLengthBucket, V as SentenceLengthDistribution, W as SlugSeparator, X as StringDistanceMode, Y as StringDistanceResult, Z as TableOptions, _ as TextAnalysis, $ as WordCountResult, a0 as WordyPhraseMatch, a1 as WordyPhraseResult, a2 as addBorder, a3 as analyzeKeywordDensity, a4 as analyzeSentenceLengths, a5 as analyzeText, a6 as applyOp, a7 as applyOps, a8 as calculateStringDistance, a9 as centerText, aa as checkAcronymExpansion, ab as checkDashUsage, ac as checkOxfordCommaConsistency, ad as convertAll, ae as convertCase, af as countWords, ag as csvToHtml, ah as csvToMarkdown, ai as detectDelimiter, aj as detectFillerWords, ak as detectPassiveVoice, al as detectWordyPhrases, am as diffLines, an as diffLinesSimple, ao as diffStats, ap as escapeAll, aq as escapeString, ar as extractHeadings, as as formatReadingTime, at as generate, au as generateDiff, av as generateHtmlTable, aw as generateMarkdownTable, ax as generateParagraphs, ay as generateSentences, az as generateWords, aA as getAvailableFonts, aB as getEmojiByCategory, aC as getEmojiByChar, aD as getEmojiByShortcode, aE as getEmojiCategories, aF as getMorseForChar, aG as getMorseTiming, aH as htmlToMarkdown, aI as isValidMorse, aJ as markdownToHtml, aK as morseToText, aL as numberToOrdinal, aM as numberToRoman, aN as numberToWords, aO as ordinalWords, aP as parseDiff, aQ as parseTableData, aR as readabilityScore, aS as renderMarkdown, aT as romanToNumber, aU as scoreReadability, aV as searchEmoji, aW as sentenceCount, aX as slugify, aY as slugifyAll, aZ as syllableCount, a_ as textToAscii, a$ as textToMorse, b0 as unescapeString, b1 as wordFrequency } from '../text-DOopHoK3.js';

package/dist/tools/text.js

@@ -1,2 +1,2 @@
-export { CASE_FORMATS, DEFAULT_CONVERT_OPTIONS, EMOJI_TABLE, ESCAPE_MODES, LINE_OPS, MORSE_CODE, addBorder, analyzeKeywordDensity, analyzeSentenceLengths, analyzeText, applyOp, applyOps, calculateStringDistance, centerText, checkDashUsage, checkOxfordCommaConsistency, convertAll, convertCase, countWords, csvToHtml, csvToMarkdown, detectDelimiter, detectFillerWords, detectPassiveVoice, detectWordyPhrases, diffLines, diffLinesSimple, diffStats, escapeAll, escapeString, extractHeadings, formatReadingTime, generate, generateDiff, generateHtmlTable, generateMarkdownTable, generateParagraphs, generateSentences, generateWords, getAvailableFonts, getEmojiByCategory, getEmojiByChar, getEmojiByShortcode, getEmojiCategories, getMorseForChar, getMorseTiming, htmlToMarkdown, isValidMorse, markdownToHtml, morseToText, numberToOrdinal, numberToRoman, numberToWords, ordinalWords, parseDiff, parseTableData, readabilityScore, renderMarkdown, romanToNumber, scoreReadability, searchEmoji, sentenceCount, slugify, slugifyAll, syllableCount, textToAscii, textToMorse, unescapeString, wordFrequency } from '../chunk-FB6CCFR5.js';
+export { CASE_FORMATS, DEFAULT_CONVERT_OPTIONS, EMOJI_TABLE, ESCAPE_MODES, LINE_OPS, MORSE_CODE, addBorder, analyzeKeywordDensity, analyzeSentenceLengths, analyzeText, applyOp, applyOps, calculateStringDistance, centerText, checkAcronymExpansion, checkDashUsage, checkOxfordCommaConsistency, convertAll, convertCase, countWords, csvToHtml, csvToMarkdown, detectDelimiter, detectFillerWords, detectPassiveVoice, detectWordyPhrases, diffLines, diffLinesSimple, diffStats, escapeAll, escapeString, extractHeadings, formatReadingTime, generate, generateDiff, generateHtmlTable, generateMarkdownTable, generateParagraphs, generateSentences, generateWords, getAvailableFonts, getEmojiByCategory, getEmojiByChar, getEmojiByShortcode, getEmojiCategories, getMorseForChar, getMorseTiming, htmlToMarkdown, isValidMorse, markdownToHtml, morseToText, numberToOrdinal, numberToRoman, numberToWords, ordinalWords, parseDiff, parseTableData, readabilityScore, renderMarkdown, romanToNumber, scoreReadability, searchEmoji, sentenceCount, slugify, slugifyAll, syllableCount, textToAscii, textToMorse, unescapeString, wordFrequency } from '../chunk-YQJ7CEUL.js';
 import '../chunk-MLKGABMK.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@utilix-tech/sdk",
-  "version": "0.88.0",
-  "description": "154+ developer utility tools for Node.js: JSON, encoding, hashing, color, CSS, network and more. Runs locally, no API key required.",
+  "version": "0.89.0",
+  "description": "728 developer utility functions for Node.js: JSON, encoding, hashing, color, CSS, network and more. Runs locally, no API key required.",
   "author": "Utilix <hello@utilix.tech>",
   "license": "MIT",
   "homepage": "https://www.utilix.tech/docs#node-sdk",