@drghaliasri/butex 5.3.0 → 5.3.2

package/dist/document2.mjs

@@ -35,9 +35,11 @@ function formatDigits(value, digitForm = "western") {
 }
 
 // src/document2/articleMeta.ts
-var BUTEX_BASMALA_LINE1 = "\u0628\u0650\u0633\u0652\u0645\u0650 \u0627\u0644\u0644\u064E\u0651\u0647\u0650 \u0627\u0644\u0631\u064E\u0651\u062D\u0652\u0645\u064E\u0670\u0646\u0650 \u0627\u0644\u0631\u064E\u0651\u062D\u0650\u064A\u0645\u0650";
-var BUTEX_BASMALA_SALAWAT = "\u0635\u064E\u0644\u064E\u0651\u0649 \u0627\u0644\u0644\u064E\u0651\u0647\u064F \u0639\u064E\u0644\u064E\u064A\u0652\u0647\u0650 \u0648\u064E\u0633\u064E\u0644\u064E\u0651\u0645\u064E";
+var BUTEX_BASMALA_LINE1 = "\u0628\u0650\u0633\u0652\u0645\u0650 \u0671\u0644\u0644\u064E\u0651\u0670\u0647\u0650 \u0671\u0644\u0631\u064E\u0651\u062D\u0652\u0645\u064E\u0670\u0646\u0650 \u0671\u0644\u0631\u064E\u0651\u062D\u0650\u064A\u0645\u0650";
+var BUTEX_BASMALA_LINE2 = "\u0648\u064E\u0671\u0644\u0635\u064E\u0651\u0644\u064E\u0627\u0629\u064F \u0648\u064E\u0671\u0644\u0633\u064E\u0651\u0644\u064E\u0627\u0645\u064F \u0639\u064E\u0644\u064E\u0649\u0670 \u0631\u064E\u0633\u064F\u0648\u0644\u0650 \u0671\u0644\u0644\u064E\u0651\u0670\u0647\u0650";
+var BUTEX_BASMALA_SALAWAT = "\u0635\u064E\u0644\u064E\u0651\u0649 \u0671\u0644\u0644\u064E\u0651\u0647\u064F \u0639\u064E\u0644\u064E\u064A\u0652\u0647\u0650 \u0648\u064E\u0633\u064E\u0644\u064E\u0651\u0645\u064E";
 var BUTEX_BASMALA = `${BUTEX_BASMALA_LINE1}
+${BUTEX_BASMALA_LINE2}
 ${BUTEX_BASMALA_SALAWAT}`;
 var BUTEX_CLOSING_HAMDALA = "\u0627\u0644\u0652\u062D\u064E\u0645\u0652\u062F\u064F \u0644\u0650\u0644\u064E\u0651\u0647\u0650 \u0646\u064E\u0641\u064E\u0639\u064E\u0646\u064E\u0627 \u0628\u0650\u0639\u0650\u0644\u0652\u0645\u0650\u0647\u0650";
 function escapeButexTextArg(text) {
@@ -51,26 +53,60 @@ function butexDiwaniDisplayLatex(text) {
 ${butexDiwaniDisplayTex(text)}
 \\]`;
 }
+var BASMALA_LINES = [BUTEX_BASMALA_LINE1, BUTEX_BASMALA_LINE2, BUTEX_BASMALA_SALAWAT];
 function butexBasmalaDisplayTex() {
-  return `${butexDiwaniDisplayTex(BUTEX_BASMALA_LINE1)} \\\\ ${butexDiwaniDisplayTex(BUTEX_BASMALA_SALAWAT)}`;
+  return BASMALA_LINES.map((line) => butexDiwaniDisplayTex(line)).join(" \\\\ ");
 }
 function butexBasmalaDisplayLatex() {
   return `\\[
 ${butexBasmalaDisplayTex()}
 \\]`;
 }
-function butexBasmalaTitlingPreamble() {
-  return [
+function butexInColumnMaketitleHook() {
+  return String.raw`\makeatletter
+\renewcommand{\maketitle}{%
+  \par
+  \begingroup
+    \renewcommand\thefootnote{\@fnsymbol\c@footnote}%
+    \def\@makefnmark{\rlap{\@textsuperscript{\normalfont\@thefnmark}}}%
+    \long\def\@makefntext##1{\parindent 1em\noindent
+      \hb@xt@1.8em{\hss\@textsuperscript{\normalfont\@thefnmark}}##1}%
+    \@maketitle
+    \thispagestyle{plain}\@thanks
+  \endgroup
+  \setcounter{footnote}{0}%
+  \global\let\thanks\relax
+  \global\let\maketitle\relax
+  \global\let\@maketitle\relax
+  \global\let\@thanks\@empty
+  \global\let\@author\@empty
+  \global\let\@date\@empty
+  \global\let\@title\@empty
+  \global\let\title\relax
+  \global\let\author\relax
+  \global\let\date\relax
+  \global\let\and\relax
+}
+\makeatother`;
+}
+function butexBasmalaTitlingPreamble(options = {}) {
+  const lines = [
     "\\usepackage{titling}",
     "\\pretitle{%",
     "  \\begin{center}",
-    `  ${butexDiwaniDisplayTex(BUTEX_BASMALA_LINE1)}\\\\`,
-    `  ${butexDiwaniDisplayTex(BUTEX_BASMALA_SALAWAT)}`,
+    ...BASMALA_LINES.map((line, index) => {
+      const suffix = index < BASMALA_LINES.length - 1 ? "\\\\" : "";
+      return `  ${butexDiwaniDisplayTex(line)}${suffix}`;
+    }),
     "  \\par\\vspace{1.5em}",
     "  \\LARGE",
     "}",
     "\\posttitle{\\par\\end{center}}"
-  ].join("\n");
+  ];
+  if (options.twocolumn) {
+    lines.push(butexInColumnMaketitleHook());
+  }
+  return lines.join("\n");
 }
 var HIJRI_YEAR_MIN = 1400;
 var HIJRI_YEAR_MAX = 1500;
@@ -232,6 +268,10 @@ function cloneDocument2Meta(meta) {
 }
 
 // src/document2/citations.ts
+var DEFAULT_REFERENCE_FIELD_SEPARATOR = "\u060C";
+function normalizeReferenceFieldSeparator(value) {
+  return value === "," ? "," : DEFAULT_REFERENCE_FIELD_SEPARATOR;
+}
 function referenceNumberMap(references) {
   const map = /* @__PURE__ */ new Map();
   references.forEach((reference, index) => {
@@ -277,7 +317,8 @@ function referenceFromJson(json) {
     title: typeof json.title === "string" ? json.title : "",
     year: typeof json.year === "string" ? json.year : "",
     url: typeof json.url === "string" ? json.url : "",
-    venue: typeof json.venue === "string" ? json.venue : ""
+    venue: typeof json.venue === "string" ? json.venue : "",
+    fieldSeparator: normalizeReferenceFieldSeparator(json.field_separator)
   };
 }
 function createEmptyReference2(partial = {}) {
@@ -287,15 +328,33 @@ function createEmptyReference2(partial = {}) {
     title: partial.title,
     year: partial.year,
     url: partial.url,
-    venue: partial.venue
+    venue: partial.venue,
+    field_separator: partial.field_separator
   });
 }
+function bibliographyEntryBody(reference, separator = reference.fieldSeparator, options = {}) {
+  const year = options.digitForm !== void 0 ? formatDigits(reference.year, options.digitForm) : reference.year;
+  const parts = [reference.authors, reference.title, reference.venue, year].filter((part) => part.trim().length > 0);
+  return parts.join(`${separator} `);
+}
 function bibliographyEntryLatex(reference) {
-  const parts = [reference.authors, reference.title, reference.venue, reference.year].filter((part) => part.trim().length > 0);
-  const body = parts.join(", ");
+  const body = bibliographyEntryBody(reference);
   const url = reference.url.trim().length > 0 ? ` \\url{${reference.url}}` : "";
   return `\\bibitem{${reference.key}} ${body}${url}`.trim();
 }
+function absoluteHttpHref(url) {
+  const trimmed = url.trim();
+  if (trimmed.length === 0) {
+    return "";
+  }
+  if (/^[a-zA-Z][a-zA-Z0-9+.-]*:/.test(trimmed)) {
+    return trimmed;
+  }
+  if (trimmed.startsWith("//")) {
+    return `https:${trimmed}`;
+  }
+  return `https://${trimmed}`;
+}
 
 // src/ast/commands/index.ts
 function renderCommandCore(context) {
@@ -780,6 +839,23 @@ function labelNumberMap(document2) {
   }
   return map;
 }
