@pretextbook/schema 0.0.1

package/dist/completions.d.ts

@@ -0,0 +1,9 @@
+import { CompletionContext, CompletionItem } from './types';
+/**
+ * Context-aware completions driven by salve's `walker.possible()`. Handles two
+ * cases: completing an element name (in content, or after `<`) and completing an
+ * attribute name (inside an open start tag).
+ */
+export declare function getCompletions(context: CompletionContext): CompletionItem[];
+/** Clear cached completion walker state for a document (e.g. on close). */
+export declare function clearCompletionCache(uri?: string): void;

package/dist/grammar-CC9aP-iu.cjs

@@ -0,0 +1 @@
+"use strict";const a=require("salve-annos");function e(r){return a.readTreeFromJSON(r)}exports.loadGrammarFromJSON=e;

package/dist/grammar-CU0Faawl.js

@@ -0,0 +1,7 @@
+import { readTreeFromJSON as o } from "salve-annos";
+function a(r) {
+  return o(r);
+}
+export {
+  a as l
+};

package/dist/grammar.d.ts

@@ -0,0 +1,8 @@
+import { Grammar } from './types';
+/**
+ * Reconstruct a salve {@link Grammar} from a precompiled JSON tree (as produced
+ * by `writeTreeToJSON` at schema-refresh time). This is the runtime entry point:
+ * it is fast (~25 ms for the PreTeXt grammar) and, unlike {@link
+ * "./compile"}, does not pull in salve's RNG-conversion machinery.
+ */
+export declare function loadGrammarFromJSON(json: string): Grammar;

package/dist/index.cjs

