@pretextbook/import 0.16.0 → 0.17.0

package/dist/index.d.ts

@@ -31,4 +31,4 @@ export type { SourceFormat, ProjectLayout, ConversionContext, ConvertedPretextRe
 export { createWorkerEngine, runConversionInWorker, ConversionCancelledError, type ConversionWorker, type WorkerEngineOptions, type RunningConversion, } from './worker/worker-engine';
 export type { WorkerRequest, WorkerResponse, ConvertRequest, ResultResponse, ErrorResponse, } from './worker/protocol';
 export { PANDOC_ACCEPT_EXTENSIONS, PANDOC_BINARY_FORMATS, PANDOC_EXTENSION_FORMATS, fileExtension, pandocFormatForFileName, createPandocEngine, createRemotePandocEngine, describeRemotePandocFailure, extractPandocErrorDetail, DEFAULT_REMOTE_PANDOC_TIMEOUT_MS, type PandocInputFormat, type PandocBridge, type PandocEngineOptions, type RemotePandocEngineOptions, } from './lib/pandoc';
-export { DEFAULT_ACCEPT_EXTENSIONS, allAcceptExtensions, alternateEngine, alternateFor, engineAccepts, engineExtensions, matchesExtension, routeEngine, unsupportedFileMessage, type RoutableEngine, } from './lib/engine-routing';
+export { DEFAULT_ACCEPT_EXTENSIONS, allAcceptExtensions, alternateEngine, alternateFor, engineAccepts, engineExtensions, experimentalEngineFor, experimentalEngines, matchesExtension, routeEngine, unsupportedFileMessage, type RoutableEngine, } from './lib/engine-routing';

package/dist/index.js

@@ -1,6 +1,6 @@
 import { i as ae, P as re, f as B, d as se, r as le, a as ne, b as W, c as K, w, s as U, e as oe, g as me, p as ce, h as L, j as pe, k as de } from "./upload-Df7DMau_.js";
-import { C as xt, D as ft, L as kt, l as yt, m as qt, M as vt, n as wt, o as Tt, q as Et, t as Pt, u as St, v as jt, x as At, y as It, z as _t, A as zt, B as Lt, E as $t, F as Ct, G as Rt, H as Nt, I as Ft, J as Mt, K as Dt, N as Ot, O as Xt, Q as Bt, R as Wt, S as Kt, T as Ut, U as Ht, V as Gt, W as Zt, X as Vt, Y as Yt, Z as Jt, _ as Qt, $ as ei, a0 as ti, a1 as ii, a2 as ai, a3 as ri, a4 as si, a5 as li, a6 as ni, a7 as oi, a8 as mi, a9 as ci, aa as pi, ab as di, ac as ui, ad as bi, ae as gi, af as hi, ag as xi, ah as fi, ai as ki, aj as yi, ak as qi, al as vi, am as wi, an as Ti } from "./upload-Df7DMau_.js";
-import { D as Pi, a as Si, b as ji, c as Ai, d as Ii, e as _i, f as zi, g as Li, h as $i, i as Ci, j as Ri, k as Ni, l as Fi, m as Mi, n as Di, o as Oi, p as Xi, r as Bi, q as Wi, u as Ki } from "./engine-routing-DorSgyrU.js";
+import { C as xt, D as ft, L as kt, l as qt, m as yt, M as vt, n as wt, o as Tt, q as Et, t as Pt, u as St, v as jt, x as At, y as It, z as _t, A as zt, B as Lt, E as $t, F as Ct, G as Rt, H as Ft, I as Nt, J as Mt, K as Dt, N as Ot, O as Xt, Q as Bt, R as Wt, S as Kt, T as Ut, U as Ht, V as Gt, W as Zt, X as Vt, Y as Yt, Z as Jt, _ as Qt, $ as ei, a0 as ti, a1 as ii, a2 as ai, a3 as ri, a4 as si, a5 as li, a6 as ni, a7 as oi, a8 as mi, a9 as ci, aa as pi, ab as di, ac as ui, ad as bi, ae as gi, af as hi, ag as xi, ah as fi, ai as ki, aj as qi, ak as yi, al as vi, am as wi, an as Ti } from "./upload-Df7DMau_.js";
+import { D as Pi, a as Si, b as ji, c as Ai, d as Ii, e as _i, f as zi, g as Li, h as $i, i as Ci, j as Ri, k as Fi, l as Ni, m as Mi, n as Di, o as Oi, p as Xi, q as Bi, r as Wi, s as Ki, t as Ui, u as Hi } from "./engine-routing-DDxL53jG.js";
 import { verbatimTags as ue } from "@pretextbook/format";
 const be = /\$(?![\s$])([^$\n]{1,200})\$/;
 function ge(e) {
@@ -53,22 +53,22 @@ const he = [
 function ke(e) {
   return fe.test(e);
 }
-const ye = 2;
+const qe = 2;
 function $(e, t) {
   return t.reduce(
     (i, { pattern: a, weight: r }) => i + (a.test(e) ? r : 0),
     0
   );
 }
-function qe(e) {
+function ye(e) {
   return { latex: $(e, he) + (ge(e) ? 2 : 0), markdown: $(e, xe) };
 }
 function rt(e) {
   const t = e.trim();
   if (!t || t.startsWith("<") || ke(t))
     return;
-  const { latex: i, markdown: a } = qe(t);
-  if (!(Math.max(i, a) < ye))
+  const { latex: i, markdown: a } = ye(t);
+  if (!(Math.max(i, a) < qe))
     return i >= a ? "latex" : "markdown";
 }
 const ve = {
@@ -89,12 +89,12 @@ function we(e) {
   const t = e.split(".").pop()?.toLowerCase() ?? "";
   return ve[t] ?? "application/octet-stream";
 }
-const q = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+const y = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 function Te(e) {
   const t = e.length, i = [];
   for (let a = 0; a < t; a += 3) {
     const r = e[a], l = a + 1 < t, s = a + 2 < t, n = l ? e[a + 1] : 0, m = s ? e[a + 2] : 0;
-    i.push(q[r >> 2]), i.push(q[(r & 3) << 4 | n >> 4]), i.push(l ? q[(n & 15) << 2 | m >> 6] : "="), i.push(s ? q[m & 63] : "=");
+    i.push(y[r >> 2]), i.push(y[(r & 3) << 4 | n >> 4]), i.push(l ? y[(n & 15) << 2 | m >> 6] : "="), i.push(s ? y[m & 63] : "=");
   }
   return i.join("");
 }
@@ -198,26 +198,26 @@ const Z = new Set(
    tage taxon term tex timeofday times timesignature today trademark ul url
    var viz vs xelatex xetex xref`.trim().split(/\s+/)
 ), R = /<!--[\s\S]*?-->/g;
-function N(e, t) {
+function F(e, t) {
   R.lastIndex = 0;
   let i = 0, a;
   for (; (a = R.exec(t)) !== null; )
-    a.index > i && F(e, t.slice(i, a.index)), e.push({ kind: "comment", text: a[0] }), i = a.index + a[0].length;
-  i < t.length && F(e, t.slice(i));
+    a.index > i && N(e, t.slice(i, a.index)), e.push({ kind: "comment", text: a[0] }), i = a.index + a[0].length;
+  i < t.length && N(e, t.slice(i));
 }
-function F(e, t) {
+function N(e, t) {
   e.push({ kind: "text", text: t, meaningful: /\S/.test(t) });
 }
 function Ie(e) {
   const t = [];
   let i = 0;
   for (const a of B(e, () => !0))
-    a.start > i && N(t, e.slice(i, a.start)), t.push({
+    a.start > i && F(t, e.slice(i, a.start)), t.push({
       kind: "element",
       text: a.outer,
       paragraphContent: Z.has(a.name)
     }), i = a.end;
-  return i < e.length && N(t, e.slice(i)), t;
+  return i < e.length && F(t, e.slice(i)), t;
 }
 function P(e) {
   return e.kind === "comment" || e.kind === "text" && !e.meaningful;
@@ -853,6 +853,49 @@ const $e = {
         "xml:lang"
       ]
     },
+    archive: {
+      elements: [
+        "copyleft",
+        "copyright",
+        "dblprime",
+        "degree",
+        "ellipsis",
+        "icon",
+        "kbd",
+        "langle",
+        "ldblbracket",
+        "lq",
+        "lsq",
+        "m",
+        "mdash",
+        "midpoint",
+        "minus",
+        "nbsp",
+        "ndash",
+        "obelus",
+        "permille",
+        "phonomark",
+        "pilcrow",
+        "plusminus",
+        "prime",
+        "rangle",
+        "rdblbracket",
+        "registered",
+        "rq",
+        "rsq",
+        "section-mark",
+        "servicemark",
+        "solidus",
+        "swungdash",
+        "times",
+        "trademark"
+      ],
+      attributes: []
+    },
+    archive_location: {
+      elements: [],
+      attributes: []
+    },
     article: {
       elements: [
         "activity",
@@ -1409,15 +1452,20 @@ const $e = {
         "alert",
         "am",
         "angles",
+        "archive",
+        "archive_location",
         "articletitle",
         "attr",
         "author",
         "bc",
         "c",
         "ca",
+        "chapter-number",
         "chord",
+        "collection-number",
         "collection-title",
         "container-title",
+        "container-title-short",
         "copyleft",
         "copyright",
         "custom",
@@ -1437,6 +1485,7 @@ const $e = {
         "email",
         "etal",
         "etc",
+        "event",
         "fillin",
         "flat",
         "foreign",
@@ -1470,6 +1519,7 @@ const $e = {
         "note",
         "number",
         "number-of-pages",
+        "number-of-volumes",
         "obelus",
         "page",
         "page-first",
@@ -1503,6 +1553,7 @@ const $e = {
         "solidus",
         "sq",
         "stale",
+        "status",
         "swungdash",
         "tag",
         "tage",
@@ -1519,6 +1570,7 @@ const $e = {
         "url",
         "URL",
         "var",
+        "version",
         "viz",
         "volume",
         "vs",
@@ -1970,6 +2022,10 @@ const $e = {
         "xml:lang"
       ]
     },
+    "chapter-number": {
+      elements: [],
+      attributes: []
+    },
     checkpoint: {
       elements: [
         "feedback",
@@ -2047,6 +2103,10 @@ const $e = {
         "width"
       ]
     },
+    "collection-number": {
+      elements: [],
+      attributes: []
+    },
     "collection-title": {
       elements: [
         "copyleft",
@@ -2281,6 +2341,45 @@ const $e = {
       ],
       attributes: []
     },
+    "container-title-short": {
+      elements: [
+        "copyleft",
+        "copyright",
+        "dblprime",
+        "degree",
+        "ellipsis",
+        "icon",
+        "kbd",
+        "langle",
+        "ldblbracket",
+        "lq",
+        "lsq",
+        "m",
+        "mdash",
+        "midpoint",
+        "minus",
+        "nbsp",
+        "ndash",
+        "obelus",
+        "permille",
+        "phonomark",
+        "pilcrow",
+        "plusminus",
+        "prime",
+        "rangle",
+        "rdblbracket",
+        "registered",
+        "rq",
+        "rsq",
+        "section-mark",
+        "servicemark",
+        "solidus",
+        "swungdash",
+        "times",
+        "trademark"
+      ],
+      attributes: []
+    },
     context: {
       elements: [
         "aside",
@@ -5986,6 +6085,10 @@ const $e = {
       elements: [],
       attributes: []
     },
+    "number-of-volumes": {
+      elements: [],
+      attributes: []
+    },
     obelus: {
       elements: [],
       attributes: []
@@ -8573,21 +8676,55 @@ const $e = {
         "biographical",
         "blockquote",
         "console",
+        "copyleft",
+        "copyright",
+        "dblprime",
+        "degree",
+        "ellipsis",
         "figure",
         "historical",
+        "icon",
         "idx",
         "image",
+        "kbd",
+        "langle",
+        "ldblbracket",
         "list",
         "listing",
+        "lq",
+        "lsq",
+        "m",
+        "mdash",
+        "midpoint",
+        "minus",
+        "nbsp",
+        "ndash",
+        "obelus",
         "p",
+        "permille",
+        "phonomark",
+        "pilcrow",
+        "plusminus",
         "pre",
+        "prime",
         "program",
+        "rangle",
+        "rdblbracket",
+        "registered",
+        "rq",
+        "rsq",
         "sage",
         "sbsgroup",
+        "section-mark",
+        "servicemark",
         "sidebyside",
+        "solidus",
+        "swungdash",
         "table",
         "tabular",
+        "times",
         "title",
+        "trademark",
         "video"
       ],
       attributes: [
@@ -9772,6 +9909,10 @@ const $e = {
         "width"
       ]
     },
+    version: {
+      elements: [],
+      attributes: []
+    },
     video: {
       elements: [
         "title",
@@ -10212,7 +10353,7 @@ const $e = {
 }, Re = (e) => e !== void 0 && /[A-Za-z_]/.test(e), D = (e, t) => {
   const i = /^[A-Za-z_][\w.:-]*/.exec(e.slice(t, t + 128));
   return i ? i[0] : "";
-}, Ne = (e, t) => {
+}, Fe = (e, t) => {
   const i = [];
   let a = 0;
   const r = (l, s, n) => {
@@ -10252,7 +10393,7 @@ const $e = {
     a = s;
   }
   return { inText: !0, open: i };
-}, Fe = [
+}, Ne = [
   // theorem-like
   "theorem",
   "lemma",
@@ -10306,7 +10447,7 @@ const $e = {
   "figure",
   "table"
 ];
-new Set(Fe);
+new Set(Ne);
 [...Ce];
 [
   ...k,
@@ -10365,7 +10506,7 @@ function Xe(e) {
   return e.some((i) => i.name === "p");
 }
 function ct(e) {
-  const t = Ne(e, e.length), i = Xe(t.open);
+  const t = Fe(e, e.length), i = Xe(t.open);
   return t.inText ? { literal: Oe(t.open), inline: i } : {
     literal: "the cursor is inside a tag, a comment or a CDATA section",
     inline: i
@@ -10710,9 +10851,9 @@ function bt(e) {
       const h = new FormData();
       i && h.set("token", i), h.set("file", d, d.name), h.set("from", I), l && h.set("standalone", "yes");
       const _ = new AbortController(), te = setTimeout(() => _.abort(), n);
-      let y;
+      let q;
       try {
-        y = await A(t, {
+        q = await A(t, {
           method: "POST",
           body: h,
           headers: a,
@@ -10729,10 +10870,10 @@ function bt(e) {
       } finally {
         clearTimeout(te);
       }
-      const z = await y.text();
-      if (!y.ok)
+      const z = await q.text();
+      if (!q.ok)
         throw new Error(
-          Qe(y.status, z, d.name)
+          Qe(q.status, z, d.name)
         );
       return z;
     },
@@ -10750,8 +10891,8 @@ export {
   Ye as DEFAULT_REMOTE_PANDOC_TIMEOUT_MS,
   ft as DIVISION_LADDER,
   kt as LADDER_OVERFLOW_TAG,
-  yt as LATEX_DIVISION_COMMANDS,
-  qt as LATEX_FORMAT_MARKERS,
+  qt as LATEX_DIVISION_COMMANDS,
+  yt as LATEX_FORMAT_MARKERS,
   vt as MARKDOWN_FORMAT_MARKERS,
   wt as MAX_SUGGESTED_SPLIT_LEVEL,
   Q as PANDOC_ACCEPT_EXTENSIONS,
@@ -10778,11 +10919,11 @@ export {
   ke as containsXmlMarkup,
   Ct as convertLatexToPretext,
   Rt as convertMarkdownToPretext,
-  Nt as convertSourceToPretext,
+  Ft as convertSourceToPretext,
   Ve as createPandocEngine,
   bt as createRemotePandocEngine,
   dt as createWorkerEngine,
-  Ft as dedupeXmlIds,
+  Nt as dedupeXmlIds,
   Mt as defaultAttachLevel,
   Dt as defaultManifestTarget,
   Qe as describeRemotePandocFailure,
@@ -10797,29 +10938,31 @@ export {
   Ci as engineAccepts,
   Ri as engineExtensions,
   Wt as expandPretextIncludes,
+  Fi as experimentalEngineFor,
+  Ni as experimentalEngines,
   Je as extractPandocErrorDetail,
   L as extractUpload,
-  Ni as fileChangesForImport,
+  Mi as fileChangesForImport,
   ee as fileExtension,
   Kt as filePrefixForDivision,
-  Fi as filesForImportMode,
+  Di as filesForImportMode,
   Ut as findLatexFixes,
   Ht as findLatexHeaders,
   Gt as findProjectManifest,
   ot as firstDivisionTag,
   Zt as fixesToWarnings,
-  Mi as formatWarningLine,
+  Oi as formatWarningLine,
   Vt as getConversionErrorMessage,
   Yt as getLatexCleanDiagnostics,
   Jt as handleImportUploadFile,
-  Di as hasNativeImportMode,
+  Xi as hasNativeImportMode,
   de as importProjectFromFiles,
   Qt as isDivisionTag,
   nt as isInlineContext,
   ei as ladderDepth,
   ti as latexDivisionHierarchy,
   ii as latexFixesToCodeActions,
-  Oi as matchesExtension,
+  Bi as matchesExtension,
   ai as mergeChunksAtLevel,
   ri as normalizePretextSource,
   si as outlineDivisions,
@@ -10829,7 +10972,7 @@ export {
   ct as pasteTargetAt,
   mt as placeConvertedMarkup,
   oi as prepareInsertSource,
-  Xi as projectForImportMode,
+  Wi as projectForImportMode,
   mi as pruneDivisions,
   ci as rebuildImport,
   Se as recordsToPlusPayload,
@@ -10839,24 +10982,24 @@ export {
   di as renderProjectPtxFromManifest,
   ne as renderPublicationPtx,
   ui as reselectImport,
-  Bi as resolveImportMode,
+  Ki as resolveImportMode,
   bi as resolveImportSplitLevel,
   gi as resolveSplitLevel,
   hi as retargetFragment,
   xi as retargetFragmentToDepth,
   fi as retargetImport,
-  Wi as routeEngine,
+  Ui as routeEngine,
   He as runConversionInWorker,
   ki as sanitizeRef,
-  qe as scoreSnippetFormats,
-  yi as serializeForDestination,
-  qi as serializeInsertFiles,
+  ye as scoreSnippetFormats,
+  qi as serializeForDestination,
+  yi as serializeInsertFiles,
   lt as serializeInsertToRecords,
   vi as serializeProjectToFiles,
   st as serializeProjectToPlusPayload,
   Ee as serializeProjectToRecords,
   wi as shiftLadderTag,
   Ti as suggestSplitLevel,
-  Ki as unsupportedFileMessage,
+  Hi as unsupportedFileMessage,
   ze as wrapLooseParagraphs
 };

package/dist/lib/engine-routing.d.ts

@@ -21,6 +21,8 @@ export interface RoutableEngine {
     description?: string;
     /** Extensions this engine accepts, with leading dots. */
     acceptExtensions?: string[];
+    /** Set when the engine is experimental; see `ImportEngine.experimentalNotice`. */
+    experimentalNotice?: string;
 }
 /** File extensions accepted by the built-in converter. */
 export declare const DEFAULT_ACCEPT_EXTENSIONS: string[];
@@ -61,5 +63,16 @@ export declare function routeEngine<T extends RoutableEngine>(engines: T[], file
  * to be told which is which.
  */
 export declare function alternateFor<T extends RoutableEngine>(engines: T[], fileName: string): T | undefined;
+/**
+ * The engines the host marked experimental, in list order. Their notices are
+ * worth showing before any file is chosen, since a file converts the moment
+ * it is dropped.
+ */
+export declare function experimentalEngines<T extends RoutableEngine>(engines: T[]): T[];
+/**
+ * The engine an upload goes to, when that engine is experimental, or
+ * `undefined` when it goes to a dependable one or to none at all.
+ */
+export declare function experimentalEngineFor<T extends RoutableEngine>(engines: T[], fileName: string): T | undefined;
 /** The message shown when no engine can read the file the author chose. */
 export declare function unsupportedFileMessage(fileName: string, engines: RoutableEngine[]): string;

package/dist/react/import-wizard.d.ts

@@ -42,6 +42,14 @@ export interface ImportEngine {
     description?: string;
     /** Extensions this engine accepts (with leading dot). Defaults to the built-in set. */
     acceptExtensions?: string[];
+    /**
+     * Marks a converter whose results are not yet dependable, in the host's own
+     * words — say, "Conversion from Word uses pandoc and is still experimental."
+     * The wizard shows it on the upload step, since a file converts the moment
+     * it is dropped, and again beside any result or failure this engine
+     * produces, where it also offers the host's `shareConversion`.
+     */
+    experimentalNotice?: string;
     /** Convert an uploaded file into an import result. */
     convertFile: (file: File, options: ImportProjectOptions) => Promise<ImportedProjectResult>;
     /** Unpack and survey an upload without converting it. */
@@ -62,6 +70,35 @@ export interface ImportEngine {
      */
     cancel?: () => void;
 }
+/**
+ * A conversion by an experimental engine, handed to the host when the author
+ * chooses to share it (see `ImportWizardProps.shareConversion`).
+ */
+export interface ConversionShare {
+    /** The upload exactly as the author chose it. */
+    file: File;
+    /** `id` of the engine that converted it. */
+    engineId: string;
+    /** `label` of the engine that converted it. */
+    engineLabel: string;
+    /** The converted PreTeXt (`pretextSource`), before any re-layout. Absent on failure. */
+    pretext?: string;
+    /** Why the conversion failed. Absent on success. */
+    error?: string;
+}
+/** The host's offer to receive conversions an author chooses to share. */
+export interface ShareConversionOffer {
+    /** Text of the share button. Defaults to "Share this conversion". */
+    label?: string;
+    /** A line before the button saying where the conversion goes and why. */
+    description?: string;
+    /**
+     * Receives the conversion. The wizard waits on it to show "Sharing…" and
+     * then "Shared"; a rejection is shown beside the button, which stays
+     * available so the author can try again.
+     */
+    onShare: (share: ConversionShare) => void | Promise<void>;
+}
 export interface ImportWizardProps {
     /**
      * Called when the user confirms the import. May return a promise — writing
@@ -102,6 +139,14 @@ export interface ImportWizardProps {
      * lets the author move the attach level and see the result before confirming.
      */
     insertTarget?: InsertTargetOffer;
+    /**
+     * Let the author send a conversion by an experimental engine (one with an
+     * `experimentalNotice`) to the host — its developers, say — so they can see
+     * where that converter falls short. Offered after the fact, beside the result
+     * or the failure, so the author decides having seen what came out. Omit it
+     * and the notice is shown without the offer.
+     */
+    shareConversion?: ShareConversionOffer;
 }
 /** What the host knows about the document an import is being inserted into. */
 export interface InsertTargetOffer {
@@ -124,4 +169,4 @@ export interface InsertTargetOffer {
      */
     externalDir?: string;
 }
-export declare function ImportWizard({ onConfirm, onCancel, importOptions, defaultDocumentKind, defaultImportMode, lockImportMode, onImportModeChange, engines, insertTarget, }: ImportWizardProps): import("react").JSX.Element;
+export declare function ImportWizard({ onConfirm, onCancel, importOptions, defaultDocumentKind, defaultImportMode, lockImportMode, onImportModeChange, engines, insertTarget, shareConversion, }: ImportWizardProps): import("react").JSX.Element;

package/dist/react/index.d.ts

@@ -1,5 +1,5 @@
 export { ImportWizard } from './import-wizard';
-export type { ImportWizardProps, ImportMode, ImportEngine, InsertTargetOffer, PreparedUpload, } from './import-wizard';
+export type { ImportWizardProps, ImportMode, ImportEngine, ConversionShare, ShareConversionOffer, InsertTargetOffer, PreparedUpload, } from './import-wizard';
 export { ProcessingPanel } from './processing-panel';
 export type { ProcessingPanelProps } from './processing-panel';
 export { ImportSourceForm } from './import-source-form';