+function formatFloatCaptionTitle(kind, number, options = {}) {
+  const locale = options.uiLocale ?? "ar";
+  const kindWord = kind === "fig" ? locale === "ar" ? "\u0627\u0644\u0634\u0643\u0644" : "Figure" : kind === "tab" ? locale === "ar" ? "\u0627\u0644\u062C\u062F\u0648\u0644" : "Table" : locale === "ar" ? "\u0627\u0644\u0645\u0639\u0627\u062F\u0644\u0629" : "Equation";
+  const digits = formatBibliographyNumber(number, {
+    documentDirection: options.documentDirection ?? (locale === "ar" ? "rtl" : "ltr"),
+    digitForm: options.digitForm ?? (locale === "ar" ? "arabicIndic" : "western")
+  });
+  return `${kindWord} ${digits}`;
+}
+function formatFloatCaptionPreview(title, caption, uiLocale = "ar") {
+  const trimmed = caption?.trim() ?? "";
+  if (trimmed.length === 0) {
+    return title;
+  }
+  const separator = uiLocale === "ar" ? ": " : ". ";
+  return `${title}${separator}${trimmed}`;
+}
 function formatRefLabel(keys, document2, refCommand, options = {}) {
   const documentDirection = options.documentDirection ?? "rtl";
   const digitForm = options.digitForm ?? (documentDirection === "rtl" ? "arabicIndic" : "western");
@@ -1050,7 +1126,8 @@ function parseReferences(json) {
         title: typeof entry.title === "string" ? entry.title : void 0,
         year: typeof entry.year === "string" ? entry.year : void 0,
         url: typeof entry.url === "string" ? entry.url : void 0,
-        venue: typeof entry.venue === "string" ? entry.venue : void 0
+        venue: typeof entry.venue === "string" ? entry.venue : void 0,
+        field_separator: entry.field_separator === "," || entry.field_separator === "\u060C" ? entry.field_separator : void 0
       })
     );
   }