@@ -0,0 +1,5 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const P=require("saxes"),K=require("path"),_=require("url"),G=require("salve-annos"),Z=require("./grammar-CC9aP-iu.cjs");function B(e){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const n in e)if(n!=="default"){const r=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(t,n,r.get?r:{enumerable:!0,get:()=>e[n]})}}return t.default=e,Object.freeze(t)}const L=B(K),M={Error:1,Warning:2,Information:3,Hint:4},C={source:"pretext",defaultSeverity:M.Error,rules:[{id:"element-me-removed",match:e=>e.kind==="element-not-allowed"&&e.name==="me",message:()=>"<me> should be replaced with <md> (without any <mrow>).",severity:M.Warning},{id:"element-not-allowed",match:e=>e.kind==="element-not-allowed",message:e=>`<${e.name??"element"}> is not allowed here.`+(e.alternatives&&e.alternatives.length?` Expected one of: ${R(e.alternatives)}.`:"")},{id:"attribute-not-allowed",match:e=>e.kind==="attribute-not-allowed",message:e=>`The attribute "${e.name??""}" is not allowed on this element.`},{id:"attribute-value-invalid",match:e=>e.kind==="attribute-value-invalid"},{id:"choice-not-satisfied",match:e=>e.kind==="choice-not-satisfied",message:e=>e.alternatives&&e.alternatives.length?`Missing required content. Expected one of: ${R(e.alternatives)}.`:e.message},{id:"text-not-allowed",match:e=>e.kind==="text-not-allowed",message:()=>"Text is not allowed here."},{id:"unexpected-end",match:e=>e.kind==="unexpected-end"},{id:"xinclude-missing",match:e=>e.kind==="xinclude-missing"},{id:"xinclude-circular",match:e=>e.kind==="xinclude-circular"},{id:"well-formedness",match:e=>e.kind==="well-formedness"},{id:"duplicate-id",match:e=>e.kind==="duplicate-id"},{id:"dangling-reference",match:e=>e.kind==="dangling-reference"}]},X=[{id:"allow-document-id",match:e=>e.kind==="element-not-allowed"&&e.name==="document-id"&&e.parent==="docinfo",suppress:!0},{id:"allow-blurb",match:e=>e.kind==="element-not-allowed"&&e.name==="blurb"&&e.parent==="docinfo",suppress:!0}],J={...C,rules:[...X,...C.rules]};function R(e){const t=[...new Set(e)],n=t.slice(0,12).map(r=>`<${r}>`);return t.length>n.length&&n.push(`… (${t.length-n.length} more)`),n.join(", ")}function F(e,t=C){const n=t.defaultSeverity??M.Error,r=t.source??"pretext",s=[];for(const a of e){const l=t.rules.find(o=>o.match(a));l?.suppress||s.push({range:a.range,severity:l?.severity??n,code:l?.id,source:r,message:l?.message?l.message(a):a.message})}return s}const Q=/<xi:include\b[^>]*?\bhref\s*=\s*("|')(.*?)\1[^>]*?\/>/;function T(){const e=require("fs");return t=>{try{return e.readFileSync(t,"utf8")}catch{return}}}function Y(e){const t=e.match(/^?\s*<\?xml\b.*?\?>/s);if(!t)return{text:e,removedLines:0};const n=t[0],r=(n.match(/\n/g)??[]).length;return{text:e.slice(n.length),removedLines:r}}function ee(e){return e.startsWith("file:")?_.fileURLToPath(e):e}function te(e){return _.pathToFileURL(e).toString()}function W(e,t,n=T()){const r=[];function s(o,h,b){const d=o.split(`
+`),m=[],p=[];for(let w=0;w<d.length;w++){const v=d[w],y=Q.exec(v);if(!y){m.push(v),p.push({uri:h,line:w,columnShift:0});continue}const S=v.slice(0,y.index),N=v.slice(y.index+y[0].length),i=y[2],c=L.dirname(ee(h)),u=L.resolve(c,i),f=te(u);if(S.length>0&&(m.push(S),p.push({uri:h,line:w,columnShift:0})),b.includes(f))r.push({kind:"xinclude-circular",message:`Circular xi:include detected for "${i}".`,uri:h,line:w,column:y.index,length:y[0].length});else{const x=n(u);if(x===void 0)r.push({kind:"xinclude-missing",message:`Cannot resolve xi:include target "${i}".`,uri:h,line:w,column:y.index,length:y[0].length});else{const A=Y(x),g=s(A.text,f,[...b,f]);for(let E=0;E<g.lines.length;E++)m.push(g.lines[E]),p.push(g.origin[E])}}N.trim().length>0&&(m.push(N),p.push({uri:h,line:w,columnShift:0}))}return{lines:m,origin:p}}const{lines:a,origin:l}=s(e,t,[t]);return{text:a.join(`
+`),origin:l,problems:r}}const ne="http://www.w3.org/2000/xmlns/",re="http://www.w3.org/XML/1998/namespace",se={xref:["ref","first","last"],fragref:["ref"]};function ae(e,t,n={}){const r=n.uri??"untitled:document",s=n.ruleset??C,a=n.resolveXIncludes??!0,l=n.readFile??T();q(n.signal);let o=e,h;const b=[];if(a&&/<xi:include\b/.test(e)){const d=W(e,r,l);o=d.text,h=d.origin;for(const m of d.problems)b.push({kind:m.kind,message:m.message,uri:m.uri,range:ce(m.line,m.column,m.length)})}return b.push(...ie(o,t,r,h,n.signal)),oe(b,r,s)}function ie(e,t,n,r,s){const a=t.newWalker(),l=[],o=new P.SaxesParser({xmlns:!0,position:!0}),h=new Set,b=[];let d=0;const m=[];let p=null;const w=(i,c)=>{if(!r)return{uri:n,line:i,char:c};const u=r[i]??r[r.length-1];return u?{uri:u.uri,line:u.line,char:Math.max(0,c-u.columnShift)}:{uri:n,line:i,char:c}},v=(i,c,u)=>{const f=w(i,c),x=w(i,u);return{uri:f.uri,range:{start:{line:f.line,character:Math.max(0,f.char)},end:{line:x.line,character:Math.max(f.char,x.char)}}}},y=(i,c)=>{const u=m.length?[...m]:void 0,f=m.length?m[m.length-1]:void 0;for(const x of i){const A=le(x);l.push({...A,parent:f,ancestors:u,uri:c.uri,range:c.range})}},S=(i,c,u)=>{const f=a.fireEvent(i,c);Array.isArray(f)&&y(f,u)};o.on("opentagstart",i=>{const c=o.line-1,u=o.column-1,f=u-i.name.length,x=Math.max(0,f-1);p={line:c,char:x,length:u-x}}),o.on("opentag",i=>{d++;const c=p??{line:o.line-1,char:Math.max(0,o.column-1),length:1},u=v(c.line,c.char,c.char+c.length);S("enterStartTag",[i.uri??"",i.local??i.name],u);const f=i.local??i.name;m.push(f);const x=se[f];for(const A of Object.keys(i.attributes)){const g=i.attributes[A];if(g.prefix==="xmlns"||g.name==="xmlns"||g.uri===ne)continue;const E=g.local??g.name;g.uri===re&&E==="id"?h.has(g.value)?l.push({kind:"duplicate-id",message:`The xml:id "${g.value}" is already used elsewhere in this document.`,name:g.value,parent:f,ancestors:[...m],uri:u.uri,range:u.range}):h.add(g.value):x?.includes(E)&&b.push({value:g.value,loc:u,parent:f,ancestors:[...m]}),S("attributeName",[g.uri??"",g.local??g.name],u),S("attributeValue",[g.value],u)}S("leaveStartTag",[],u)}),o.on("closetag",i=>{const c=o.line-1,u=Math.max(0,o.column-1),f=v(c,Math.max(0,u-1),u);S("endTag",[i.uri??"",i.local??i.name],f),m.pop(),d=Math.max(0,d-1)}),o.on("text",i=>{if(d===0||i.length===0)return;const c=o.line-1,u=Math.max(0,o.column-1),f=Math.max(0,u-ue(i)),x=v(c,f,u);S("text",[i],x)}),o.on("error",i=>{const c=o.line-1,u=Math.max(0,o.column-1),f=w(c,u);l.push({kind:"well-formedness",message:i.message,parent:m.length?m[m.length-1]:void 0,ancestors:m.length?[...m]:void 0,uri:f.uri,range:{start:{line:f.line,character:f.char},end:{line:f.line,character:f.char+1}}})});try{for(let c=0;c<e.length;c+=65536)q(s),o.write(e.slice(c,c+65536));o.close()}catch(i){if(de(i))throw i}const N=a.end();if(Array.isArray(N)&&N.length){const i=Math.max(0,me(e)-1),c=v(i,0,1);y(N,c)}for(const i of b)h.has(i.value)||l.push({kind:"dangling-reference",message:`No element with xml:id "${i.value}" exists in this document.`,name:i.value,parent:i.parent,ancestors:i.ancestors,uri:i.loc.uri,range:i.loc.range});return l}function oe(e,t,n){const r=new Map;for(const a of e){const l=r.get(a.uri)??[];l.push(a),r.set(a.uri,l)}const s={};for(const[a,l]of r)s[a]=F(l,n);return s[t]||(s[t]=[]),{diagnostics:s[t],diagnosticsByUri:s}}function le(e){const t=e,n=t.constructor?.name??"",r=t.msg??t.toString();let s="other";switch(n){case"ElementNameError":s="element-not-allowed";break;case"AttributeNameError":s="attribute-not-allowed";break;case"AttributeValueError":s="attribute-value-invalid";break;case"ChoiceError":s="choice-not-satisfied";break;default:/text (is )?not allowed/i.test(r)?s="text-not-allowed":/must choose|tag required|incomplete|nothing else may follow/i.test(r)&&(s="choice-not-satisfied")}const a=O(t.name),l=s==="choice-not-satisfied"&&typeof t.getNames=="function"?[...new Set(t.getNames().flatMap(o=>O(o)))]:void 0;return{kind:s,message:r,name:a[0],alternatives:l&&l.length?l:void 0}}function O(e){if(!e||typeof e!="object")return[];const t=e;if(typeof t.toArray=="function"){const r=t.toArray();if(r)return r.map(s=>s.name??s.toObject?.().name).filter(s=>typeof s=="string")}const n=t.toObject?.();return n&&typeof n.name=="string"?[n.name]:typeof t.name=="string"?[t.name]:[]}function ce(e,t,n){return{start:{line:e,character:t},end:{line:e,character:t+n}}}function ue(e){const t=e.lastIndexOf(`
+`);return t===-1?e.length:e.length-t-1}function me(e){let t=1;for(let n=0;n<e.length;n++)e.charCodeAt(n)===10&&t++;return t}function q(e){if(e?.aborted)throw fe()}function fe(){const e=new Error("Validation aborted");return e.name="AbortError",e}function de(e){return e instanceof Error&&e.name==="AbortError"}const D={Class:7,Property:10},he="http://www.w3.org/2000/xmlns/",j={"http://www.w3.org/XML/1998/namespace":"xml","http://www.w3.org/2001/XInclude":"xi"};function z(e,t){return e&&j[e]?`${j[e]}:${t}`:t}function ge(e){const{text:t,position:n,grammar:r,uri:s}=e,a=Se(t,n),l=t.slice(0,a),o=l.lastIndexOf("<"),h=l.lastIndexOf(">");if(!(o>h))return $(r,l,"",s);const d=l.slice(o);if(d.startsWith("</")||d.startsWith("<!")||d.startsWith("<?"))return[];const p=d.match(/^<([A-Za-z_][\w.:-]*)?/)?.[1]??"",w=d.slice(1+p.length);if(!/\s/.test(w))return $(r,l.slice(0,o),p,s);const v=ve(d);return v===null?[]:pe(r,l.slice(0,o),p,d,v,s)}function $(e,t,n,r){const s=U(e,t,r);if(!s)return[];const a=V(s.possible(),"enterStartTag");return H(a,n,D.Class)}function pe(e,t,n,r,s,a){const l=U(e,t,a);if(!l)return[];const o=l.clone(),h=o.fireEvent("enterStartTag",["",n]);if(Array.isArray(h))return[];const b=new Set(ye(r).map(p=>p.name)),d=o.possibleAttributes?o.possibleAttributes():o.possible(),m=V(d,"attributeName").filter(p=>!b.has(z(p.ns,p.name)));return H(m,s,D.Property)}class we{grammar;walker;parser;prefix="";depth=0;failed=!1;constructor(t){this.grammar=t,this.walker=t.newWalker(new G.DefaultNameResolver),this.parser=new P.SaxesParser({xmlns:!0,position:!0});const n=(r,s)=>{this.failed||this.walker.fireEvent(r,s)};this.parser.on("opentag",r=>{this.depth++,n("enterStartTag",[r.uri??"",r.local??r.name]);for(const s of Object.keys(r.attributes)){const a=r.attributes[s];a.prefix==="xmlns"||a.name==="xmlns"||a.uri===he||(n("attributeName",[a.uri??"",a.local??a.name]),n("attributeValue",[a.value]))}n("leaveStartTag",[])}),this.parser.on("closetag",r=>{n("endTag",[r.uri??"",r.local??r.name]),this.depth=Math.max(0,this.depth-1)}),this.parser.on("text",r=>{this.depth>0&&r.length>0&&n("text",[r])}),this.parser.on("error",()=>{this.failed=!0})}feed(t){try{this.parser.write(t)}catch{}this.prefix+=t}}const xe=20,k=new Map;function I(e,t){if(k.delete(e),k.set(e,t),k.size>xe){const n=k.keys().next().value;n!==void 0&&k.delete(n)}}function U(e,t,n){if(n){const s=k.get(n);if(s&&s.grammar===e&&t.startsWith(s.prefix)){const a=t.slice(s.prefix.length);return a.length>0&&s.feed(a),I(n,s),s.walker}}const r=new we(e);return r.feed(t),n&&I(n,r),r.walker}function be(e){e?k.delete(e):k.clear()}function V(e,t){const n=new Set,r=[];for(const s of e){if(s.name!==t||!s.namePattern)continue;const a=s.namePattern.toArray?.(),l=a||(s.namePattern.toObject?[s.namePattern.toObject()]:[]);for(const o of l){if(!o||typeof o.name!="string")continue;const h=`${o.ns??""}:${o.name}`;n.has(h)||(n.add(h),r.push(o))}}return r}function H(e,t,n){const r=t.toLowerCase();return e.map(s=>({display:z(s.ns,s.name),doc:s.documentation})).filter(s=>s.display.toLowerCase().startsWith(r)).sort((s,a)=>s.display.localeCompare(a.display)).map(s=>{const a={label:s.display,kind:n};return s.doc&&(a.documentation=s.doc),a})}function ve(e){const t=e.replace(/^<[\w.:-]*/,"");let n=!1,r="";for(let a=0;a<t.length;a++){const l=t[a];n?l===r&&(n=!1):(l==='"'||l==="'")&&(n=!0,r=l)}return n?null:e.match(/([A-Za-z_][\w.:-]*)?$/)?.[1]??""}function ye(e){const t=[],n=/([A-Za-z_][\w.:-]*)\s*=\s*("([^"]*)"|'([^']*)')/g;let r;for(;(r=n.exec(e))!==null;)t.push({name:r[1],value:r[3]??r[4]??""});return t}function Se(e,t){let n=0,r=0;for(;n<t.line;){const s=e.indexOf(`
+`,r);if(s===-1)return e.length;r=s+1,n++}return Math.min(e.length,r+t.character)}exports.loadGrammarFromJSON=Z.loadGrammarFromJSON;exports.Severity=M;exports.applyRules=F;exports.clearCompletionCache=be;exports.defaultFileReader=T;exports.defaultRuleset=C;exports.getCompletions=ge;exports.relaxedRules=X;exports.relaxedRuleset=J;exports.resolveXIncludes=W;exports.validateDocument=ae;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { validateDocument } from './validate';
+export { getCompletions, clearCompletionCache } from './completions';
+export { loadGrammarFromJSON } from './grammar';
+export { applyRules, defaultRuleset, relaxedRuleset, relaxedRules, Severity, } from './rules';
+export { resolveXIncludes, defaultFileReader, type OriginEntry, type IncludeProblem, type ResolvedDocument, } from './xinclude';
+export type { Grammar, Diagnostic, CompletionItem, CompletionContext, Range, Position, SchemaError, SchemaErrorKind, Rule, Ruleset, DiagnosticSeverityValue, FileReader, ValidateOptions, ValidationResult, } from './types';

package/dist/index.js

@@ -0,0 +1,577 @@
+import { SaxesParser as W } from "saxes";
+import * as L from "path";
+import { fileURLToPath as U, pathToFileURL as V } from "url";
+import { DefaultNameResolver as z } from "salve-annos";
+import { l as Ne } from "./grammar-CU0Faawl.js";
+const C = {
+  Error: 1,
+  Warning: 2,
+  Information: 3,
+  Hint: 4
+}, M = {
+  source: "pretext",
+  defaultSeverity: C.Error,
+  rules: [
+    {
+      id: "element-me-removed",
+      match: (e) => e.kind === "element-not-allowed" && e.name === "me",
+      message: () => "<me> should be replaced with <md> (without any <mrow>).",
+      severity: C.Warning
+    },
+    {
+      id: "element-not-allowed",
+      match: (e) => e.kind === "element-not-allowed",
+      message: (e) => `<${e.name ?? "element"}> is not allowed here.` + (e.alternatives && e.alternatives.length ? ` Expected one of: ${T(e.alternatives)}.` : "")
+    },
+    {
+      id: "attribute-not-allowed",
+      match: (e) => e.kind === "attribute-not-allowed",
+      message: (e) => `The attribute "${e.name ?? ""}" is not allowed on this element.`
+    },
+    {
+      id: "attribute-value-invalid",
+      match: (e) => e.kind === "attribute-value-invalid"
+    },
+    {
+      id: "choice-not-satisfied",
+      match: (e) => e.kind === "choice-not-satisfied",
+      message: (e) => e.alternatives && e.alternatives.length ? `Missing required content. Expected one of: ${T(
+        e.alternatives
+      )}.` : e.message
+    },
+    {
+      id: "text-not-allowed",
+      match: (e) => e.kind === "text-not-allowed",
+      message: () => "Text is not allowed here."
+    },
+    {
+      id: "unexpected-end",
+      match: (e) => e.kind === "unexpected-end"
+    },
+    {
+      id: "xinclude-missing",
+      match: (e) => e.kind === "xinclude-missing"
+    },
+    {
+      id: "xinclude-circular",
+      match: (e) => e.kind === "xinclude-circular"
+    },
+    {
+      id: "well-formedness",
+      match: (e) => e.kind === "well-formedness"
+    },
+    {
+      id: "duplicate-id",
+      match: (e) => e.kind === "duplicate-id"
+    },
+    {
+      id: "dangling-reference",
+      match: (e) => e.kind === "dangling-reference"
+    }
+  ]
+}, H = [
+  {
+    // <document-id> is used by some publishers / build pipelines inside
+    // <docinfo> but isn't in the stable schema yet.
+    id: "allow-document-id",
+    match: (e) => e.kind === "element-not-allowed" && e.name === "document-id" && e.parent === "docinfo",
+    suppress: !0
+  },
+  {
+    // <blurb> inside <docinfo> (short description used by some output formats).
+    id: "allow-blurb",
+    match: (e) => e.kind === "element-not-allowed" && e.name === "blurb" && e.parent === "docinfo",
+    suppress: !0
+  }
+], ve = {
+  ...M,
+  rules: [...H, ...M.rules]
+};
+function T(e) {
+  const t = [...new Set(e)], r = t.slice(0, 12).map((n) => `<${n}>`);
+  return t.length > r.length && r.push(`… (${t.length - r.length} more)`), r.join(", ");
+}
+function K(e, t = M) {
+  const r = t.defaultSeverity ?? C.Error, n = t.source ?? "pretext", s = [];
+  for (const a of e) {
+    const l = t.rules.find((o) => o.match(a));
+    l?.suppress || s.push({
+      range: a.range,
+      severity: l?.severity ?? r,
+      code: l?.id,
+      source: n,
+      message: l?.message ? l.message(a) : a.message
+    });
+  }
+  return s;
+}
+const Z = /<xi:include\b[^>]*?\bhref\s*=\s*("|')(.*?)\1[^>]*?\/>/;
+function X() {
+  const e = require("fs");
+  return (t) => {
+    try {
+      return e.readFileSync(t, "utf8");
+    } catch {
+      return;
+    }
+  };
+}
+function B(e) {
+  const t = e.match(/^?\s*<\?xml\b.*?\?>/s);
+  if (!t)
+    return { text: e, removedLines: 0 };
+  const r = t[0], n = (r.match(/\n/g) ?? []).length;
+  return { text: e.slice(r.length), removedLines: n };
+}
+function G(e) {
+  return e.startsWith("file:") ? U(e) : e;
+}
+function J(e) {
+  return V(e).toString();
+}
+function Q(e, t, r = X()) {
+  const n = [];
+  function s(o, d, b) {
+    const h = o.split(`
+`), m = [], p = [];
+    for (let w = 0; w < h.length; w++) {
+      const v = h[w], y = Z.exec(v);
+      if (!y) {
+        m.push(v), p.push({ uri: d, line: w, columnShift: 0 });
+        continue;
+      }
+      const k = v.slice(0, y.index), A = v.slice(y.index + y[0].length), i = y[2], c = L.dirname(G(d)), u = L.resolve(c, i), f = J(u);
+      if (k.length > 0 && (m.push(k), p.push({ uri: d, line: w, columnShift: 0 })), b.includes(f))
+        n.push({
+          kind: "xinclude-circular",
+          message: `Circular xi:include detected for "${i}".`,
+          uri: d,
+          line: w,
+          column: y.index,
+          length: y[0].length
+        });
+      else {
+        const x = r(u);
+        if (x === void 0)
+          n.push({
+            kind: "xinclude-missing",
+            message: `Cannot resolve xi:include target "${i}".`,
+            uri: d,
+            line: w,
+            column: y.index,
+            length: y[0].length
+          });
+        else {
+          const N = B(x), g = s(N.text, f, [...b, f]);
+          for (let E = 0; E < g.lines.length; E++)
+            m.push(g.lines[E]), p.push(g.origin[E]);
+        }
+      }
+      A.trim().length > 0 && (m.push(A), p.push({ uri: d, line: w, columnShift: 0 }));
+    }
+    return { lines: m, origin: p };
+  }
+  const { lines: a, origin: l } = s(e, t, [t]);
+  return { text: a.join(`
+`), origin: l, problems: n };
+}
+const Y = "http://www.w3.org/2000/xmlns/", ee = "http://www.w3.org/XML/1998/namespace", te = {
+  xref: ["ref", "first", "last"],
+  fragref: ["ref"]
+};
+function ye(e, t, r = {}) {
+  const n = r.uri ?? "untitled:document", s = r.ruleset ?? M, a = r.resolveXIncludes ?? !0, l = r.readFile ?? X();
+  j(r.signal);
+  let o = e, d;
+  const b = [];
+  if (a && /<xi:include\b/.test(e)) {
+    const h = Q(e, n, l);
+    o = h.text, d = h.origin;
+    for (const m of h.problems)
+      b.push({
+        kind: m.kind,
+        message: m.message,
+        uri: m.uri,
+        range: ae(m.line, m.column, m.length)
+      });
+  }
+  return b.push(...ne(o, t, n, d, r.signal)), re(b, n, s);
+}
+function ne(e, t, r, n, s) {
+  const a = t.newWalker(), l = [], o = new W({
+    xmlns: !0,
+    position: !0
+  }), d = /* @__PURE__ */ new Set(), b = [];
+  let h = 0;
+  const m = [];
+  let p = null;
+  const w = (i, c) => {
+    if (!n)
+      return { uri: r, line: i, char: c };
+    const u = n[i] ?? n[n.length - 1];
+    return u ? {
+      uri: u.uri,
+      line: u.line,
+      char: Math.max(0, c - u.columnShift)
+    } : { uri: r, line: i, char: c };
+  }, v = (i, c, u) => {
+    const f = w(i, c), x = w(i, u);
+    return {
+      uri: f.uri,
+      range: {
+        start: { line: f.line, character: Math.max(0, f.char) },
+        end: { line: x.line, character: Math.max(f.char, x.char) }
+      }
+    };
+  }, y = (i, c) => {
+    const u = m.length ? [...m] : void 0, f = m.length ? m[m.length - 1] : void 0;
+    for (const x of i) {
+      const N = se(x);
+      l.push({
+        ...N,
+        parent: f,
+        ancestors: u,
+        uri: c.uri,
+        range: c.range
+      });
+    }
+  }, k = (i, c, u) => {
+    const f = a.fireEvent(i, c);
+    Array.isArray(f) && y(f, u);
+  };
+  o.on("opentagstart", (i) => {
+    const c = o.line - 1, u = o.column - 1, f = u - i.name.length, x = Math.max(0, f - 1);
+    p = { line: c, char: x, length: u - x };
+  }), o.on("opentag", (i) => {
+    h++;
+    const c = p ?? {
+      line: o.line - 1,
+      char: Math.max(0, o.column - 1),
+      length: 1
+    }, u = v(c.line, c.char, c.char + c.length);
+    k("enterStartTag", [i.uri ?? "", i.local ?? i.name], u);
+    const f = i.local ?? i.name;
+    m.push(f);
+    const x = te[f];
+    for (const N of Object.keys(i.attributes)) {
+      const g = i.attributes[N];
+      if (g.prefix === "xmlns" || g.name === "xmlns" || g.uri === Y)
+        continue;
+      const E = g.local ?? g.name;
+      g.uri === ee && E === "id" ? d.has(g.value) ? l.push({
+        kind: "duplicate-id",
+        message: `The xml:id "${g.value}" is already used elsewhere in this document.`,
+        name: g.value,
+        parent: f,
+        ancestors: [...m],
+        uri: u.uri,
+        range: u.range
+      }) : d.add(g.value) : x?.includes(E) && b.push({
+        value: g.value,
+        loc: u,
+        parent: f,
+        ancestors: [...m]
+      }), k("attributeName", [g.uri ?? "", g.local ?? g.name], u), k("attributeValue", [g.value], u);
+    }
+    k("leaveStartTag", [], u);
+  }), o.on("closetag", (i) => {
+    const c = o.line - 1, u = Math.max(0, o.column - 1), f = v(c, Math.max(0, u - 1), u);
+    k("endTag", [i.uri ?? "", i.local ?? i.name], f), m.pop(), h = Math.max(0, h - 1);
+  }), o.on("text", (i) => {
+    if (h === 0 || i.length === 0)
+      return;
+    const c = o.line - 1, u = Math.max(0, o.column - 1), f = Math.max(0, u - ie(i)), x = v(c, f, u);
+    k("text", [i], x);
+  }), o.on("error", (i) => {
+    const c = o.line - 1, u = Math.max(0, o.column - 1), f = w(c, u);
+    l.push({
+      kind: "well-formedness",
+      message: i.message,
+      parent: m.length ? m[m.length - 1] : void 0,
+      ancestors: m.length ? [...m] : void 0,
+      uri: f.uri,
+      range: {
+        start: { line: f.line, character: f.char },
+        end: { line: f.line, character: f.char + 1 }
+      }
+    });
+  });
+  try {
+    for (let c = 0; c < e.length; c += 65536)
+      j(s), o.write(e.slice(c, c + 65536));
+    o.close();
+  } catch (i) {
+    if (ce(i))
+      throw i;
+  }
+  const A = a.end();
+  if (Array.isArray(A) && A.length) {
+    const i = Math.max(0, oe(e) - 1), c = v(i, 0, 1);
+    y(A, c);
+  }
+  for (const i of b)
+    d.has(i.value) || l.push({
+      kind: "dangling-reference",
+      message: `No element with xml:id "${i.value}" exists in this document.`,
+      name: i.value,
+      parent: i.parent,
+      ancestors: i.ancestors,
+      uri: i.loc.uri,
+      range: i.loc.range
+    });
+  return l;
+}
+function re(e, t, r) {
+  const n = /* @__PURE__ */ new Map();
+  for (const a of e) {
+    const l = n.get(a.uri) ?? [];
+    l.push(a), n.set(a.uri, l);
+  }
+  const s = {};
+  for (const [a, l] of n)
+    s[a] = K(l, r);
+  return s[t] || (s[t] = []), { diagnostics: s[t], diagnosticsByUri: s };
+}
+function se(e) {
+  const t = e, r = t.constructor?.name ?? "", n = t.msg ?? t.toString();
+  let s = "other";
+  switch (r) {
+    case "ElementNameError":
+      s = "element-not-allowed";
+      break;
+    case "AttributeNameError":
+      s = "attribute-not-allowed";
+      break;
+    case "AttributeValueError":
+      s = "attribute-value-invalid";
+      break;
+    case "ChoiceError":
+      s = "choice-not-satisfied";
+      break;
+    default:
+      /text (is )?not allowed/i.test(n) ? s = "text-not-allowed" : /must choose|tag required|incomplete|nothing else may follow/i.test(n) && (s = "choice-not-satisfied");
+  }
+  const a = R(t.name), l = s === "choice-not-satisfied" && typeof t.getNames == "function" ? [...new Set(t.getNames().flatMap((o) => R(o)))] : void 0;
+  return {
+    kind: s,
+    message: n,
+    name: a[0],
+    alternatives: l && l.length ? l : void 0
+  };
+}
+function R(e) {
+  if (!e || typeof e != "object")
+    return [];
+  const t = e;
+  if (typeof t.toArray == "function") {
+    const n = t.toArray();
+    if (n)
+      return n.map((s) => s.name ?? s.toObject?.().name).filter((s) => typeof s == "string");
+  }
+  const r = t.toObject?.();
+  return r && typeof r.name == "string" ? [r.name] : typeof t.name == "string" ? [t.name] : [];
+}
+function ae(e, t, r) {
+  return {
+    start: { line: e, character: t },
+    end: { line: e, character: t + r }
+  };
+}
+function ie(e) {
+  const t = e.lastIndexOf(`
+`);
+  return t === -1 ? e.length : e.length - t - 1;
+}
+function oe(e) {
+  let t = 1;
+  for (let r = 0; r < e.length; r++)
+    e.charCodeAt(r) === 10 && t++;
+  return t;
+}
+function j(e) {
+  if (e?.aborted)
+    throw le();
+}
+function le() {
+  const e = new Error("Validation aborted");
+  return e.name = "AbortError", e;
+}
+function ce(e) {
+  return e instanceof Error && e.name === "AbortError";
+}
+const P = {
+  Class: 7,
+  Property: 10
+}, ue = "http://www.w3.org/2000/xmlns/", $ = {
+  "http://www.w3.org/XML/1998/namespace": "xml",
+  "http://www.w3.org/2001/XInclude": "xi"
+};
+function _(e, t) {
+  return e && $[e] ? `${$[e]}:${t}` : t;
+}
+function ke(e) {
+  const { text: t, position: r, grammar: n, uri: s } = e, a = pe(t, r), l = t.slice(0, a), o = l.lastIndexOf("<"), d = l.lastIndexOf(">");
+  if (!(o > d))
+    return I(n, l, "", s);
+  const h = l.slice(o);
+  if (h.startsWith("</") || h.startsWith("<!") || h.startsWith("<?"))
+    return [];
+  const p = h.match(/^<([A-Za-z_][\w.:-]*)?/)?.[1] ?? "", w = h.slice(1 + p.length);
+  if (!/\s/.test(w))
+    return I(n, l.slice(0, o), p, s);
+  const v = de(h);
+  return v === null ? [] : me(
+    n,
+    l.slice(0, o),
+    p,
+    h,
+    v,
+    s
+  );
+}
+function I(e, t, r, n) {
+  const s = F(e, t, n);
+  if (!s)
+    return [];
+  const a = q(s.possible(), "enterStartTag");
+  return D(a, r, P.Class);
+}
+function me(e, t, r, n, s, a) {
+  const l = F(e, t, a);
+  if (!l)
+    return [];
+  const o = l.clone(), d = o.fireEvent("enterStartTag", ["", r]);
+  if (Array.isArray(d))
+    return [];
+  const b = new Set(
+    ge(n).map((p) => p.name)
+  ), h = o.possibleAttributes ? o.possibleAttributes() : o.possible(), m = q(h, "attributeName").filter(
+    (p) => !b.has(_(p.ns, p.name))
+  );
+  return D(m, s, P.Property);
+}
+class fe {
+  grammar;
+  walker;
+  parser;
+  prefix = "";
+  depth = 0;
+  failed = !1;
+  constructor(t) {
+    this.grammar = t, this.walker = t.newWalker(new z()), this.parser = new W({
+      xmlns: !0,
+      position: !0
+    });
+    const r = (n, s) => {
+      this.failed || this.walker.fireEvent(n, s);
+    };
+    this.parser.on("opentag", (n) => {
+      this.depth++, r("enterStartTag", [n.uri ?? "", n.local ?? n.name]);
+      for (const s of Object.keys(n.attributes)) {
+        const a = n.attributes[s];
+        a.prefix === "xmlns" || a.name === "xmlns" || a.uri === ue || (r("attributeName", [a.uri ?? "", a.local ?? a.name]), r("attributeValue", [a.value]));
+      }
+      r("leaveStartTag", []);
+    }), this.parser.on("closetag", (n) => {
+      r("endTag", [n.uri ?? "", n.local ?? n.name]), this.depth = Math.max(0, this.depth - 1);
+    }), this.parser.on("text", (n) => {
+      this.depth > 0 && n.length > 0 && r("text", [n]);
+    }), this.parser.on("error", () => {
+      this.failed = !0;
+    });
+  }
+  /** Feed additional text (assumed to directly follow what's already fed). */
+  feed(t) {
+    try {
+      this.parser.write(t);
+    } catch {
+    }
+    this.prefix += t;
+  }
+}
+const he = 20, S = /* @__PURE__ */ new Map();
+function O(e, t) {
+  if (S.delete(e), S.set(e, t), S.size > he) {
+    const r = S.keys().next().value;
+    r !== void 0 && S.delete(r);
+  }
+}
+function F(e, t, r) {
+  if (r) {
+    const s = S.get(r);
+    if (s && s.grammar === e && t.startsWith(s.prefix)) {
+      const a = t.slice(s.prefix.length);
+      return a.length > 0 && s.feed(a), O(r, s), s.walker;
+    }
+  }
+  const n = new fe(e);
+  return n.feed(t), r && O(r, n), n.walker;
+}
+function Se(e) {
+  e ? S.delete(e) : S.clear();
+}
+function q(e, t) {
+  const r = /* @__PURE__ */ new Set(), n = [];
+  for (const s of e) {
+    if (s.name !== t || !s.namePattern)
+      continue;
+    const a = s.namePattern.toArray?.(), l = a || (s.namePattern.toObject ? [s.namePattern.toObject()] : []);
+    for (const o of l) {
+      if (!o || typeof o.name != "string")
+        continue;
+      const d = `${o.ns ?? ""}:${o.name}`;
+      r.has(d) || (r.add(d), n.push(o));
+    }
+  }
+  return n;
+}
+function D(e, t, r) {
+  const n = t.toLowerCase();
+  return e.map((s) => ({ display: _(s.ns, s.name), doc: s.documentation })).filter((s) => s.display.toLowerCase().startsWith(n)).sort((s, a) => s.display.localeCompare(a.display)).map((s) => {
+    const a = {
+      label: s.display,
+      kind: r
+    };
+    return s.doc && (a.documentation = s.doc), a;
+  });
+}
+function de(e) {
+  const t = e.replace(/^<[\w.:-]*/, "");
+  let r = !1, n = "";
+  for (let a = 0; a < t.length; a++) {
+    const l = t[a];
+    r ? l === n && (r = !1) : (l === '"' || l === "'") && (r = !0, n = l);
+  }
+  return r ? null : e.match(/([A-Za-z_][\w.:-]*)?$/)?.[1] ?? "";
+}
+function ge(e) {
+  const t = [], r = /([A-Za-z_][\w.:-]*)\s*=\s*("([^"]*)"|'([^']*)')/g;
+  let n;
+  for (; (n = r.exec(e)) !== null; )
+    t.push({ name: n[1], value: n[3] ?? n[4] ?? "" });
+  return t;
+}
+function pe(e, t) {
+  let r = 0, n = 0;
+  for (; r < t.line; ) {
+    const s = e.indexOf(`
+`, n);
+    if (s === -1)
+      return e.length;
+    n = s + 1, r++;
+  }
+  return Math.min(e.length, n + t.character);
+}
+export {
+  C as Severity,
+  K as applyRules,
+  Se as clearCompletionCache,
+  X as defaultFileReader,
+  M as defaultRuleset,
+  ke as getCompletions,
+  Ne as loadGrammarFromJSON,
+  H as relaxedRules,
+  ve as relaxedRuleset,
+  Q as resolveXIncludes,
+  ye as validateDocument
+};

package/dist/rules.d.ts

@@ -0,0 +1,34 @@
+import { Diagnostic, DiagnosticSeverityValue, Rule, Ruleset, SchemaError } from './types';
+/** Numeric DiagnosticSeverity values (mirrors vscode-languageserver-types). */
+export declare const Severity: {
+    Error: DiagnosticSeverityValue;
+    Warning: DiagnosticSeverityValue;
+    Information: DiagnosticSeverityValue;
+    Hint: DiagnosticSeverityValue;
+};
+/**
+ * A small default ruleset. It mostly passes salve's errors through with a stable
+ * `code` and the `pretext` source, but rewrites the two most common structural
+ * errors into friendlier prose.
+ */
+export declare const defaultRuleset: Ruleset;
+/**
+ * Extra rules layered on top of the {@link defaultRuleset} in "relaxed"
+ * validation mode. Each entry suppresses a schema violation that PreTeXt authors
+ * commonly and legitimately hit but the stable schema does not (yet) permit.
+ *
+ * These are prepended before the generic pass-through rules so their `suppress`
+ * wins (rule matching stops at the first match). Add new relaxations here.
+ */
+export declare const relaxedRules: Rule[];
+/**
+ * The relaxed ruleset: the {@link defaultRuleset} with {@link relaxedRules}
+ * taking precedence, so the listed violations are silently ignored. Selected
+ * when the user opts into relaxed schema validation.
+ */
+export declare const relaxedRuleset: Ruleset;
+/**
+ * Turn raw {@link SchemaError}s into LSP {@link Diagnostic}s, applying the first
+ * matching rule's severity/message overrides and suppressions.
+ */
+export declare function applyRules(errors: SchemaError[], ruleset?: Ruleset): Diagnostic[];