@vendure-io/docs-provider 0.8.0 → 0.9.0

package/dist/apply-dates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apply-dates.d.ts","sourceRoot":"","sources":["../src/apply-dates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAgB7C;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,cAAc,EAAE,EAC5B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,OAAO,GAAE,6BAAkC,GAC1C,cAAc,EAAE,CAqClB"}
+{"version":3,"file":"apply-dates.d.ts","sourceRoot":"","sources":["../src/apply-dates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAgB7C;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,cAAc,EAAE,EAC5B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,OAAO,GAAE,6BAAkC,GAC1C,cAAc,EAAE,CAkElB"}

package/dist/generate-dates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-dates.d.ts","sourceRoot":"","sources":["../src/generate-dates.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;IAClB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,gDAAgD;IAChD,YAAY,EAAE,MAAM,CAAA;IACpB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;CACnB;AAgCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA6CvG"}
+{"version":3,"file":"generate-dates.d.ts","sourceRoot":"","sources":["../src/generate-dates.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;IAClB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,gDAAgD;IAChD,YAAY,EAAE,MAAM,CAAA;IACpB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;CACnB;AAgCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,mBAAmB,CAAC,CA6C9B"}

package/dist/index.cjs

@@ -1,9 +1,9 @@
-"use strict";var T=Object.defineProperty;var O=(e,t,r)=>t in e?T(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r;var w=(e,t,r)=>O(e,typeof t!="symbol"?t+"":t,r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./manifest-BkO3d77g.cjs"),h=require("./frontmatter-QFErVd9b.cjs"),d=require("./slug-utils-DUQgikEz.cjs"),N=require("fs"),y=require("path"),_=require("node:child_process"),U=require("node:util"),k=require("node:fs/promises"),x=require("node:path"),G=(e,t)=>e.order!==t.order?e.order-t.order:e.title.localeCompare(t.title);function H(e,t={}){const{extensions:r=[".mdx",".md"],filter:i,sort:n=G}=t,a=V(e,r);return(i?a.filter(i):a).sort(n).map(f=>({title:f.title,slug:f.slug,file:f.path}))}function z(e,t={}){return L(e,t,0)}function L(e,t,r){const{extensions:i=[".mdx",".md"],filter:n,sort:a=G,maxDepth:o=1/0,folderFilter:l}=t,f=N.readdirSync(e,{withFileTypes:!0}),u=[],p=V(e,i),D=(n?p.filter(n):p).sort(a);for(const m of D)u.push({title:m.title,slug:m.slug,file:m.path});if(r<o){const m=f.filter(g=>g.isDirectory());for(const g of m){if(l){const c=y.join(e,g.name);if(!l(g.name,c))continue}const F=y.join(e,g.name),v=L(F,t,r+1);if(v.length>0){const c=J(F,i);u.push({title:(c==null?void 0:c.title)||d.titleFromFilename(g.name),slug:d.slugFromFilename(g.name),file:c==null?void 0:c.path,children:v.filter(M=>!(c&&M.file===c.path))})}}}return u.sort((m,g)=>{var I,j;const F=D.find(b=>b.slug===m.slug),v=D.find(b=>b.slug===g.slug);if(F&&v)return a(F,v);const c=!!m.file&&!((I=m.children)!=null&&I.length),M=!!g.file&&!((j=g.children)!=null&&j.length);return c!==M?c?-1:1:(m.title||"").localeCompare(g.title||"")})}function V(e,t){try{const r=N.readdirSync(e,{withFileTypes:!0}),i=[];for(const n of r){if(!n.isFile())continue;const a=t.find(u=>n.name.toLowerCase().endsWith(u));if(!a||n.name.slice(0,-a.length).toLowerCase()==="index")continue;const l=y.join(e,n.name),f=W(l,n.name,a);i.push(f)}return i}catch{return[]}}function W(e,t,r){let i={},n=d.titleFromFilename(t),a=1/0;try{const o=N.readFileSync(e,"utf-8");i=h.extractFrontmatterData(o),i.title&&typeof i.title=="string"&&(n=i.title),typeof i.order=="number"&&(a=i.order)}catch{}return{path:e,filename:t,extension:r,frontmatter:i,order:a,title:n,slug:d.slugFromFilename(t)}}function J(e,t){for(const r of t){const i=y.join(e,`index${r}`);try{if(N.statSync(i).isFile())return W(i,`index${r}`,r)}catch{}}}class S extends Error{constructor(r,i,n,a){super(r);w(this,"nodePath");w(this,"filePath");w(this,"originalError");this.name="ManifestResolutionError",this.nodePath=i,this.filePath=n,this.originalError=a}}function K(e,t={}){const{strict:r=!0}=t,i=$(e.navigation,"",r);return{id:e.id,name:e.name,version:e.version,vendureVersion:e.vendureVersion,navigation:i,search:e.search,github:e.github,basePath:e.basePath}}function $(e,t,r){return e.map((i,n)=>Q(i,t,n,r))}function Q(e,t,r,i){const n=t?`${t}[${r}]`:`navigation[${r}]`;if(e.title&&e.slug)return{title:e.title,slug:e.slug,file:e.file,children:e.children?$(e.children,`${n}.children`,i):void 0,badge:e.badge,hidden:e.hidden};let a=e.title,o=e.slug;if(e.file&&(o||(o=d.slugFromFilename(e.file)),a||(a=X(e.file,n,i))),!a){if(i)throw new S(`Navigation node at ${n} is missing title and has no file to derive it from`,n,e.file);a=o||`Unknown (${r})`}if(!o){if(i)throw new S(`Navigation node at ${n} is missing slug and has no file to derive it from`,n,e.file);o=a?d.slugFromFilename(a):`node-${r}`}return{title:a,slug:o,file:e.file,children:e.children?$(e.children,`${n}.children`,i):void 0,badge:e.badge,hidden:e.hidden}}function X(e,t,r){try{const i=N.readFileSync(e,"utf-8"),n=h.extractFrontmatterData(i);return n.title&&typeof n.title=="string"?n.title:d.titleFromFilename(e)}catch(i){if(r)throw new S(`Failed to read file for title derivation at ${t}: ${e}`,t,e,i);return d.titleFromFilename(e)}}function Y(e){return R(e.navigation)}function R(e){for(const t of e)if(!t.title||!t.slug||t.children&&R(t.children))return!0;return!1}const q=U.promisify(_.exec);async function E(e=process.cwd()){try{return await q("git rev-parse --git-dir",{cwd:e}),!0}catch{return!1}}async function A(e,t={}){const r=t.cwd??process.cwd();try{const{stdout:i}=await q(`git log -1 --format=%cI -- "${e}"`,{cwd:r}),n=i.trim();return n||null}catch{return null}}async function B(e,t={}){const r=t.cwd??process.cwd(),i={},n=[];return await E(r)?(await Promise.all(e.map(async a=>{const o=await A(a,t);o?i[a]=o:n.push(a)})),{dates:i,skipped:n}):{dates:{},skipped:e}}async function Z(e,t){const r=[];async function i(n){const a=await k.readdir(n,{withFileTypes:!0});for(const o of a){const l=x.join(n,o.name);o.isDirectory()?!o.name.startsWith(".")&&o.name!=="node_modules"&&await i(l):o.isFile()&&t.some(u=>o.name.endsWith(u))&&r.push(l)}}return await i(e),r}async function ee(e){const{docsDir:t,outputPath:r,extensions:i=[".mdx",".md"]}=e,n=e.gitCwd??x.join(t,"..");if(!await E(n))return console.warn("Warning: Not a git repository. Generating empty dates file."),await C(r),{filesWithDates:0,filesSkipped:0,outputPath:r};const a=await Z(t,i);if(a.length===0)return console.warn(`Warning: No files found in ${t} with extensions ${i.join(", ")}`),await C(r),{filesWithDates:0,filesSkipped:0,outputPath:r};const o=a.map(p=>x.relative(n,p)),{dates:l,skipped:f}=await B(o,{cwd:n}),u=te(l);return await k.writeFile(r,u,"utf-8"),{filesWithDates:Object.keys(l).length,filesSkipped:f.length,outputPath:r}}async function C(e){const t=`// dates.generated.ts (auto-generated, do not edit)
+"use strict";var _=Object.defineProperty;var z=(e,t,r)=>t in e?_(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r;var y=(e,t,r)=>z(e,typeof t!="symbol"?t+"":t,r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./manifest-BkO3d77g.cjs"),F=require("./frontmatter-QFErVd9b.cjs"),u=require("./slug-utils-DUQgikEz.cjs"),w=require("fs"),S=require("path"),U=require("node:child_process"),H=require("node:util"),k=require("node:fs/promises"),x=require("node:path"),V=(e,t)=>e.order!==t.order?e.order-t.order:e.title.localeCompare(t.title);function J(e,t={}){const{extensions:r=[".mdx",".md"],filter:i,sort:n=V}=t,a=R(e,r);return(i?a.filter(i):a).sort(n).map(c=>({title:c.title,slug:c.slug,file:c.path}))}function K(e,t={}){return W(e,t,0)}function W(e,t,r){const{extensions:i=[".mdx",".md"],filter:n,sort:a=V,maxDepth:o=1/0,folderFilter:l}=t,c=w.readdirSync(e,{withFileTypes:!0}),d=[],m=R(e,i),p=(n?m.filter(n):m).sort(a);for(const h of p)d.push({title:h.title,slug:h.slug,file:h.path});if(r<o){const h=c.filter(g=>g.isDirectory());for(const g of h){if(l){const f=S.join(e,g.name);if(!l(g.name,f))continue}const v=S.join(e,g.name),N=W(v,t,r+1);if(N.length>0){const f=Q(v,i);d.push({title:(f==null?void 0:f.title)||u.titleFromFilename(g.name),slug:u.slugFromFilename(g.name),file:f==null?void 0:f.path,children:N.filter(b=>!(f&&b.file===f.path))})}}}return d.sort((h,g)=>{var j,C;const v=p.find(P=>P.slug===h.slug),N=p.find(P=>P.slug===g.slug);if(v&&N)return a(v,N);const f=!!h.file&&!((j=h.children)!=null&&j.length),b=!!g.file&&!((C=g.children)!=null&&C.length);return f!==b?f?-1:1:(h.title||"").localeCompare(g.title||"")})}function R(e,t){try{const r=w.readdirSync(e,{withFileTypes:!0}),i=[];for(const n of r){if(!n.isFile())continue;const a=t.find(d=>n.name.toLowerCase().endsWith(d));if(!a||n.name.slice(0,-a.length).toLowerCase()==="index")continue;const l=S.join(e,n.name),c=q(l,n.name,a);i.push(c)}return i}catch{return[]}}function q(e,t,r){let i={},n=u.titleFromFilename(t),a=1/0;try{const o=w.readFileSync(e,"utf-8");i=F.extractFrontmatterData(o),i.title&&typeof i.title=="string"&&(n=i.title),typeof i.order=="number"&&(a=i.order)}catch{}return{path:e,filename:t,extension:r,frontmatter:i,order:a,title:n,slug:u.slugFromFilename(t)}}function Q(e,t){for(const r of t){const i=S.join(e,`index${r}`);try{if(w.statSync(i).isFile())return q(i,`index${r}`,r)}catch{}}}class D extends Error{constructor(r,i,n,a){super(r);y(this,"nodePath");y(this,"filePath");y(this,"originalError");this.name="ManifestResolutionError",this.nodePath=i,this.filePath=n,this.originalError=a}}function X(e,t={}){const{strict:r=!0}=t,i=M(e.navigation,"",r);return{id:e.id,name:e.name,version:e.version,vendureVersion:e.vendureVersion,navigation:i,search:e.search,github:e.github,basePath:e.basePath}}function M(e,t,r){return e.map((i,n)=>Y(i,t,n,r))}function Y(e,t,r,i){const n=t?`${t}[${r}]`:`navigation[${r}]`;if(e.title&&e.slug)return{title:e.title,slug:e.slug,file:e.file,children:e.children?M(e.children,`${n}.children`,i):void 0,badge:e.badge,hidden:e.hidden};let a=e.title,o=e.slug;if(e.file&&(o||(o=u.slugFromFilename(e.file)),a||(a=Z(e.file,n,i))),!a){if(i)throw new D(`Navigation node at ${n} is missing title and has no file to derive it from`,n,e.file);a=o||`Unknown (${r})`}if(!o){if(i)throw new D(`Navigation node at ${n} is missing slug and has no file to derive it from`,n,e.file);o=a?u.slugFromFilename(a):`node-${r}`}return{title:a,slug:o,file:e.file,children:e.children?M(e.children,`${n}.children`,i):void 0,badge:e.badge,hidden:e.hidden}}function Z(e,t,r){try{const i=w.readFileSync(e,"utf-8"),n=F.extractFrontmatterData(i);return n.title&&typeof n.title=="string"?n.title:u.titleFromFilename(e)}catch(i){if(r)throw new D(`Failed to read file for title derivation at ${t}: ${e}`,t,e,i);return u.titleFromFilename(e)}}function ee(e){return A(e.navigation)}function A(e){for(const t of e)if(!t.title||!t.slug||t.children&&A(t.children))return!0;return!1}const B=H.promisify(U.exec);async function I(e=process.cwd()){try{return await B("git rev-parse --git-dir",{cwd:e}),!0}catch{return!1}}async function T(e,t={}){const r=t.cwd??process.cwd();try{const{stdout:i}=await B(`git log -1 --format=%cI -- "${e}"`,{cwd:r}),n=i.trim();return n||null}catch{return null}}async function O(e,t={}){const r=t.cwd??process.cwd(),i={},n=[];return await I(r)?(await Promise.all(e.map(async a=>{const o=await T(a,t);o?i[a]=o:n.push(a)})),{dates:i,skipped:n}):{dates:{},skipped:e}}async function te(e,t){const r=[];async function i(n){const a=await k.readdir(n,{withFileTypes:!0});for(const o of a){const l=x.join(n,o.name);o.isDirectory()?!o.name.startsWith(".")&&o.name!=="node_modules"&&await i(l):o.isFile()&&t.some(d=>o.name.endsWith(d))&&r.push(l)}}return await i(e),r}async function ie(e){const{docsDir:t,outputPath:r,extensions:i=[".mdx",".md"]}=e,n=e.gitCwd??x.join(t,"..");if(!await I(n))return console.warn("Warning: Not a git repository. Generating empty dates file."),await G(r),{filesWithDates:0,filesSkipped:0,outputPath:r};const a=await te(t,i);if(a.length===0)return console.warn(`Warning: No files found in ${t} with extensions ${i.join(", ")}`),await G(r),{filesWithDates:0,filesSkipped:0,outputPath:r};const o=a.map(m=>x.relative(n,m)),{dates:l,skipped:c}=await O(o,{cwd:n}),d=ne(l);return await k.writeFile(r,d,"utf-8"),{filesWithDates:Object.keys(l).length,filesSkipped:c.length,outputPath:r}}async function G(e){const t=`// dates.generated.ts (auto-generated, do not edit)
 // Generated at: ${new Date().toISOString()}
 // Warning: Git repository not available, no dates extracted
 
 export const lastModifiedDates: Record<string, string> = {}
-`;await k.writeFile(e,t,"utf-8")}function te(e){const t=Object.entries(e).sort(([i],[n])=>i.localeCompare(n)),r=t.map(([i,n])=>`  '${i}': '${n}',`).join(`
+`;await k.writeFile(e,t,"utf-8")}function ne(e){const t=Object.entries(e).sort(([i],[n])=>i.localeCompare(n)),r=t.map(([i,n])=>`  '${i}': '${n}',`).join(`
 `);return`// dates.generated.ts (auto-generated, do not edit)
 // Generated at: ${new Date().toISOString()}
 // Total files: ${t.length}
@@ -11,4 +11,4 @@ export const lastModifiedDates: Record<string, string> = {}
 export const lastModifiedDates: Record<string, string> = {
 ${r}
 }
-`}function P(e){return e.replace(/\\/g,"/").replace(/\/+/g,"/").replace(/\/$/,"")}function ie(...e){return P(e.filter(Boolean).join("/"))}function ne(e,t,r={}){const{basePath:i}=r;function n(a){const o={...a};if(a.file){const l=i?ie(i,a.file):a.file,f=[P(l),P(l).replace(/^\//,""),a.file,a.file.replace(/^\//,"")];for(const u of f)if(t[u]){o.lastModified=t[u];break}}return a.children&&a.children.length>0&&(o.children=a.children.map(n)),o}return e.map(n)}exports.BreadcrumbItemSchema=s.BreadcrumbItemSchema;exports.DocPageMetaSchema=s.DocPageMetaSchema;exports.DocPageSchema=s.DocPageSchema;exports.DocsPackageManifestInputSchema=s.DocsPackageManifestInputSchema;exports.DocsPackageManifestSchema=s.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=s.FlatNavigationNodeSchema;exports.GitHubConfigSchema=s.GitHubConfigSchema;exports.LoadedDocsPackageSchema=s.LoadedDocsPackageSchema;exports.ManifestValidationError=s.ManifestValidationError;exports.NavigationNodeInputSchema=s.NavigationNodeInputSchema;exports.NavigationNodeSchema=s.NavigationNodeSchema;exports.SearchConfigSchema=s.SearchConfigSchema;exports.VendureVersionSchema=s.VendureVersionSchema;exports.buildBreadcrumbs=s.buildBreadcrumbs;exports.findNavigationNode=s.findNavigationNode;exports.flattenNavigation=s.flattenNavigation;exports.getLeafNodes=s.getLeafNodes;exports.getNodesAtDepth=s.getNodesAtDepth;exports.getPrevNextNodes=s.getPrevNextNodes;exports.isNodeActive=s.isNodeActive;exports.validateManifest=s.validateManifest;exports.FrontmatterParseError=h.FrontmatterParseError;exports.extractFrontmatterData=h.extractFrontmatterData;exports.hasFrontmatter=h.hasFrontmatter;exports.parseFrontmatter=h.parseFrontmatter;exports.validateFrontmatter=h.validateFrontmatter;exports.filterVisibleNavigation=d.filterVisibleNavigation;exports.getAllFilePaths=d.getAllFilePaths;exports.slugFromFilename=d.slugFromFilename;exports.titleFromFilename=d.titleFromFilename;exports.toSlug=d.toSlug;exports.ManifestResolutionError=S;exports.applyLastModifiedDates=ne;exports.createNavigationFromFolder=H;exports.createNestedNavigationFromFolder=z;exports.generateDatesFile=ee;exports.getGitLastModified=A;exports.getGitLastModifiedBatch=B;exports.isGitRepository=E;exports.manifestNeedsResolution=Y;exports.resolveManifest=K;
+`}function E(e){return e.replace(/\\/g,"/").replace(/\/+/g,"/").replace(/\/$/,"")}function L(...e){return E(e.filter(Boolean).join("/"))}function re(e,t,r={}){const{basePath:i}=r;function n(a){const o={...a};if(a.file){const l=E(a.file),c=[];if(i){const m=`/${E(i)}/`,$=l.indexOf(m);if($!==-1){const p=l.slice($+1);c.push(p)}c.push(L(i,l)),c.push(L(i,l).replace(/^\//,""))}if(c.push(l),c.push(l.replace(/^\//,"")),i){const d=l.split(`/${i}/`);if(d.length>1){const m=d[d.length-1];c.push(`${i}/${m}`),c.push(m)}}for(const d of c)if(t[d]){o.lastModified=t[d];break}}return a.children&&a.children.length>0&&(o.children=a.children.map(n)),o}return e.map(n)}exports.BreadcrumbItemSchema=s.BreadcrumbItemSchema;exports.DocPageMetaSchema=s.DocPageMetaSchema;exports.DocPageSchema=s.DocPageSchema;exports.DocsPackageManifestInputSchema=s.DocsPackageManifestInputSchema;exports.DocsPackageManifestSchema=s.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=s.FlatNavigationNodeSchema;exports.GitHubConfigSchema=s.GitHubConfigSchema;exports.LoadedDocsPackageSchema=s.LoadedDocsPackageSchema;exports.ManifestValidationError=s.ManifestValidationError;exports.NavigationNodeInputSchema=s.NavigationNodeInputSchema;exports.NavigationNodeSchema=s.NavigationNodeSchema;exports.SearchConfigSchema=s.SearchConfigSchema;exports.VendureVersionSchema=s.VendureVersionSchema;exports.buildBreadcrumbs=s.buildBreadcrumbs;exports.findNavigationNode=s.findNavigationNode;exports.flattenNavigation=s.flattenNavigation;exports.getLeafNodes=s.getLeafNodes;exports.getNodesAtDepth=s.getNodesAtDepth;exports.getPrevNextNodes=s.getPrevNextNodes;exports.isNodeActive=s.isNodeActive;exports.validateManifest=s.validateManifest;exports.FrontmatterParseError=F.FrontmatterParseError;exports.extractFrontmatterData=F.extractFrontmatterData;exports.hasFrontmatter=F.hasFrontmatter;exports.parseFrontmatter=F.parseFrontmatter;exports.validateFrontmatter=F.validateFrontmatter;exports.filterVisibleNavigation=u.filterVisibleNavigation;exports.getAllFilePaths=u.getAllFilePaths;exports.slugFromFilename=u.slugFromFilename;exports.titleFromFilename=u.titleFromFilename;exports.toSlug=u.toSlug;exports.ManifestResolutionError=D;exports.applyLastModifiedDates=re;exports.createNavigationFromFolder=J;exports.createNestedNavigationFromFolder=K;exports.generateDatesFile=ie;exports.getGitLastModified=T;exports.getGitLastModifiedBatch=O;exports.isGitRepository=I;exports.manifestNeedsResolution=ee;exports.resolveManifest=X;

package/dist/index.js

@@ -1,92 +1,92 @@
 var A = Object.defineProperty;
-var O = (e, t, r) => t in e ? A(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
-var p = (e, t, r) => O(e, typeof t != "symbol" ? t + "" : t, r);
-import { B as ye, D as Ne, a as Se, b as xe, c as $e, F as De, G as be, L as Me, M as ke, N as Pe, d as Ee, S as Ie, V as We, e as je, f as Ce, g as Ge, h as Le, i as Ve, j as Re, k as Te, v as Be } from "./manifest-DlSWyjsA.js";
-import { e as P } from "./frontmatter-B5d9WZzh.js";
-import { F as Oe, h as Ue, p as ze, v as He } from "./frontmatter-B5d9WZzh.js";
-import { s as v, t as F } from "./slug-utils-DVKYe9h8.js";
+var U = (e, t, r) => t in e ? A(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
+var v = (e, t, r) => U(e, typeof t != "symbol" ? t + "" : t, r);
+import { B as ye, D as Ne, a as Se, b as $e, c as xe, F as be, G as De, L as Pe, M as Me, N as ke, d as Ee, S as Ie, V as We, e as je, f as Ce, g as Ge, h as Le, i as Ve, j as Re, k as Te, v as Be } from "./manifest-DlSWyjsA.js";
+import { e as I } from "./frontmatter-B5d9WZzh.js";
+import { F as ze, h as Ae, p as Ue, v as He } from "./frontmatter-B5d9WZzh.js";
+import { s as F, t as w } from "./slug-utils-DVKYe9h8.js";
 import { f as qe, g as Je, a as Ke } from "./slug-utils-DVKYe9h8.js";
-import { readdirSync as E, readFileSync as I, statSync as U } from "fs";
-import { join as w } from "path";
-import { exec as z } from "node:child_process";
-import { promisify as H } from "node:util";
-import { writeFile as W, readdir as _ } from "node:fs/promises";
-import { join as j, relative as q } from "node:path";
-const C = (e, t) => e.order !== t.order ? e.order - t.order : e.title.localeCompare(t.title);
+import { readdirSync as W, readFileSync as j, statSync as H } from "fs";
+import { join as y } from "path";
+import { exec as _ } from "node:child_process";
+import { promisify as q } from "node:util";
+import { writeFile as C, readdir as J } from "node:fs/promises";
+import { join as G, relative as K } from "node:path";
+const L = (e, t) => e.order !== t.order ? e.order - t.order : e.title.localeCompare(t.title);
 function ue(e, t = {}) {
-  const { extensions: r = [".mdx", ".md"], filter: i, sort: n = C } = t, o = L(e, r);
-  return (i ? o.filter(i) : o).sort(n).map((c) => ({
-    title: c.title,
-    slug: c.slug,
-    file: c.path
+  const { extensions: r = [".mdx", ".md"], filter: i, sort: n = L } = t, s = R(e, r);
+  return (i ? s.filter(i) : s).sort(n).map((l) => ({
+    title: l.title,
+    slug: l.slug,
+    file: l.path
   }));
 }
 function he(e, t = {}) {
-  return G(e, t, 0);
+  return V(e, t, 0);
 }
-function G(e, t, r) {
+function V(e, t, r) {
   const {
     extensions: i = [".mdx", ".md"],
     filter: n,
-    sort: o = C,
-    maxDepth: s = 1 / 0,
+    sort: s = L,
+    maxDepth: o = 1 / 0,
     folderFilter: a
-  } = t, c = E(e, { withFileTypes: !0 }), f = [], m = L(e, i), y = (n ? m.filter(n) : m).sort(o);
-  for (const u of y)
-    f.push({
+  } = t, l = W(e, { withFileTypes: !0 }), c = [], h = R(e, i), g = (n ? h.filter(n) : h).sort(s);
+  for (const u of g)
+    c.push({
       title: u.title,
       slug: u.slug,
       file: u.path
     });
-  if (r < s) {
-    const u = c.filter((d) => d.isDirectory());
+  if (r < o) {
+    const u = l.filter((d) => d.isDirectory());
     for (const d of u) {
       if (a) {
-        const l = w(e, d.name);
-        if (!a(d.name, l))
+        const f = y(e, d.name);
+        if (!a(d.name, f))
           continue;
       }
-      const h = w(e, d.name), g = G(h, t, r + 1);
-      if (g.length > 0) {
-        const l = J(h, i);
-        f.push({
-          title: (l == null ? void 0 : l.title) || F(d.name),
-          slug: v(d.name),
-          file: l == null ? void 0 : l.path,
-          children: g.filter((N) => !(l && N.file === l.path))
+      const m = y(e, d.name), p = V(m, t, r + 1);
+      if (p.length > 0) {
+        const f = Q(m, i);
+        c.push({
+          title: (f == null ? void 0 : f.title) || w(d.name),
+          slug: F(d.name),
+          file: f == null ? void 0 : f.path,
+          children: p.filter((S) => !(f && S.file === f.path))
         });
       }
     }
   }
-  return f.sort((u, d) => {
-    var b, M;
-    const h = y.find((S) => S.slug === u.slug), g = y.find((S) => S.slug === d.slug);
-    if (h && g)
-      return o(h, g);
-    const l = !!u.file && !((b = u.children) != null && b.length), N = !!d.file && !((M = d.children) != null && M.length);
-    return l !== N ? l ? -1 : 1 : (u.title || "").localeCompare(d.title || "");
+  return c.sort((u, d) => {
+    var P, M;
+    const m = g.find(($) => $.slug === u.slug), p = g.find(($) => $.slug === d.slug);
+    if (m && p)
+      return s(m, p);
+    const f = !!u.file && !((P = u.children) != null && P.length), S = !!d.file && !((M = d.children) != null && M.length);
+    return f !== S ? f ? -1 : 1 : (u.title || "").localeCompare(d.title || "");
   });
 }
-function L(e, t) {
+function R(e, t) {
   try {
-    const r = E(e, { withFileTypes: !0 }), i = [];
+    const r = W(e, { withFileTypes: !0 }), i = [];
     for (const n of r) {
       if (!n.isFile()) continue;
-      const o = t.find((f) => n.name.toLowerCase().endsWith(f));
-      if (!o || n.name.slice(0, -o.length).toLowerCase() === "index") continue;
-      const a = w(e, n.name), c = V(a, n.name, o);
-      i.push(c);
+      const s = t.find((c) => n.name.toLowerCase().endsWith(c));
+      if (!s || n.name.slice(0, -s.length).toLowerCase() === "index") continue;
+      const a = y(e, n.name), l = T(a, n.name, s);
+      i.push(l);
     }
     return i;
   } catch {
     return [];
   }
 }
-function V(e, t, r) {
-  let i = {}, n = F(t), o = 1 / 0;
+function T(e, t, r) {
+  let i = {}, n = w(t), s = 1 / 0;
   try {
-    const s = I(e, "utf-8");
-    i = P(s), i.title && typeof i.title == "string" && (n = i.title), typeof i.order == "number" && (o = i.order);
+    const o = j(e, "utf-8");
+    i = I(o), i.title && typeof i.title == "string" && (n = i.title), typeof i.order == "number" && (s = i.order);
   } catch {
   }
   return {
@@ -94,32 +94,32 @@ function V(e, t, r) {
     filename: t,
     extension: r,
     frontmatter: i,
-    order: o,
+    order: s,
     title: n,
-    slug: v(t)
+    slug: F(t)
   };
 }
-function J(e, t) {
+function Q(e, t) {
   for (const r of t) {
-    const i = w(e, `index${r}`);
+    const i = y(e, `index${r}`);
     try {
-      if (U(i).isFile())
-        return V(i, `index${r}`, r);
+      if (H(i).isFile())
+        return T(i, `index${r}`, r);
     } catch {
     }
   }
 }
 class x extends Error {
-  constructor(r, i, n, o) {
+  constructor(r, i, n, s) {
     super(r);
-    p(this, "nodePath");
-    p(this, "filePath");
-    p(this, "originalError");
-    this.name = "ManifestResolutionError", this.nodePath = i, this.filePath = n, this.originalError = o;
+    v(this, "nodePath");
+    v(this, "filePath");
+    v(this, "originalError");
+    this.name = "ManifestResolutionError", this.nodePath = i, this.filePath = n, this.originalError = s;
   }
 }
 function ge(e, t = {}) {
-  const { strict: r = !0 } = t, i = $(e.navigation, "", r);
+  const { strict: r = !0 } = t, i = b(e.navigation, "", r);
   return {
     id: e.id,
     name: e.name,
@@ -131,52 +131,52 @@ function ge(e, t = {}) {
     basePath: e.basePath
   };
 }
-function $(e, t, r) {
-  return e.map((i, n) => K(i, t, n, r));
+function b(e, t, r) {
+  return e.map((i, n) => X(i, t, n, r));
 }
-function K(e, t, r, i) {
+function X(e, t, r, i) {
   const n = t ? `${t}[${r}]` : `navigation[${r}]`;
   if (e.title && e.slug)
     return {
       title: e.title,
       slug: e.slug,
       file: e.file,
-      children: e.children ? $(e.children, `${n}.children`, i) : void 0,
+      children: e.children ? b(e.children, `${n}.children`, i) : void 0,
       badge: e.badge,
       hidden: e.hidden
     };
-  let o = e.title, s = e.slug;
-  if (e.file && (s || (s = v(e.file)), o || (o = Q(e.file, n, i))), !o) {
+  let s = e.title, o = e.slug;
+  if (e.file && (o || (o = F(e.file)), s || (s = Y(e.file, n, i))), !s) {
     if (i)
       throw new x(
         `Navigation node at ${n} is missing title and has no file to derive it from`,
         n,
         e.file
       );
-    o = s || `Unknown (${r})`;
+    s = o || `Unknown (${r})`;
   }
-  if (!s) {
+  if (!o) {
     if (i)
       throw new x(
         `Navigation node at ${n} is missing slug and has no file to derive it from`,
         n,
         e.file
       );
-    s = o ? v(o) : `node-${r}`;
+    o = s ? F(s) : `node-${r}`;
   }
   return {
-    title: o,
-    slug: s,
+    title: s,
+    slug: o,
     file: e.file,
-    children: e.children ? $(e.children, `${n}.children`, i) : void 0,
+    children: e.children ? b(e.children, `${n}.children`, i) : void 0,
     badge: e.badge,
     hidden: e.hidden
   };
 }
-function Q(e, t, r) {
+function Y(e, t, r) {
   try {
-    const i = I(e, "utf-8"), n = P(i);
-    return n.title && typeof n.title == "string" ? n.title : F(e);
+    const i = j(e, "utf-8"), n = I(i);
+    return n.title && typeof n.title == "string" ? n.title : w(e);
   } catch (i) {
     if (r)
       throw new x(
@@ -185,77 +185,77 @@ function Q(e, t, r) {
         e,
         i
       );
-    return F(e);
+    return w(e);
   }
 }
 function me(e) {
-  return R(e.navigation);
+  return B(e.navigation);
 }
-function R(e) {
+function B(e) {
   for (const t of e)
-    if (!t.title || !t.slug || t.children && R(t.children))
+    if (!t.title || !t.slug || t.children && B(t.children))
       return !0;
   return !1;
 }
-const T = H(z);
-async function B(e = process.cwd()) {
+const O = q(_);
+async function z(e = process.cwd()) {
   try {
-    return await T("git rev-parse --git-dir", { cwd: e }), !0;
+    return await O("git rev-parse --git-dir", { cwd: e }), !0;
   } catch {
     return !1;
   }
 }
-async function X(e, t = {}) {
+async function Z(e, t = {}) {
   const r = t.cwd ?? process.cwd();
   try {
-    const { stdout: i } = await T(`git log -1 --format=%cI -- "${e}"`, { cwd: r }), n = i.trim();
+    const { stdout: i } = await O(`git log -1 --format=%cI -- "${e}"`, { cwd: r }), n = i.trim();
     return n || null;
   } catch {
     return null;
   }
 }
-async function Y(e, t = {}) {
+async function ee(e, t = {}) {
   const r = t.cwd ?? process.cwd(), i = {}, n = [];
-  return await B(r) ? (await Promise.all(
-    e.map(async (o) => {
-      const s = await X(o, t);
-      s ? i[o] = s : n.push(o);
+  return await z(r) ? (await Promise.all(
+    e.map(async (s) => {
+      const o = await Z(s, t);
+      o ? i[s] = o : n.push(s);
     })
   ), { dates: i, skipped: n }) : {
     dates: {},
     skipped: e
   };
 }
-async function Z(e, t) {
+async function te(e, t) {
   const r = [];
   async function i(n) {
-    const o = await _(n, { withFileTypes: !0 });
-    for (const s of o) {
-      const a = j(n, s.name);
-      s.isDirectory() ? !s.name.startsWith(".") && s.name !== "node_modules" && await i(a) : s.isFile() && t.some((f) => s.name.endsWith(f)) && r.push(a);
+    const s = await J(n, { withFileTypes: !0 });
+    for (const o of s) {
+      const a = G(n, o.name);
+      o.isDirectory() ? !o.name.startsWith(".") && o.name !== "node_modules" && await i(a) : o.isFile() && t.some((c) => o.name.endsWith(c)) && r.push(a);
     }
   }
   return await i(e), r;
 }
 async function pe(e) {
-  const { docsDir: t, outputPath: r, extensions: i = [".mdx", ".md"] } = e, n = e.gitCwd ?? j(t, "..");
-  if (!await B(n))
+  const { docsDir: t, outputPath: r, extensions: i = [".mdx", ".md"] } = e, n = e.gitCwd ?? G(t, "..");
+  if (!await z(n))
     return console.warn("Warning: Not a git repository. Generating empty dates file."), await k(r), {
       filesWithDates: 0,
       filesSkipped: 0,
       outputPath: r
     };
-  const o = await Z(t, i);
-  if (o.length === 0)
+  const s = await te(t, i);
+  if (s.length === 0)
     return console.warn(`Warning: No files found in ${t} with extensions ${i.join(", ")}`), await k(r), {
       filesWithDates: 0,
       filesSkipped: 0,
       outputPath: r
     };
-  const s = o.map((m) => q(n, m)), { dates: a, skipped: c } = await Y(s, { cwd: n }), f = ee(a);
-  return await W(r, f, "utf-8"), {
+  const o = s.map((h) => K(n, h)), { dates: a, skipped: l } = await ee(o, { cwd: n }), c = ie(a);
+  return await C(r, c, "utf-8"), {
     filesWithDates: Object.keys(a).length,
-    filesSkipped: c.length,
+    filesSkipped: l.length,
     outputPath: r
   };
 }
@@ -266,9 +266,9 @@ async function k(e) {
 
 export const lastModifiedDates: Record<string, string> = {}
 `;
-  await W(e, t, "utf-8");
+  await C(e, t, "utf-8");
 }
-function ee(e) {
+function ie(e) {
   const t = Object.entries(e).sort(([i], [n]) => i.localeCompare(n)), r = t.map(([i, n]) => `  '${i}': '${n}',`).join(`
 `);
   return `// dates.generated.ts (auto-generated, do not edit)
@@ -283,29 +283,37 @@ ${r}
 function D(e) {
   return e.replace(/\\/g, "/").replace(/\/+/g, "/").replace(/\/$/, "");
 }
-function te(...e) {
+function E(...e) {
   return D(e.filter(Boolean).join("/"));
 }
 function ve(e, t, r = {}) {
   const { basePath: i } = r;
-  function n(o) {
-    const s = { ...o };
-    if (o.file) {
-      const a = i ? te(i, o.file) : o.file, c = [
-        D(a),
-        // Try without leading slash
-        D(a).replace(/^\//, ""),
-        // Try the file path as-is
-        o.file,
-        o.file.replace(/^\//, "")
-      ];
-      for (const f of c)
-        if (t[f]) {
-          s.lastModified = t[f];
+  function n(s) {
+    const o = { ...s };
+    if (s.file) {
+      const a = D(s.file), l = [];
+      if (i) {
+        const h = `/${D(i)}/`, N = a.indexOf(h);
+        if (N !== -1) {
+          const g = a.slice(N + 1);
+          l.push(g);
+        }
+        l.push(E(i, a)), l.push(E(i, a).replace(/^\//, ""));
+      }
+      if (l.push(a), l.push(a.replace(/^\//, "")), i) {
+        const c = a.split(`/${i}/`);
+        if (c.length > 1) {
+          const h = c[c.length - 1];
+          l.push(`${i}/${h}`), l.push(h);
+        }
+      }
+      for (const c of l)
+        if (t[c]) {
+          o.lastModified = t[c];
           break;
         }
     }
-    return o.children && o.children.length > 0 && (s.children = o.children.map(n)), s;
+    return s.children && s.children.length > 0 && (o.children = s.children.map(n)), o;
   }
   return e.map(n);
 }
@@ -313,15 +321,15 @@ export {
   ye as BreadcrumbItemSchema,
   Ne as DocPageMetaSchema,
   Se as DocPageSchema,
-  xe as DocsPackageManifestInputSchema,
-  $e as DocsPackageManifestSchema,
-  De as FlatNavigationNodeSchema,
-  Oe as FrontmatterParseError,
-  be as GitHubConfigSchema,
-  Me as LoadedDocsPackageSchema,
+  $e as DocsPackageManifestInputSchema,
+  xe as DocsPackageManifestSchema,
+  be as FlatNavigationNodeSchema,
+  ze as FrontmatterParseError,
+  De as GitHubConfigSchema,
+  Pe as LoadedDocsPackageSchema,
   x as ManifestResolutionError,
-  ke as ManifestValidationError,
-  Pe as NavigationNodeInputSchema,
+  Me as ManifestValidationError,
+  ke as NavigationNodeInputSchema,
   Ee as NavigationNodeSchema,
   Ie as SearchConfigSchema,
   We as VendureVersionSchema,
@@ -329,25 +337,25 @@ export {
   je as buildBreadcrumbs,
   ue as createNavigationFromFolder,
   he as createNestedNavigationFromFolder,
-  P as extractFrontmatterData,
+  I as extractFrontmatterData,
   qe as filterVisibleNavigation,
   Ce as findNavigationNode,
   Ge as flattenNavigation,
   pe as generateDatesFile,
   Je as getAllFilePaths,
-  X as getGitLastModified,
-  Y as getGitLastModifiedBatch,
+  Z as getGitLastModified,
+  ee as getGitLastModifiedBatch,
   Le as getLeafNodes,
   Ve as getNodesAtDepth,
   Re as getPrevNextNodes,
-  Ue as hasFrontmatter,
-  B as isGitRepository,
+  Ae as hasFrontmatter,
+  z as isGitRepository,
   Te as isNodeActive,
   me as manifestNeedsResolution,
-  ze as parseFrontmatter,
+  Ue as parseFrontmatter,
   ge as resolveManifest,
-  v as slugFromFilename,
-  F as titleFromFilename,
+  F as slugFromFilename,
+  w as titleFromFilename,
   Ke as toSlug,
   He as validateFrontmatter,
   Be as validateManifest

package/dist/testing/index.d.ts

@@ -1,7 +1,8 @@
 import { MdxCompilationResult, MdxTestReport } from './types';
-export type { CompileMdxOptions, MdxCompilationResult, MdxTestReport, TestManifestOptions, } from './types';
+export type { AdmonitionError, AdmonitionValidationReport, CompileMdxOptions, MdxCompilationResult, MdxTestReport, TestManifestOptions, ValidateAdmonitionsOptions, } from './types';
 export { compileMdx, getDefaultRehypePlugins, getDefaultRemarkPlugins } from './mdx-compiler';
 export { testManifestMdx } from './test-manifest';
+export { ADMONITION_TYPES, formatAdmonitionReport, INVALID_ADMONITION_PATTERN, validateAdmonitions, } from './validate-admonitions';
 /**
  * Format a test report for console output.
  *

package/dist/testing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGlE,YAAY,EACV,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,GACpB,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,UAAQ,GAAG,MAAM,CAgE/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,IAAI,CACxC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,oBAAoB,KACzB,IAAI,CAcR"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGlE,YAAY,EACV,eAAe,EACf,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,mBAAmB,GACpB,MAAM,wBAAwB,CAAA;AAE/B;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,UAAQ,GAAG,MAAM,CAgE/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,IAAI,CACxC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,oBAAoB,KACzB,IAAI,CAcR"}

package/dist/testing/types.d.ts

@@ -73,4 +73,53 @@ export interface CompileMdxOptions {
      */
     rehypePlugins?: PluggableList;
 }
+/**
+ * Error found during admonition syntax validation
+ */
+export interface AdmonitionError {
+    /** Relative path to the file from the manifest basePath */
+    file: string;
+    /** Absolute path to the file */
+    absolutePath: string;
+    /** Line number where the error was found (1-indexed) */
+    line: number;
+    /** Column number where the error was found (1-indexed) */
+    column: number;
+    /** The full content of the line containing the error */
+    content: string;
+    /** The type of admonition (warning, info, tip, etc.) */
+    admonitionType: string;
+    /** The label that was incorrectly space-separated */
+    label: string;
+    /** Suggested fix using bracket syntax */
+    suggestion: string;
+}
+/**
+ * Report from validating admonition syntax in a manifest
+ */
+export interface AdmonitionValidationReport {
+    /** Package ID from the manifest */
+    packageId: string;
+    /** Number of files that were scanned */
+    filesScanned: number;
+    /** List of validation errors found */
+    errors: AdmonitionError[];
+    /** Total time taken for validation in milliseconds */
+    totalTime: number;
+}
+/**
+ * Options for validating admonition syntax
+ */
+export interface ValidateAdmonitionsOptions {
+    /**
+     * Stop on first error.
+     * @default false
+     */
+    failFast?: boolean;
+    /**
+     * Callback invoked for each error found.
+     * Useful for real-time reporting.
+     */
+    onError?: (error: AdmonitionError) => void;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/testing/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/testing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAA;IAChB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qDAAqD;IACrD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,uCAAuC;IACvC,OAAO,EAAE,oBAAoB,EAAE,CAAA;IAC/B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAA;CACpF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC9B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/testing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAA;IAChB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qDAAqD;IACrD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,uCAAuC;IACvC,OAAO,EAAE,oBAAoB,EAAE,CAAA;IAC/B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAA;CACpF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAA;IACpB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAA;IACd,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAA;IACf,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAA;IACtB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAA;CAC3C"}

package/dist/testing/validate-admonitions.d.ts

@@ -0,0 +1,59 @@
+import { DocsPackageManifest } from '../types';
+import { AdmonitionValidationReport, ValidateAdmonitionsOptions } from './types';
+/**
+ * Supported admonition types in remark-directive
+ */
+export declare const ADMONITION_TYPES: readonly ["warning", "info", "tip", "note", "caution", "danger"];
+/**
+ * Pattern that matches invalid admonition syntax with space-separated labels.
+ *
+ * Valid: :::warning[Deprecated]
+ * Invalid: :::warning Deprecated
+ *
+ * This pattern captures:
+ * - Group 1: The admonition type (warning, info, tip, etc.)
+ * - Group 2: The label text (everything after the space until end of line)
+ */
+export declare const INVALID_ADMONITION_PATTERN: RegExp;
+/**
+ * Validate admonition syntax in all MDX files of a manifest.
+ *
+ * The remark-directive v4 plugin requires square bracket syntax for labels:
+ * - Valid: `:::warning[Deprecated]`
+ * - Invalid: `:::warning Deprecated`
+ *
+ * This function scans all MDX files in the manifest and reports any
+ * admonitions using the invalid space-separated label syntax.
+ *
+ * @param manifest - The documentation package manifest to validate
+ * @param options - Optional configuration for validation
+ * @returns A report containing all validation errors
+ *
+ * @example
+ * ```typescript
+ * import { manifest } from '../src/manifest'
+ * import { validateAdmonitions, formatAdmonitionReport } from '@vendure-io/docs-provider/testing'
+ *
+ * const report = validateAdmonitions(manifest)
+ *
+ * if (report.errors.length > 0) {
+ *   console.error(formatAdmonitionReport(report))
+ *   process.exit(1)
+ * }
+ * ```
+ */
+export declare function validateAdmonitions(manifest: DocsPackageManifest, options?: ValidateAdmonitionsOptions): AdmonitionValidationReport;
+/**
+ * Format an admonition validation report for console output.
+ *
+ * @param report - The validation report to format
+ * @returns A formatted string suitable for console output
+ *
+ * @example
+ * ```typescript
+ * const report = validateAdmonitions(manifest)
+ * console.log(formatAdmonitionReport(report))
+ * ```
+ */
+export declare function formatAdmonitionReport(report: AdmonitionValidationReport): string;
+//# sourceMappingURL=validate-admonitions.d.ts.map

package/dist/testing/validate-admonitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-admonitions.d.ts","sourceRoot":"","sources":["../../src/testing/validate-admonitions.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEnD,OAAO,KAAK,EAAmB,0BAA0B,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEtG;;GAEG;AACH,eAAO,MAAM,gBAAgB,kEAAmE,CAAA;AAEhG;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B,QAEtC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,mBAAmB,EAC7B,OAAO,CAAC,EAAE,0BAA0B,GACnC,0BAA0B,CAuD5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,0BAA0B,GAAG,MAAM,CAsCjF"}

package/dist/testing.cjs

@@ -1,4 +1,7 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const k=require("@mdx-js/mdx"),F=require("rehype-slug"),w=require("remark-directive"),M=require("remark-gfm"),p=require("unist-util-visit"),x=require("fs/promises"),R=require("./manifest-BkO3d77g.cjs"),$={info:"info",note:"note",tip:"tip",warning:"warning",caution:"caution",danger:"danger"},D={info:"Info",note:"Note",tip:"Tip",warning:"Warning",caution:"Caution",danger:"Danger"},I=()=>s=>{p.visit(s,"containerDirective",t=>{var a;const e=t.name.toLowerCase();if(!(e in $))return;const i=$[e];let r;if(t.children.length>0){const l=t.children[0];if(l.type==="paragraph"&&"data"in l&&((a=l.data)==null?void 0:a.directiveLabel)===!0){const u=[];for(const o of l.children)o.type==="text"&&u.push(o.value);u.length>0&&(r=u.join("")),t.children=t.children.slice(1)}}const n=r||D[e],c=t.data||(t.data={});c.hName="Callout",c.hProperties={type:i,title:n}})};function E(){return s=>{p.visit(s,"code",t=>{if(!t.meta)return;const e=t.meta.match(/(?:title|filename)=["']([^"']+)["']/);if(!e)return;const i=e[1];t.value.trim().startsWith("// filename:")||(t.value=`// filename: ${i}
-${t.value}`)})}}const S=()=>s=>{const t=[];p.visit(s,"html",(e,i,r)=>{i!==void 0&&r&&typeof e.value=="string"&&e.value.trim().startsWith("<!--")&&e.value.trim().endsWith("-->")&&t.push(i)});for(const e of t.reverse())s.children.splice(e,1)},b=["@theme/Tabs","@theme/TabItem"],C=()=>s=>{const t=[];p.visit(s,"mdxjsEsm",e=>{const i=e.value;b.some(n=>i.includes(`from '${n}'`)||i.includes(`from "${n}"`))&&t.push(e)});for(const e of t){const i=s.children.indexOf(e);i!==-1&&s.children.splice(i,1)}};function v(){return[M,w,I,E,C,S]}function T(){return[F]}async function y(s,t,e){var c,a,l,u;const i=performance.now(),r=(e==null?void 0:e.remarkPlugins)??v(),n=(e==null?void 0:e.rehypePlugins)??T();try{return await k.compile(s,{remarkPlugins:r,rehypePlugins:n,outputFormat:"function-body",development:!1}),{filePath:t,success:!0,compilationTime:performance.now()-i}}catch(o){const f=performance.now()-i;let h="Unknown compilation error",d,g;if(o instanceof Error){h=o.message;const m=o;if(m.line!==void 0?d=m.line:((a=(c=m.position)==null?void 0:c.start)==null?void 0:a.line)!==void 0&&(d=m.position.start.line),m.column!==void 0?g=m.column:((u=(l=m.position)==null?void 0:l.start)==null?void 0:u.column)!==void 0&&(g=m.position.start.column),d===void 0){const P=h.match(/\((\d+):(\d+)\)/);P&&(d=parseInt(P[1],10),g=parseInt(P[2],10))}}return{filePath:t,success:!1,error:h,line:d,column:g,compilationTime:f}}}async function L(s,t){const e=performance.now(),i=R.getLeafNodes(s),r=[];let n=0,c=0;for(let a=0;a<i.length;a++){const l=i[a];if(!l.file)continue;const u=l.file;try{const o=await x.readFile(u,"utf-8"),f=await y(o,l.file,{remarkPlugins:t==null?void 0:t.remarkPlugins,rehypePlugins:t==null?void 0:t.rehypePlugins});if(r.push(f),f.success?n++:c++,t!=null&&t.onProgress&&t.onProgress(a+1,i.length,f),t!=null&&t.failFast&&!f.success)break}catch(o){const f=o instanceof Error?o.message:"Unknown error reading file",h={filePath:l.file,success:!1,error:`Failed to read file: ${f}`,compilationTime:0};if(r.push(h),c++,t!=null&&t.onProgress&&t.onProgress(a+1,i.length,h),t!=null&&t.failFast)break}}return{packageId:s.id,totalFiles:r.length,passed:n,failed:c,results:r,totalTime:performance.now()-e}}function q(s,t=!1){const e=[];e.push(""),e.push(`MDX Compilation Report: ${s.packageId}`),e.push("=".repeat(50)),e.push("");const i=s.totalFiles>0?(s.passed/s.totalFiles*100).toFixed(1):"0";if(e.push(`Total files: ${s.totalFiles}`),e.push(`Passed: ${s.passed} (${i}%)`),e.push(`Failed: ${s.failed}`),e.push(`Total time: ${s.totalTime.toFixed(2)}ms`),e.push(""),t){e.push("Results:"),e.push("-".repeat(50));for(const r of s.results){const n=r.success?"[PASS]":"[FAIL]",c=`(${r.compilationTime.toFixed(2)}ms)`;if(e.push(`${n} ${r.filePath} ${c}`),!r.success&&r.error){const a=r.line?` (line ${r.line}${r.column?`:${r.column}`:""})`:"";e.push(`       Error${a}: ${r.error}`)}}}else if(s.failed>0){e.push("Failures:"),e.push("-".repeat(50));for(const r of s.results.filter(n=>!n.success))if(e.push(`[FAIL] ${r.filePath}`),r.error){const n=r.line?` (line ${r.line}${r.column?`:${r.column}`:""})`:"";e.push(`       Error${n}: ${r.error}`)}}return e.push(""),s.failed===0?e.push("All MDX files compiled successfully!"):e.push(`${s.failed} file(s) failed to compile.`),e.push(""),e.join(`
-`)}function A(){return(s,t,e)=>{const i=e.success?"✓":"✗",r=(s/t*100).toFixed(0);process.stdout.write(`\r[${s}/${t}] (${r}%) ${i} ${e.filePath}`),process.stdout.write("\x1B[K"),s===t&&process.stdout.write(`
-`)}}exports.compileMdx=y;exports.createProgressReporter=A;exports.formatTestReport=q;exports.getDefaultRehypePlugins=T;exports.getDefaultRemarkPlugins=v;exports.testManifestMdx=L;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const A=require("@mdx-js/mdx"),F=require("rehype-slug"),x=require("remark-directive"),D=require("remark-gfm"),g=require("unist-util-visit"),E=require("fs/promises"),P=require("./manifest-BkO3d77g.cjs"),R=require("node:fs"),M=require("node:path"),$={info:"info",note:"note",tip:"tip",warning:"warning",caution:"caution",danger:"danger"},N={info:"Info",note:"Note",tip:"Tip",warning:"Warning",caution:"Caution",danger:"Danger"},S=()=>s=>{g.visit(s,"containerDirective",e=>{var c;const t=e.name.toLowerCase();if(!(t in $))return;const i=$[t];let r;if(e.children.length>0){const l=e.children[0];if(l.type==="paragraph"&&"data"in l&&((c=l.data)==null?void 0:c.directiveLabel)===!0){const u=[];for(const o of l.children)o.type==="text"&&u.push(o.value);u.length>0&&(r=u.join("")),e.children=e.children.slice(1)}}const n=r||N[t],a=e.data||(e.data={});a.hName="Callout",a.hProperties={type:i,title:n}})};function b(){return s=>{g.visit(s,"code",e=>{if(!e.meta)return;const t=e.meta.match(/(?:title|filename)=["']([^"']+)["']/);if(!t)return;const i=t[1];e.value.trim().startsWith("// filename:")||(e.value=`// filename: ${i}
+${e.value}`)})}}const _=()=>s=>{const e=[];g.visit(s,"html",(t,i,r)=>{i!==void 0&&r&&typeof t.value=="string"&&t.value.trim().startsWith("<!--")&&t.value.trim().endsWith("-->")&&e.push(i)});for(const t of e.reverse())s.children.splice(t,1)},L=["@theme/Tabs","@theme/TabItem"],O=()=>s=>{const e=[];g.visit(s,"mdxjsEsm",t=>{const i=t.value;L.some(n=>i.includes(`from '${n}'`)||i.includes(`from "${n}"`))&&e.push(t)});for(const t of e){const i=s.children.indexOf(t);i!==-1&&s.children.splice(i,1)}};function v(){return[D,x,S,b,O,_]}function I(){return[F]}async function y(s,e,t){var a,c,l,u;const i=performance.now(),r=(t==null?void 0:t.remarkPlugins)??v(),n=(t==null?void 0:t.rehypePlugins)??I();try{return await A.compile(s,{remarkPlugins:r,rehypePlugins:n,outputFormat:"function-body",development:!1}),{filePath:e,success:!0,compilationTime:performance.now()-i}}catch(o){const f=performance.now()-i;let m="Unknown compilation error",h,p;if(o instanceof Error){m=o.message;const d=o;if(d.line!==void 0?h=d.line:((c=(a=d.position)==null?void 0:a.start)==null?void 0:c.line)!==void 0&&(h=d.position.start.line),d.column!==void 0?p=d.column:((u=(l=d.position)==null?void 0:l.start)==null?void 0:u.column)!==void 0&&(p=d.position.start.column),h===void 0){const T=m.match(/\((\d+):(\d+)\)/);T&&(h=parseInt(T[1],10),p=parseInt(T[2],10))}}return{filePath:e,success:!1,error:m,line:h,column:p,compilationTime:f}}}async function q(s,e){const t=performance.now(),i=P.getLeafNodes(s),r=[];let n=0,a=0;for(let c=0;c<i.length;c++){const l=i[c];if(!l.file)continue;const u=l.file;try{const o=await E.readFile(u,"utf-8"),f=await y(o,l.file,{remarkPlugins:e==null?void 0:e.remarkPlugins,rehypePlugins:e==null?void 0:e.rehypePlugins});if(r.push(f),f.success?n++:a++,e!=null&&e.onProgress&&e.onProgress(c+1,i.length,f),e!=null&&e.failFast&&!f.success)break}catch(o){const f=o instanceof Error?o.message:"Unknown error reading file",m={filePath:l.file,success:!1,error:`Failed to read file: ${f}`,compilationTime:0};if(r.push(m),a++,e!=null&&e.onProgress&&e.onProgress(c+1,i.length,m),e!=null&&e.failFast)break}}return{packageId:s.id,totalFiles:r.length,passed:n,failed:a,results:r,totalTime:performance.now()-t}}const k=["warning","info","tip","note","caution","danger"],w=new RegExp(`^:::(${k.join("|")}) ([A-Z].*)$`);function j(s,e){const t=performance.now(),i=[],r=P.getLeafNodes(s);let n=0;for(const a of r){if(!a.file)continue;n++;const l=R.readFileSync(a.file,"utf-8").split(`
+`);for(let u=0;u<l.length;u++){const o=l[u],f=o.match(w);if(f){const[,m,h]=f,p={file:s.basePath?M.relative(s.basePath,a.file):a.file,absolutePath:a.file,line:u+1,column:1,content:o.trim(),admonitionType:m,label:h,suggestion:`:::${m}[${h}]`};if(i.push(p),e!=null&&e.onError&&e.onError(p),e!=null&&e.failFast&&i.length>0)return{packageId:s.id,filesScanned:n,errors:i,totalTime:performance.now()-t}}}}return{packageId:s.id,filesScanned:n,errors:i,totalTime:performance.now()-t}}function C(s){const e=[];if(e.push(""),e.push(`Admonition Syntax Report: ${s.packageId}`),e.push("=".repeat(50)),e.push(""),e.push(`Files scanned: ${s.filesScanned}`),e.push(`Errors found: ${s.errors.length}`),e.push(`Total time: ${s.totalTime.toFixed(2)}ms`),e.push(""),s.errors.length===0)return e.push("All admonitions use correct bracket syntax!"),e.push(""),e.join(`
+`);e.push("Errors:"),e.push("-".repeat(50)),e.push("");for(const t of s.errors)e.push(`  ${t.file}:${t.line}`),e.push(`    ${t.content}`),e.push(`    Fix: ${t.suggestion}`),e.push("");return e.push("Admonitions with custom titles must use bracket syntax:"),e.push("  Before: :::warning Deprecated"),e.push("  After:  :::warning[Deprecated]"),e.push(""),e.push("See: https://github.com/remarkjs/remark-directive"),e.push(""),e.join(`
+`)}function U(s,e=!1){const t=[];t.push(""),t.push(`MDX Compilation Report: ${s.packageId}`),t.push("=".repeat(50)),t.push("");const i=s.totalFiles>0?(s.passed/s.totalFiles*100).toFixed(1):"0";if(t.push(`Total files: ${s.totalFiles}`),t.push(`Passed: ${s.passed} (${i}%)`),t.push(`Failed: ${s.failed}`),t.push(`Total time: ${s.totalTime.toFixed(2)}ms`),t.push(""),e){t.push("Results:"),t.push("-".repeat(50));for(const r of s.results){const n=r.success?"[PASS]":"[FAIL]",a=`(${r.compilationTime.toFixed(2)}ms)`;if(t.push(`${n} ${r.filePath} ${a}`),!r.success&&r.error){const c=r.line?` (line ${r.line}${r.column?`:${r.column}`:""})`:"";t.push(`       Error${c}: ${r.error}`)}}}else if(s.failed>0){t.push("Failures:"),t.push("-".repeat(50));for(const r of s.results.filter(n=>!n.success))if(t.push(`[FAIL] ${r.filePath}`),r.error){const n=r.line?` (line ${r.line}${r.column?`:${r.column}`:""})`:"";t.push(`       Error${n}: ${r.error}`)}}return t.push(""),s.failed===0?t.push("All MDX files compiled successfully!"):t.push(`${s.failed} file(s) failed to compile.`),t.push(""),t.join(`
+`)}function W(){return(s,e,t)=>{const i=t.success?"✓":"✗",r=(s/e*100).toFixed(0);process.stdout.write(`\r[${s}/${e}] (${r}%) ${i} ${t.filePath}`),process.stdout.write("\x1B[K"),s===e&&process.stdout.write(`
+`)}}exports.ADMONITION_TYPES=k;exports.INVALID_ADMONITION_PATTERN=w;exports.compileMdx=y;exports.createProgressReporter=W;exports.formatAdmonitionReport=C;exports.formatTestReport=U;exports.getDefaultRehypePlugins=I;exports.getDefaultRemarkPlugins=v;exports.testManifestMdx=q;exports.validateAdmonitions=j;

package/dist/testing.js

@@ -1,98 +1,100 @@
-import { compile as T } from "@mdx-js/mdx";
-import v from "rehype-slug";
-import F from "remark-directive";
-import k from "remark-gfm";
+import { compile as v } from "@mdx-js/mdx";
+import w from "rehype-slug";
+import k from "remark-directive";
+import y from "remark-gfm";
 import { visit as g } from "unist-util-visit";
-import { readFile as w } from "fs/promises";
-import { h as y } from "./manifest-DlSWyjsA.js";
-const P = {
+import { readFile as F } from "fs/promises";
+import { h as P } from "./manifest-DlSWyjsA.js";
+import { readFileSync as I } from "node:fs";
+import { relative as x } from "node:path";
+const T = {
   info: "info",
   note: "note",
   tip: "tip",
   warning: "warning",
   caution: "caution",
   danger: "danger"
-}, x = {
+}, E = {
   info: "Info",
   note: "Note",
   tip: "Tip",
   warning: "Warning",
   caution: "Caution",
   danger: "Danger"
-}, I = () => (r) => {
-  g(r, "containerDirective", (t) => {
-    var a;
-    const e = t.name.toLowerCase();
-    if (!(e in P))
+}, A = () => (r) => {
+  g(r, "containerDirective", (e) => {
+    var o;
+    const t = e.name.toLowerCase();
+    if (!(t in T))
       return;
-    const i = P[e];
+    const i = T[t];
     let s;
-    if (t.children.length > 0) {
-      const l = t.children[0];
-      if (l.type === "paragraph" && "data" in l && ((a = l.data) == null ? void 0 : a.directiveLabel) === !0) {
+    if (e.children.length > 0) {
+      const l = e.children[0];
+      if (l.type === "paragraph" && "data" in l && ((o = l.data) == null ? void 0 : o.directiveLabel) === !0) {
         const u = [];
-        for (const o of l.children)
-          o.type === "text" && u.push(o.value);
-        u.length > 0 && (s = u.join("")), t.children = t.children.slice(1);
+        for (const c of l.children)
+          c.type === "text" && u.push(c.value);
+        u.length > 0 && (s = u.join("")), e.children = e.children.slice(1);
       }
     }
-    const n = s || x[e], c = t.data || (t.data = {});
-    c.hName = "Callout", c.hProperties = {
+    const n = s || E[t], a = e.data || (e.data = {});
+    a.hName = "Callout", a.hProperties = {
       type: i,
       title: n
     };
   });
 };
-function E() {
+function D() {
   return (r) => {
-    g(r, "code", (t) => {
-      if (!t.meta) return;
-      const e = t.meta.match(/(?:title|filename)=["']([^"']+)["']/);
-      if (!e) return;
-      const i = e[1];
-      t.value.trim().startsWith("// filename:") || (t.value = `// filename: ${i}
-${t.value}`);
+    g(r, "code", (e) => {
+      if (!e.meta) return;
+      const t = e.meta.match(/(?:title|filename)=["']([^"']+)["']/);
+      if (!t) return;
+      const i = t[1];
+      e.value.trim().startsWith("// filename:") || (e.value = `// filename: ${i}
+${e.value}`);
     });
   };
 }
-const M = () => (r) => {
-  const t = [];
-  g(r, "html", (e, i, s) => {
-    i !== void 0 && s && typeof e.value == "string" && e.value.trim().startsWith("<!--") && e.value.trim().endsWith("-->") && t.push(i);
+const S = () => (r) => {
+  const e = [];
+  g(r, "html", (t, i, s) => {
+    i !== void 0 && s && typeof t.value == "string" && t.value.trim().startsWith("<!--") && t.value.trim().endsWith("-->") && e.push(i);
   });
-  for (const e of t.reverse())
-    r.children.splice(e, 1);
-}, D = ["@theme/Tabs", "@theme/TabItem"], R = () => (r) => {
-  const t = [];
-  g(r, "mdxjsEsm", (e) => {
-    const i = e.value;
-    D.some(
+  for (const t of e.reverse())
+    r.children.splice(t, 1);
+}, R = ["@theme/Tabs", "@theme/TabItem"], b = () => (r) => {
+  const e = [];
+  g(r, "mdxjsEsm", (t) => {
+    const i = t.value;
+    R.some(
       (n) => i.includes(`from '${n}'`) || i.includes(`from "${n}"`)
-    ) && t.push(e);
+    ) && e.push(t);
   });
-  for (const e of t) {
-    const i = r.children.indexOf(e);
+  for (const t of e) {
+    const i = r.children.indexOf(t);
     i !== -1 && r.children.splice(i, 1);
   }
 };
-function S() {
+function M() {
   return [
+    y,
     k,
-    F,
-    I,
-    E,
-    R,
-    M
+    A,
+    D,
+    b,
+    S
   ];
 }
-function C() {
-  return [v];
+function N() {
+  return [w];
 }
-async function L(r, t, e) {
-  var c, a, l, u;
-  const i = performance.now(), s = (e == null ? void 0 : e.remarkPlugins) ?? S(), n = (e == null ? void 0 : e.rehypePlugins) ?? C();
+async function L(r, e, t) {
+  var a, o, l, u;
+  const i = performance.now(), s = (t == null ? void 0 : t.remarkPlugins) ?? M(), n = (t == null ? void 0 : t.rehypePlugins) ?? N();
   try {
-    return await T(r, {
+    return await v(r, {
       remarkPlugins: s,
       rehypePlugins: n,
       // Don't output to JS, just compile to check for errors
@@ -100,54 +102,54 @@ async function L(r, t, e) {
       // Suppress development warnings about missing 'development' option
       development: !1
     }), {
-      filePath: t,
+      filePath: e,
       success: !0,
       compilationTime: performance.now() - i
     };
-  } catch (o) {
+  } catch (c) {
     const f = performance.now() - i;
-    let h = "Unknown compilation error", d, p;
-    if (o instanceof Error) {
-      h = o.message;
-      const m = o;
-      if (m.line !== void 0 ? d = m.line : ((a = (c = m.position) == null ? void 0 : c.start) == null ? void 0 : a.line) !== void 0 && (d = m.position.start.line), m.column !== void 0 ? p = m.column : ((u = (l = m.position) == null ? void 0 : l.start) == null ? void 0 : u.column) !== void 0 && (p = m.position.start.column), d === void 0) {
-        const $ = h.match(/\((\d+):(\d+)\)/);
-        $ && (d = parseInt($[1], 10), p = parseInt($[2], 10));
+    let m = "Unknown compilation error", h, p;
+    if (c instanceof Error) {
+      m = c.message;
+      const d = c;
+      if (d.line !== void 0 ? h = d.line : ((o = (a = d.position) == null ? void 0 : a.start) == null ? void 0 : o.line) !== void 0 && (h = d.position.start.line), d.column !== void 0 ? p = d.column : ((u = (l = d.position) == null ? void 0 : l.start) == null ? void 0 : u.column) !== void 0 && (p = d.position.start.column), h === void 0) {
+        const $ = m.match(/\((\d+):(\d+)\)/);
+        $ && (h = parseInt($[1], 10), p = parseInt($[2], 10));
       }
     }
     return {
-      filePath: t,
+      filePath: e,
       success: !1,
-      error: h,
-      line: d,
+      error: m,
+      line: h,
       column: p,
       compilationTime: f
     };
   }
 }
-async function O(r, t) {
-  const e = performance.now(), i = y(r), s = [];
-  let n = 0, c = 0;
-  for (let a = 0; a < i.length; a++) {
-    const l = i[a];
+async function H(r, e) {
+  const t = performance.now(), i = P(r), s = [];
+  let n = 0, a = 0;
+  for (let o = 0; o < i.length; o++) {
+    const l = i[o];
     if (!l.file)
       continue;
     const u = l.file;
     try {
-      const o = await w(u, "utf-8"), f = await L(o, l.file, {
-        remarkPlugins: t == null ? void 0 : t.remarkPlugins,
-        rehypePlugins: t == null ? void 0 : t.rehypePlugins
+      const c = await F(u, "utf-8"), f = await L(c, l.file, {
+        remarkPlugins: e == null ? void 0 : e.remarkPlugins,
+        rehypePlugins: e == null ? void 0 : e.rehypePlugins
       });
-      if (s.push(f), f.success ? n++ : c++, t != null && t.onProgress && t.onProgress(a + 1, i.length, f), t != null && t.failFast && !f.success)
+      if (s.push(f), f.success ? n++ : a++, e != null && e.onProgress && e.onProgress(o + 1, i.length, f), e != null && e.failFast && !f.success)
         break;
-    } catch (o) {
-      const f = o instanceof Error ? o.message : "Unknown error reading file", h = {
+    } catch (c) {
+      const f = c instanceof Error ? c.message : "Unknown error reading file", m = {
         filePath: l.file,
         success: !1,
         error: `Failed to read file: ${f}`,
         compilationTime: 0
       };
-      if (s.push(h), c++, t != null && t.onProgress && t.onProgress(a + 1, i.length, h), t != null && t.failFast)
+      if (s.push(m), a++, e != null && e.onProgress && e.onProgress(o + 1, i.length, m), e != null && e.failFast)
         break;
     }
   }
@@ -155,47 +157,103 @@ async function O(r, t) {
     packageId: r.id,
     totalFiles: s.length,
     passed: n,
-    failed: c,
+    failed: a,
     results: s,
-    totalTime: performance.now() - e
+    totalTime: performance.now() - t
+  };
+}
+const C = ["warning", "info", "tip", "note", "caution", "danger"], j = new RegExp(
+  `^:::(${C.join("|")}) ([A-Z].*)$`
+);
+function K(r, e) {
+  const t = performance.now(), i = [], s = P(r);
+  let n = 0;
+  for (const a of s) {
+    if (!a.file) continue;
+    n++;
+    const l = I(a.file, "utf-8").split(`
+`);
+    for (let u = 0; u < l.length; u++) {
+      const c = l[u], f = c.match(j);
+      if (f) {
+        const [, m, h] = f, p = {
+          file: r.basePath ? x(r.basePath, a.file) : a.file,
+          absolutePath: a.file,
+          line: u + 1,
+          column: 1,
+          content: c.trim(),
+          admonitionType: m,
+          label: h,
+          suggestion: `:::${m}[${h}]`
+        };
+        if (i.push(p), e != null && e.onError && e.onError(p), e != null && e.failFast && i.length > 0)
+          return {
+            packageId: r.id,
+            filesScanned: n,
+            errors: i,
+            totalTime: performance.now() - t
+          };
+      }
+    }
+  }
+  return {
+    packageId: r.id,
+    filesScanned: n,
+    errors: i,
+    totalTime: performance.now() - t
   };
 }
-function X(r, t = !1) {
+function Z(r) {
   const e = [];
-  e.push(""), e.push(`MDX Compilation Report: ${r.packageId}`), e.push("=".repeat(50)), e.push("");
+  if (e.push(""), e.push(`Admonition Syntax Report: ${r.packageId}`), e.push("=".repeat(50)), e.push(""), e.push(`Files scanned: ${r.filesScanned}`), e.push(`Errors found: ${r.errors.length}`), e.push(`Total time: ${r.totalTime.toFixed(2)}ms`), e.push(""), r.errors.length === 0)
+    return e.push("All admonitions use correct bracket syntax!"), e.push(""), e.join(`
+`);
+  e.push("Errors:"), e.push("-".repeat(50)), e.push("");
+  for (const t of r.errors)
+    e.push(`  ${t.file}:${t.line}`), e.push(`    ${t.content}`), e.push(`    Fix: ${t.suggestion}`), e.push("");
+  return e.push("Admonitions with custom titles must use bracket syntax:"), e.push("  Before: :::warning Deprecated"), e.push("  After:  :::warning[Deprecated]"), e.push(""), e.push("See: https://github.com/remarkjs/remark-directive"), e.push(""), e.join(`
+`);
+}
+function q(r, e = !1) {
+  const t = [];
+  t.push(""), t.push(`MDX Compilation Report: ${r.packageId}`), t.push("=".repeat(50)), t.push("");
   const i = r.totalFiles > 0 ? (r.passed / r.totalFiles * 100).toFixed(1) : "0";
-  if (e.push(`Total files: ${r.totalFiles}`), e.push(`Passed: ${r.passed} (${i}%)`), e.push(`Failed: ${r.failed}`), e.push(`Total time: ${r.totalTime.toFixed(2)}ms`), e.push(""), t) {
-    e.push("Results:"), e.push("-".repeat(50));
+  if (t.push(`Total files: ${r.totalFiles}`), t.push(`Passed: ${r.passed} (${i}%)`), t.push(`Failed: ${r.failed}`), t.push(`Total time: ${r.totalTime.toFixed(2)}ms`), t.push(""), e) {
+    t.push("Results:"), t.push("-".repeat(50));
     for (const s of r.results) {
-      const n = s.success ? "[PASS]" : "[FAIL]", c = `(${s.compilationTime.toFixed(2)}ms)`;
-      if (e.push(`${n} ${s.filePath} ${c}`), !s.success && s.error) {
-        const a = s.line ? ` (line ${s.line}${s.column ? `:${s.column}` : ""})` : "";
-        e.push(`       Error${a}: ${s.error}`);
+      const n = s.success ? "[PASS]" : "[FAIL]", a = `(${s.compilationTime.toFixed(2)}ms)`;
+      if (t.push(`${n} ${s.filePath} ${a}`), !s.success && s.error) {
+        const o = s.line ? ` (line ${s.line}${s.column ? `:${s.column}` : ""})` : "";
+        t.push(`       Error${o}: ${s.error}`);
       }
     }
   } else if (r.failed > 0) {
-    e.push("Failures:"), e.push("-".repeat(50));
+    t.push("Failures:"), t.push("-".repeat(50));
     for (const s of r.results.filter((n) => !n.success))
-      if (e.push(`[FAIL] ${s.filePath}`), s.error) {
+      if (t.push(`[FAIL] ${s.filePath}`), s.error) {
         const n = s.line ? ` (line ${s.line}${s.column ? `:${s.column}` : ""})` : "";
-        e.push(`       Error${n}: ${s.error}`);
+        t.push(`       Error${n}: ${s.error}`);
       }
   }
-  return e.push(""), r.failed === 0 ? e.push("All MDX files compiled successfully!") : e.push(`${r.failed} file(s) failed to compile.`), e.push(""), e.join(`
+  return t.push(""), r.failed === 0 ? t.push("All MDX files compiled successfully!") : t.push(`${r.failed} file(s) failed to compile.`), t.push(""), t.join(`
 `);
 }
-function B() {
-  return (r, t, e) => {
-    const i = e.success ? "✓" : "✗", s = (r / t * 100).toFixed(0);
-    process.stdout.write(`\r[${r}/${t}] (${s}%) ${i} ${e.filePath}`), process.stdout.write("\x1B[K"), r === t && process.stdout.write(`
+function z() {
+  return (r, e, t) => {
+    const i = t.success ? "✓" : "✗", s = (r / e * 100).toFixed(0);
+    process.stdout.write(`\r[${r}/${e}] (${s}%) ${i} ${t.filePath}`), process.stdout.write("\x1B[K"), r === e && process.stdout.write(`
 `);
   };
 }
 export {
+  C as ADMONITION_TYPES,
+  j as INVALID_ADMONITION_PATTERN,
   L as compileMdx,
-  B as createProgressReporter,
-  X as formatTestReport,
-  C as getDefaultRehypePlugins,
-  S as getDefaultRemarkPlugins,
-  O as testManifestMdx
+  z as createProgressReporter,
+  Z as formatAdmonitionReport,
+  q as formatTestReport,
+  N as getDefaultRehypePlugins,
+  M as getDefaultRemarkPlugins,
+  H as testManifestMdx,
+  K as validateAdmonitions
 };

package/docs/last-modified-dates.md

@@ -95,11 +95,9 @@ const resolvedManifest = resolveManifest(manifestInput)
 // Apply dates from the generated file
 export const manifest = {
   ...resolvedManifest,
-  navigation: applyLastModifiedDates(
-    resolvedManifest.navigation,
-    lastModifiedDates,
-    { basePath: 'docs' }
-  ),
+  navigation: applyLastModifiedDates(resolvedManifest.navigation, lastModifiedDates, {
+    basePath: 'docs',
+  }),
 }
 ```
 
@@ -162,12 +160,12 @@ Applies dates from a map to navigation nodes. This function is browser-safe and
 import { applyLastModifiedDates } from '@vendure-io/docs-provider'
 
 const navigationWithDates = applyLastModifiedDates(
-  navigation,           // NavigationNode[]
-  lastModifiedDates,    // Record<string, string>
+  navigation, // NavigationNode[]
+  lastModifiedDates, // Record<string, string>
   {
     // Optional: prefix to prepend to file paths when looking up dates
-    basePath: 'docs'
-  }
+    basePath: 'docs',
+  },
 )
 ```
 
@@ -194,15 +192,14 @@ const isGit = await isGitRepository('/path/to/dir')
 
 // Get date for a single file
 const date = await getGitLastModified('docs/intro.mdx', {
-  cwd: '/path/to/repo'
+  cwd: '/path/to/repo',
 })
 // Returns: '2024-01-15T10:30:00+01:00' or null
 
 // Get dates for multiple files efficiently
-const result = await getGitLastModifiedBatch(
-  ['docs/intro.mdx', 'docs/guide.mdx'],
-  { cwd: '/path/to/repo' }
-)
+const result = await getGitLastModifiedBatch(['docs/intro.mdx', 'docs/guide.mdx'], {
+  cwd: '/path/to/repo',
+})
 // Returns: { dates: { 'docs/intro.mdx': '2024-...' }, skipped: [] }
 ```
 
@@ -215,6 +212,7 @@ All dates use ISO 8601 format with timezone offset:
 ```
 
 This format is:
+
 - Human-readable
 - Machine-parseable
 - Timezone-aware
@@ -229,6 +227,7 @@ Files not yet committed to git will be skipped (no date assigned). This is inten
 ### Non-Git Directories
 
 If `generateDatesFile` is run outside a git repository:
+
 - A warning is logged
 - An empty dates file is generated
 - No errors are thrown

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendure-io/docs-provider",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Contract types and utilities for Vendure documentation packages",
   "private": false,
   "publishConfig": {