@@ -3947,7 +4024,7 @@ function addDocument2ImageBlock(document2, src = "", afterBlockId) {
     kind: "image",
     command: "\\includegraphics",
     value: src,
-    options: { width: "0.8\\textwidth" },
+    options: { width: "0.8\\columnwidth" },
     ...defaultFloatMeta()
   };
   return insertDocument2BlockAfter(document2, afterBlockId, block);
@@ -4232,6 +4309,9 @@ function updateDocument2Reference(document2, referenceId, patch) {
   if (typeof patch.venue === "string") {
     reference.venue = patch.venue;
   }
+  if (patch.field_separator === "," || patch.field_separator === "\u060C") {
+    reference.fieldSeparator = patch.field_separator;
+  }
   return next;
 }
 function removeDocument2Reference(document2, referenceId) {
@@ -4270,6 +4350,52 @@ function updateDocument2Meta(document2, patch) {
   return next;
 }
 
+// src/document2/keys.ts
+var DOCUMENT2_KEY_PATTERN = /^[\p{L}\p{M}0-9:._-]+$/u;
+function normalizeDocument2Key(key) {
+  return key.normalize("NFC").trim();
+}
+function isValidDocument2Key(key) {
+  const normalized = normalizeDocument2Key(key);
+  return normalized.length > 0 && DOCUMENT2_KEY_PATTERN.test(normalized);
+}
+function isDuplicateDocument2Key(key, namespace) {
+  const normalized = normalizeDocument2Key(key);
+  if (normalized.length === 0) {
+    return false;
+  }
+  for (const reference of namespace.references ?? []) {
+    if (namespace.excludeReferenceId && reference.id === namespace.excludeReferenceId) {
+      continue;
+    }
+    if (normalizeDocument2Key(reference.key) === normalized) {
+      return true;
+    }
+  }
+  for (const label of namespace.labels ?? []) {
+    if (namespace.excludeOwnerId && label.ownerId === namespace.excludeOwnerId) {
+      continue;
+    }
+    if (normalizeDocument2Key(label.key) === normalized) {
+      return true;
+    }
+  }
+  return false;
+}
+function document2KeyError(key, namespace = {}) {
+  const normalized = normalizeDocument2Key(key);
+  if (normalized.length === 0) {
+    return "empty";
+  }
+  if (!DOCUMENT2_KEY_PATTERN.test(normalized)) {
+    return "invalid";
+  }
+  if (isDuplicateDocument2Key(normalized, namespace)) {
+    return "duplicate";
+  }
+  return null;
+}
+
 // src/document2/arabicPreamble.ts
 function arabicXeLatexPreamblePkg(twocolumn = false) {
   const classOptions = twocolumn ? "12pt,a4paper,notitlepage,twocolumn" : "12pt,a4paper,notitlepage";
@@ -4552,8 +4678,16 @@ function tableBlockLatex(block) {
   lines.push("\\end{table}");
   return lines.join("\n");
 }
-function imageOptionsLatex(block) {
-  const entries = Object.entries(block.options);
+function remapImageWidthForColumns(value) {
+  return value.replace(/\\textwidth\b/g, "\\columnwidth");
+}
+function imageOptionsLatex(block, constrainToColumn) {
+  const entries = Object.entries(block.options).map(([key, value]) => {
+    if (constrainToColumn && key === "width") {
+      return [key, remapImageWidthForColumns(value)];
+    }
+    return [key, value];
+  });
   if (entries.length === 0) {
     return "";
   }
@@ -4564,7 +4698,7 @@ function imageBlockLatex(block) {
   if (block.centered) {
     lines.push("  \\centering");
   }
-  lines.push(`  ${block.command}${imageOptionsLatex(block)}{${block.value}}`);
+  lines.push(`  ${block.command}${imageOptionsLatex(block, true)}{${block.value}}`);
   lines.push(...floatCaptionLabelLines(block));
   lines.push("\\end{figure}");
   return lines.join("\n");
@@ -4594,11 +4728,11 @@ ${block.closing}`;
 function authorLatex(authors) {
   return authors.split(/\n+/).map((line) => line.trim()).filter((line) => line.length > 0).join(" \\\\ ");
 }
-function articleMaketitlePreamble(meta) {
+function articleMaketitlePreamble(meta, twocolumn = false) {
   if (!document2HasMaketitle(meta)) {
     return "";
   }
-  const parts = [butexBasmalaTitlingPreamble()];
+  const parts = [butexBasmalaTitlingPreamble({ twocolumn })];
   if (meta.title.trim().length > 0) {
     parts.push(`\\title{${meta.title.trim()}}`);
   }
@@ -4624,21 +4758,22 @@ ${meta.abstract.trim()}
 }
 function document2Latex(document2, options = {}) {
   const meta = document2.meta ?? emptyDocument2Meta();
+  const twocolumn = options.twocolumn === true;
   const front = articleFrontMatterLatex(meta);
   const bodyBlocks = document2.blocks.map((block) => blockLatex(block, document2.references));
   const closing = butexDiwaniDisplayLatex(BUTEX_CLOSING_HAMDALA);
   const body = [...front, ...bodyBlocks, closing].filter((part) => part.length > 0).join("\n\n");
   const wrapDocument = options.wrapDocument !== false;
   if (!wrapDocument) {
-    const metaPreamble = articleMaketitlePreamble(meta);
+    const metaPreamble = articleMaketitlePreamble(meta, twocolumn);
     return metaPreamble.length > 0 ? `${metaPreamble}
 
 ${body}` : body;
   }
   const preamble = getArabicXeLatexPreamble({
     digitsMapping: options.digitsMapping ?? "arabicdigits",
-    twocolumn: options.twocolumn === true
-  }) + "\n" + articleMaketitlePreamble(meta);
+    twocolumn
+  }) + "\n" + articleMaketitlePreamble(meta, twocolumn);
   return `${preamble}
 \\begin{document}
 
@@ -4811,13 +4946,11 @@ function floatNumberLabel(document2, key, previewOptions) {
   if (!hit || hit.kind !== "fig" && hit.kind !== "tab") {
     return void 0;
   }
-  const locale = previewOptions.uiLocale ?? "ar";
-  const kindWord = hit.kind === "fig" ? locale === "ar" ? "\u0627\u0644\u0634\u0643\u0644" : "Figure" : locale === "ar" ? "\u0627\u0644\u062C\u062F\u0648\u0644" : "Table";
-  const digits = formatBibliographyNumber(hit.number, {
+  return formatFloatCaptionTitle(hit.kind, hit.number, {
+    uiLocale: previewOptions.uiLocale ?? "ar",
     documentDirection: previewOptions.documentDirection,
     digitForm: previewOptions.digitForm
   });
-  return `${kindWord} ${digits}`;
 }
 function blockPreview(block, islands, output, equationSide, document2, previewOptions) {
   if (block.kind === "textBlock") {
@@ -4872,7 +5005,8 @@ function blockPreview(block, islands, output, equationSide, document2, previewOp
         title: reference.title,
         year: reference.year,
         url: reference.url,
-        venue: reference.venue
+        venue: reference.venue,
+        fieldSeparator: reference.fieldSeparator
       }))
     };
   }
@@ -4920,13 +5054,16 @@ function document2Preview(document2, output = "svg", equationSide = "arabic", pr
 export {
   BUTEX_BASMALA,
   BUTEX_BASMALA_LINE1,
+  BUTEX_BASMALA_LINE2,
   BUTEX_BASMALA_SALAWAT,
   BUTEX_CLOSING_HAMDALA,
   DEFAULT_DOCUMENT2_HISTORY_MAX_DEPTH,
   DEFAULT_HIJRI_DATE,
+  DEFAULT_REFERENCE_FIELD_SEPARATOR,
   HIJRI_MONTH_IDS,
   HIJRI_YEAR_MAX,
   HIJRI_YEAR_MIN,
+  absoluteHttpHref,
   addDocument2ImageBlock,
   addDocument2ListBlock,
   addDocument2ListItem,
@@ -4937,12 +5074,14 @@ export {
   arabicXeLatexPreambleCmd,
   arabicXeLatexPreambleFont,
   arabicXeLatexPreamblePkg,
+  bibliographyEntryBody,
   bibliographyEntryLatex,
   butexBasmalaDisplayLatex,
   butexBasmalaDisplayTex,
   butexBasmalaTitlingPreamble,
   butexDiwaniDisplayLatex,
   butexDiwaniDisplayTex,
+  butexInColumnMaketitleHook,
   citeTokenLatex,
   cloneDocument2Meta,
   cloneDocument2Node,
@@ -4961,6 +5100,7 @@ export {
   document2HasTitleStack,
   document2HistoryCanRedo,
   document2HistoryCanUndo,
+  document2KeyError,
   document2Latex,
   document2Preview,
   emptyBlockSelection,
@@ -4971,6 +5111,8 @@ export {
   findFirstInlineField,
   formatBibliographyNumber,
   formatCiteLabel,
+  formatFloatCaptionPreview,
+  formatFloatCaptionTitle,
   formatHijriDate,
   formatRefLabel,
   fromDocumentJson2,
@@ -4982,6 +5124,8 @@ export {
   insertMathToken,
   insertMathTokenAtCaret,
   insertRefTokenAtCaret,
+  isDuplicateDocument2Key,
+  isValidDocument2Key,
   labelNumberMap,
   mathNodeFromArabicSession,
   mathNodeFromSession,
@@ -4996,7 +5140,9 @@ export {
   moveDocument2Reference,
   normalizeBlockSelection,
   normalizeDocument2HijriDate,
+  normalizeDocument2Key,
   normalizeDocument2Meta,
+  normalizeReferenceFieldSeparator,
   parseCiteKeys,
   parseFloatMetaFromJson,
   parseRefKeys,