@vendure-io/docs-provider 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -5
- package/dist/browser.cjs +1 -0
- package/dist/browser.d.ts +10 -0
- package/dist/browser.d.ts.map +1 -0
- package/dist/browser.js +30 -0
- package/dist/frontmatter-8Bwpoi8r.js +56 -0
- package/dist/frontmatter-_wRoVeyd.cjs +3 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +143 -155
- package/dist/loader.cjs +1 -1
- package/dist/loader.js +17 -16
- package/dist/manifest-B_cvT6F9.js +181 -0
- package/dist/manifest-D8kEDc9X.cjs +1 -0
- package/dist/manifest-resolver.d.ts.map +1 -1
- package/dist/mdx-components.d.ts +26 -3
- package/dist/mdx-components.d.ts.map +1 -1
- package/dist/navigation-utils.d.ts +16 -1
- package/dist/navigation-utils.d.ts.map +1 -1
- package/dist/schema.d.ts +29 -6
- package/dist/schema.d.ts.map +1 -1
- package/dist/slug-utils-DUQgikEz.cjs +1 -0
- package/dist/slug-utils-DVKYe9h8.js +31 -0
- package/dist/types.d.ts +4 -0
- package/dist/types.d.ts.map +1 -1
- package/docs/manifest-reference.md +85 -7
- package/docs/mdx-components-reference.md +46 -0
- package/package.json +11 -1
- package/dist/manifest-BYUKRuRu.cjs +0 -3
- package/dist/manifest-CVIfw0ha.js +0 -228
package/dist/loader.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";var
|
|
1
|
+
"use strict";var f=Object.defineProperty;var g=(e,r,t)=>r in e?f(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>g(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("fs/promises"),P=require("module"),m=require("./frontmatter-_wRoVeyd.cjs"),p=require("./manifest-D8kEDc9X.cjs");var c=typeof document<"u"?document.currentScript:null;class a extends Error{constructor(t,n){super(t);i(this,"packageName");this.name="DocsPackageLoadError",this.packageName=n}}async function $(e,r={}){try{const t=r.resolver?await r.resolver(e):u(e),n=await import(e);if(!n.manifest)throw new a(`Package "${e}" does not export a manifest`,e);return{manifest:p.validateManifest(n.manifest),basePath:t}}catch(t){throw t instanceof a?t:new a(`Failed to load docs package "${e}": ${t instanceof Error?t.message:String(t)}`,e)}}function u(e){try{return P.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("loader.cjs",document.baseURI).href).resolve(`${e}/package.json`).replace(/\/package\.json$/,"")}catch{throw new a(`Cannot resolve package "${e}". Make sure it is installed.`,e)}}async function l(e,r){try{const t=`${e.basePath}/${r}`,n=await h.readFile(t,"utf-8"),{meta:o,content:s}=m.parseFrontmatter(n,r);return{meta:o,content:s,filePath:r}}catch(t){throw new a(`Failed to load doc page "${r}": ${t instanceof Error?t.message:String(t)}`,e.manifest.id)}}async function v(e,r){const t=d(e.manifest.navigation,r.split("/"));if(t!=null&&t.file)return l(e,t.file)}function d(e,r){if(r.length===0)return;const[t,...n]=r,o=e.find(s=>s.slug===t);if(o){if(n.length===0)return o;if(o.children)return d(o.children,n)}}function y(e,r){if(r.file)return`${e.basePath}/${r.file}`}function w(e){try{return u(e),!0}catch{return!1}}exports.DocsPackageLoadError=a;exports.isDocsPackageInstalled=w;exports.loadDocPage=l;exports.loadDocPageBySlug=v;exports.loadDocsPackage=$;exports.resolveFilePath=y;
|
package/dist/loader.js
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
var
|
|
2
|
-
var l = (t, e, r) => e in t ?
|
|
1
|
+
var u = Object.defineProperty;
|
|
2
|
+
var l = (t, e, r) => e in t ? u(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
|
|
3
3
|
var i = (t, e, r) => l(t, typeof e != "symbol" ? e + "" : e, r);
|
|
4
4
|
import { readFile as d } from "fs/promises";
|
|
5
5
|
import { createRequire as h } from "module";
|
|
6
|
-
import {
|
|
6
|
+
import { p as g } from "./frontmatter-8Bwpoi8r.js";
|
|
7
|
+
import { v as m } from "./manifest-B_cvT6F9.js";
|
|
7
8
|
class a extends Error {
|
|
8
9
|
constructor(r, n) {
|
|
9
10
|
super(r);
|
|
@@ -11,7 +12,7 @@ class a extends Error {
|
|
|
11
12
|
this.name = "DocsPackageLoadError", this.packageName = n;
|
|
12
13
|
}
|
|
13
14
|
}
|
|
14
|
-
async function
|
|
15
|
+
async function k(t, e = {}) {
|
|
15
16
|
try {
|
|
16
17
|
const r = e.resolver ? await e.resolver(t) : c(t), n = await import(t);
|
|
17
18
|
if (!n.manifest)
|
|
@@ -20,7 +21,7 @@ async function y(t, e = {}) {
|
|
|
20
21
|
t
|
|
21
22
|
);
|
|
22
23
|
return {
|
|
23
|
-
manifest:
|
|
24
|
+
manifest: m(n.manifest),
|
|
24
25
|
basePath: r
|
|
25
26
|
};
|
|
26
27
|
} catch (r) {
|
|
@@ -42,7 +43,7 @@ function c(t) {
|
|
|
42
43
|
}
|
|
43
44
|
async function p(t, e) {
|
|
44
45
|
try {
|
|
45
|
-
const r = `${t.basePath}/${e}`, n = await d(r, "utf-8"), { meta: o, content: s } =
|
|
46
|
+
const r = `${t.basePath}/${e}`, n = await d(r, "utf-8"), { meta: o, content: s } = g(n, e);
|
|
46
47
|
return {
|
|
47
48
|
meta: o,
|
|
48
49
|
content: s,
|
|
@@ -55,25 +56,25 @@ async function p(t, e) {
|
|
|
55
56
|
);
|
|
56
57
|
}
|
|
57
58
|
}
|
|
58
|
-
async function
|
|
59
|
-
const r =
|
|
59
|
+
async function D(t, e) {
|
|
60
|
+
const r = f(t.manifest.navigation, e.split("/"));
|
|
60
61
|
if (r != null && r.file)
|
|
61
62
|
return p(t, r.file);
|
|
62
63
|
}
|
|
63
|
-
function
|
|
64
|
+
function f(t, e) {
|
|
64
65
|
if (e.length === 0) return;
|
|
65
66
|
const [r, ...n] = e, o = t.find((s) => s.slug === r);
|
|
66
67
|
if (o) {
|
|
67
68
|
if (n.length === 0) return o;
|
|
68
69
|
if (o.children)
|
|
69
|
-
return
|
|
70
|
+
return f(o.children, n);
|
|
70
71
|
}
|
|
71
72
|
}
|
|
72
|
-
function
|
|
73
|
+
function E(t, e) {
|
|
73
74
|
if (e.file)
|
|
74
75
|
return `${t.basePath}/${e.file}`;
|
|
75
76
|
}
|
|
76
|
-
function
|
|
77
|
+
function F(t) {
|
|
77
78
|
try {
|
|
78
79
|
return c(t), !0;
|
|
79
80
|
} catch {
|
|
@@ -82,9 +83,9 @@ function E(t) {
|
|
|
82
83
|
}
|
|
83
84
|
export {
|
|
84
85
|
a as DocsPackageLoadError,
|
|
85
|
-
|
|
86
|
+
F as isDocsPackageInstalled,
|
|
86
87
|
p as loadDocPage,
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
D as loadDocPageBySlug,
|
|
89
|
+
k as loadDocsPackage,
|
|
90
|
+
E as resolveFilePath
|
|
90
91
|
};
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
var P = Object.defineProperty;
|
|
2
|
+
var S = (i, t, e) => t in i ? P(i, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : i[t] = e;
|
|
3
|
+
var g = (i, t, e) => S(i, typeof t != "symbol" ? t + "" : t, e);
|
|
4
|
+
import { z as n } from "zod";
|
|
5
|
+
const d = n.enum(["v1", "v2", "v3"]), u = n.object({
|
|
6
|
+
indexFields: n.array(n.enum(["title", "description", "content", "keywords"])),
|
|
7
|
+
boosts: n.record(n.string(), n.number()).optional()
|
|
8
|
+
}), h = n.object({
|
|
9
|
+
repository: n.string().regex(/^[^/]+\/[^/]+$/, 'Repository must be in format "owner/repo"'),
|
|
10
|
+
branch: n.string().optional(),
|
|
11
|
+
docsPath: n.string().optional()
|
|
12
|
+
}), c = n.lazy(
|
|
13
|
+
() => n.object({
|
|
14
|
+
title: n.string().min(1, "Navigation title is required"),
|
|
15
|
+
slug: n.string().min(1, "Navigation slug is required"),
|
|
16
|
+
file: n.string().optional(),
|
|
17
|
+
children: n.array(c).optional(),
|
|
18
|
+
badge: n.string().optional(),
|
|
19
|
+
hidden: n.boolean().optional()
|
|
20
|
+
})
|
|
21
|
+
), f = n.object({
|
|
22
|
+
id: n.string().min(1, "Package ID is required"),
|
|
23
|
+
name: n.string().min(1, "Package name is required"),
|
|
24
|
+
version: n.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
|
|
25
|
+
vendureVersion: d,
|
|
26
|
+
navigation: n.array(c),
|
|
27
|
+
search: u.optional(),
|
|
28
|
+
github: h.optional(),
|
|
29
|
+
basePath: n.string().optional()
|
|
30
|
+
}), y = n.object({
|
|
31
|
+
title: n.string().min(1, "Page title is required"),
|
|
32
|
+
description: n.string().optional(),
|
|
33
|
+
keywords: n.array(n.string()).optional(),
|
|
34
|
+
sidebarLabel: n.string().optional(),
|
|
35
|
+
hidden: n.boolean().optional(),
|
|
36
|
+
order: n.number().int().optional()
|
|
37
|
+
}), I = n.object({
|
|
38
|
+
meta: y,
|
|
39
|
+
content: n.string(),
|
|
40
|
+
filePath: n.string()
|
|
41
|
+
}), q = n.object({
|
|
42
|
+
manifest: f,
|
|
43
|
+
basePath: n.string()
|
|
44
|
+
}), B = n.object({
|
|
45
|
+
title: n.string(),
|
|
46
|
+
slug: n.string(),
|
|
47
|
+
path: n.string()
|
|
48
|
+
}), M = n.object({
|
|
49
|
+
title: n.string(),
|
|
50
|
+
slug: n.string(),
|
|
51
|
+
file: n.string().optional(),
|
|
52
|
+
children: n.array(n.lazy(() => c)).optional(),
|
|
53
|
+
badge: n.string().optional(),
|
|
54
|
+
hidden: n.boolean().optional(),
|
|
55
|
+
path: n.string(),
|
|
56
|
+
depth: n.number().int().min(0),
|
|
57
|
+
parentPath: n.string().optional()
|
|
58
|
+
}), m = n.lazy(
|
|
59
|
+
() => n.object({
|
|
60
|
+
title: n.string().min(1).optional(),
|
|
61
|
+
slug: n.string().min(1).optional(),
|
|
62
|
+
file: n.string().optional(),
|
|
63
|
+
children: n.array(m).optional(),
|
|
64
|
+
badge: n.string().optional(),
|
|
65
|
+
hidden: n.boolean().optional()
|
|
66
|
+
})
|
|
67
|
+
), $ = n.object({
|
|
68
|
+
id: n.string().min(1, "Package ID is required"),
|
|
69
|
+
name: n.string().min(1, "Package name is required"),
|
|
70
|
+
version: n.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
|
|
71
|
+
vendureVersion: d,
|
|
72
|
+
navigation: n.array(m),
|
|
73
|
+
search: u.optional(),
|
|
74
|
+
github: h.optional(),
|
|
75
|
+
basePath: n.string().optional()
|
|
76
|
+
});
|
|
77
|
+
class j extends Error {
|
|
78
|
+
constructor(e, o) {
|
|
79
|
+
super(e);
|
|
80
|
+
g(this, "issues");
|
|
81
|
+
this.name = "ManifestValidationError", this.issues = o;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
function w(i) {
|
|
85
|
+
const t = f.safeParse(i);
|
|
86
|
+
if (!t.success) {
|
|
87
|
+
const e = t.error.issues.map((o) => `${o.path.join(".")}: ${o.message}`);
|
|
88
|
+
throw new j("Invalid manifest", e);
|
|
89
|
+
}
|
|
90
|
+
return t.data;
|
|
91
|
+
}
|
|
92
|
+
function z(i, t) {
|
|
93
|
+
const e = t.split("/").filter(Boolean);
|
|
94
|
+
return p(i.navigation, e);
|
|
95
|
+
}
|
|
96
|
+
function p(i, t) {
|
|
97
|
+
if (t.length === 0) return;
|
|
98
|
+
const [e, ...o] = t, a = i.find((r) => r.slug === e);
|
|
99
|
+
if (a) {
|
|
100
|
+
if (o.length === 0) return a;
|
|
101
|
+
if (a.children)
|
|
102
|
+
return p(a.children, o);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
function b(i) {
|
|
106
|
+
const t = [];
|
|
107
|
+
return v(i.navigation, "", 0, void 0, t), t;
|
|
108
|
+
}
|
|
109
|
+
function v(i, t, e, o, a) {
|
|
110
|
+
for (const r of i) {
|
|
111
|
+
const s = t ? `${t}/${r.slug}` : r.slug;
|
|
112
|
+
a.push({
|
|
113
|
+
...r,
|
|
114
|
+
path: s,
|
|
115
|
+
depth: e,
|
|
116
|
+
parentPath: o
|
|
117
|
+
}), r.children && r.children.length > 0 && v(r.children, s, e + 1, s, a);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
function L(i, t) {
|
|
121
|
+
const e = t.split("/").filter(Boolean), o = [];
|
|
122
|
+
let a = i.navigation, r = "";
|
|
123
|
+
for (const s of e) {
|
|
124
|
+
const l = a.find((N) => N.slug === s);
|
|
125
|
+
if (!l) break;
|
|
126
|
+
r = r ? `${r}/${s}` : s, o.push({
|
|
127
|
+
title: l.title,
|
|
128
|
+
slug: l.slug,
|
|
129
|
+
path: r
|
|
130
|
+
}), a = l.children ?? [];
|
|
131
|
+
}
|
|
132
|
+
return o;
|
|
133
|
+
}
|
|
134
|
+
function k(i) {
|
|
135
|
+
return b(i).filter((t) => t.file !== void 0);
|
|
136
|
+
}
|
|
137
|
+
function E(i, t) {
|
|
138
|
+
const e = k(i), o = e.findIndex((a) => a.path === t);
|
|
139
|
+
return o === -1 ? {} : {
|
|
140
|
+
prev: o > 0 ? e[o - 1] : void 0,
|
|
141
|
+
next: o < e.length - 1 ? e[o + 1] : void 0
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
function x(i, t) {
|
|
145
|
+
const e = t.split("/").filter(Boolean);
|
|
146
|
+
if (e.length === 0) return !1;
|
|
147
|
+
if (i.slug === e[0]) {
|
|
148
|
+
if (e.length === 1) return !0;
|
|
149
|
+
if (i.children) {
|
|
150
|
+
const o = e.slice(1).join("/");
|
|
151
|
+
return i.children.some((a) => x(a, o));
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
return !1;
|
|
155
|
+
}
|
|
156
|
+
function F(i, t) {
|
|
157
|
+
return b(i).filter((e) => e.depth === t);
|
|
158
|
+
}
|
|
159
|
+
export {
|
|
160
|
+
B,
|
|
161
|
+
y as D,
|
|
162
|
+
M as F,
|
|
163
|
+
h as G,
|
|
164
|
+
q as L,
|
|
165
|
+
j as M,
|
|
166
|
+
m as N,
|
|
167
|
+
u as S,
|
|
168
|
+
d as V,
|
|
169
|
+
I as a,
|
|
170
|
+
$ as b,
|
|
171
|
+
f as c,
|
|
172
|
+
c as d,
|
|
173
|
+
L as e,
|
|
174
|
+
z as f,
|
|
175
|
+
b as g,
|
|
176
|
+
k as h,
|
|
177
|
+
F as i,
|
|
178
|
+
E as j,
|
|
179
|
+
x as k,
|
|
180
|
+
w as v
|
|
181
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";var D=Object.defineProperty;var j=(i,t,n)=>t in i?D(i,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):i[t]=n;var f=(i,t,n)=>j(i,typeof t!="symbol"?t+"":t,n);const e=require("zod"),g=e.z.enum(["v1","v2","v3"]),d=e.z.object({indexFields:e.z.array(e.z.enum(["title","description","content","keywords"])),boosts:e.z.record(e.z.string(),e.z.number()).optional()}),u=e.z.object({repository:e.z.string().regex(/^[^/]+\/[^/]+$/,'Repository must be in format "owner/repo"'),branch:e.z.string().optional(),docsPath:e.z.string().optional()}),l=e.z.lazy(()=>e.z.object({title:e.z.string().min(1,"Navigation title is required"),slug:e.z.string().min(1,"Navigation slug is required"),file:e.z.string().optional(),children:e.z.array(l).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional()})),h=e.z.object({id:e.z.string().min(1,"Package ID is required"),name:e.z.string().min(1,"Package name is required"),version:e.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:g,navigation:e.z.array(l),search:d.optional(),github:u.optional(),basePath:e.z.string().optional()}),p=e.z.object({title:e.z.string().min(1,"Page title is required"),description:e.z.string().optional(),keywords:e.z.array(e.z.string()).optional(),sidebarLabel:e.z.string().optional(),hidden:e.z.boolean().optional(),order:e.z.number().int().optional()}),k=e.z.object({meta:p,content:e.z.string(),filePath:e.z.string()}),I=e.z.object({manifest:h,basePath:e.z.string()}),M=e.z.object({title:e.z.string(),slug:e.z.string(),path:e.z.string()}),V=e.z.object({title:e.z.string(),slug:e.z.string(),file:e.z.string().optional(),children:e.z.array(e.z.lazy(()=>l)).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional(),path:e.z.string(),depth:e.z.number().int().min(0),parentPath:e.z.string().optional()}),z=e.z.lazy(()=>e.z.object({title:e.z.string().min(1).optional(),slug:e.z.string().min(1).optional(),file:e.z.string().optional(),children:e.z.array(z).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional()})),x=e.z.object({id:e.z.string().min(1,"Package ID is required"),name:e.z.string().min(1,"Package name is required"),version:e.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:g,navigation:e.z.array(z),search:d.optional(),github:u.optional(),basePath:e.z.string().optional()});class b extends Error{constructor(n,o){super(n);f(this,"issues");this.name="ManifestValidationError",this.issues=o}}function q(i){const t=h.safeParse(i);if(!t.success){const n=t.error.issues.map(o=>`${o.path.join(".")}: ${o.message}`);throw new b("Invalid manifest",n)}return t.data}function B(i,t){const n=t.split("/").filter(Boolean);return v(i.navigation,n)}function v(i,t){if(t.length===0)return;const[n,...o]=t,a=i.find(r=>r.slug===n);if(a){if(o.length===0)return a;if(a.children)return v(a.children,o)}}function m(i){const t=[];return N(i.navigation,"",0,void 0,t),t}function N(i,t,n,o,a){for(const r of i){const s=t?`${t}/${r.slug}`:r.slug;a.push({...r,path:s,depth:n,parentPath:o}),r.children&&r.children.length>0&&N(r.children,s,n+1,s,a)}}function $(i,t){const n=t.split("/").filter(Boolean),o=[];let a=i.navigation,r="";for(const s of n){const c=a.find(y=>y.slug===s);if(!c)break;r=r?`${r}/${s}`:s,o.push({title:c.title,slug:c.slug,path:r}),a=c.children??[]}return o}function S(i){return m(i).filter(t=>t.file!==void 0)}function w(i,t){const n=S(i),o=n.findIndex(a=>a.path===t);return o===-1?{}:{prev:o>0?n[o-1]:void 0,next:o<n.length-1?n[o+1]:void 0}}function P(i,t){const n=t.split("/").filter(Boolean);if(n.length===0)return!1;if(i.slug===n[0]){if(n.length===1)return!0;if(i.children){const o=n.slice(1).join("/");return i.children.some(a=>P(a,o))}}return!1}function L(i,t){return m(i).filter(n=>n.depth===t)}exports.BreadcrumbItemSchema=M;exports.DocPageMetaSchema=p;exports.DocPageSchema=k;exports.DocsPackageManifestInputSchema=x;exports.DocsPackageManifestSchema=h;exports.FlatNavigationNodeSchema=V;exports.GitHubConfigSchema=u;exports.LoadedDocsPackageSchema=I;exports.ManifestValidationError=b;exports.NavigationNodeInputSchema=z;exports.NavigationNodeSchema=l;exports.SearchConfigSchema=d;exports.VendureVersionSchema=g;exports.buildBreadcrumbs=$;exports.findNavigationNode=B;exports.flattenNavigation=m;exports.getLeafNodes=S;exports.getNodesAtDepth=L;exports.getPrevNextNodes=w;exports.isNodeActive=P;exports.validateManifest=q;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest-resolver.d.ts","sourceRoot":"","sources":["../src/manifest-resolver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EAGzB,MAAM,SAAS,CAAA;AAEhB;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,aAAa,CAAC,EAAE,OAAO,CAAA;gBAE3B,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO;CAO3F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,wBAAwB,EAC/B,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CAerB;
|
|
1
|
+
{"version":3,"file":"manifest-resolver.d.ts","sourceRoot":"","sources":["../src/manifest-resolver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EAGzB,MAAM,SAAS,CAAA;AAEhB;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,aAAa,CAAC,EAAE,OAAO,CAAA;gBAE3B,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO;CAO3F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,wBAAwB,EAC/B,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CAerB;AAwHD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAEhF"}
|
package/dist/mdx-components.d.ts
CHANGED
|
@@ -51,8 +51,8 @@ export interface GenerationInfoProps {
|
|
|
51
51
|
* ```
|
|
52
52
|
*/
|
|
53
53
|
export interface MemberInfoProps {
|
|
54
|
-
/** Member kind: method, property, getter, setter, constructor */
|
|
55
|
-
kind: 'method' | 'property' | 'getter' | 'setter' | 'constructor';
|
|
54
|
+
/** Member kind: method, property, getter, setter, constructor, parameter */
|
|
55
|
+
kind: 'method' | 'property' | 'getter' | 'setter' | 'constructor' | 'parameter';
|
|
56
56
|
/** TypeScript type signature (accepts JSX with links) */
|
|
57
57
|
type: unknown;
|
|
58
58
|
/** Version when this member was introduced */
|
|
@@ -178,8 +178,31 @@ export interface LinkCardProps {
|
|
|
178
178
|
/** Additional content (alternative to subtitle for richer content) */
|
|
179
179
|
children?: unknown;
|
|
180
180
|
}
|
|
181
|
+
/**
|
|
182
|
+
* DocsLink Component
|
|
183
|
+
*
|
|
184
|
+
* An inline link component that automatically prefixes relative URLs with the
|
|
185
|
+
* current documentation version and package ID. This is the recommended way to
|
|
186
|
+
* create cross-references in generated documentation.
|
|
187
|
+
*
|
|
188
|
+
* Key features:
|
|
189
|
+
* - Relative paths (starting with `/`) are automatically prefixed with `/{version}/{packageId}`
|
|
190
|
+
* - Uses Next.js Link for client-side navigation (no full page reload)
|
|
191
|
+
* - External links open in a new tab
|
|
192
|
+
*
|
|
193
|
+
* @example
|
|
194
|
+
* ```mdx
|
|
195
|
+
* See the <DocsLink href="/reference/typescript-api/request/request-context">RequestContext</DocsLink> docs.
|
|
196
|
+
* ```
|
|
197
|
+
*/
|
|
198
|
+
export interface DocsLinkProps {
|
|
199
|
+
/** URL to navigate to (relative paths will be prefixed with version/packageId) */
|
|
200
|
+
href: string;
|
|
201
|
+
/** Link text content */
|
|
202
|
+
children: unknown;
|
|
203
|
+
}
|
|
181
204
|
/**
|
|
182
205
|
* Union type of all MDX component props for type checking
|
|
183
206
|
*/
|
|
184
|
-
export type MdxComponentProps = GenerationInfoProps | MemberInfoProps | MemberDescriptionProps | CustomFieldPropertyProps | StackblitzProps | GraphQLDocProps | LinkCardProps;
|
|
207
|
+
export type MdxComponentProps = GenerationInfoProps | MemberInfoProps | MemberDescriptionProps | CustomFieldPropertyProps | StackblitzProps | GraphQLDocProps | LinkCardProps | DocsLinkProps;
|
|
185
208
|
//# sourceMappingURL=mdx-components.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mdx-components.d.ts","sourceRoot":"","sources":["../src/mdx-components.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAA;IACnB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,eAAe;IAC9B,
|
|
1
|
+
{"version":3,"file":"mdx-components.d.ts","sourceRoot":"","sources":["../src/mdx-components.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAA;IACnB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,eAAe;IAC9B,4EAA4E;IAC5E,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,WAAW,CAAA;IAC/E,yDAAyD;IACzD,IAAI,EAAE,OAAO,CAAA;IACb,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAA;IACjB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,IAAI,EACA,UAAU,GACV,OAAO,GACP,cAAc,GACd,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,OAAO,GACP,UAAU,CAAA;IACd,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yBAAyB;IACzB,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC7B,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,0BAA0B;IAC1B,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC5B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAA;IACb,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAa;IAC5B,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,eAAe,GACf,sBAAsB,GACtB,wBAAwB,GACxB,eAAe,GACf,eAAe,GACf,aAAa,GACb,aAAa,CAAA"}
|
|
@@ -1,4 +1,19 @@
|
|
|
1
|
-
import { DocsPackageManifest } from './types';
|
|
1
|
+
import { DocsPackageManifest, NavigationNode } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Filter navigation nodes to only include visible items (not hidden).
|
|
4
|
+
* Hidden nodes and their children are excluded from the result.
|
|
5
|
+
* The original navigation structure is preserved for URL-accessible routing.
|
|
6
|
+
*
|
|
7
|
+
* @param nodes - The navigation nodes to filter
|
|
8
|
+
* @returns Filtered navigation nodes with hidden items removed
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* const visibleNavigation = filterVisibleNavigation(manifest.navigation)
|
|
13
|
+
* // Use visibleNavigation for sidebar rendering
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
export declare function filterVisibleNavigation(nodes: NavigationNode[]): NavigationNode[];
|
|
2
17
|
/**
|
|
3
18
|
* Get all file paths from a manifest's navigation tree
|
|
4
19
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"navigation-utils.d.ts","sourceRoot":"","sources":["../src/navigation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,
|
|
1
|
+
{"version":3,"file":"navigation-utils.d.ts","sourceRoot":"","sources":["../src/navigation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAElE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE,CAOjF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM,EAAE,CAIvE"}
|
package/dist/schema.d.ts
CHANGED
|
@@ -41,6 +41,7 @@ export declare const NavigationNodeSchema: z.ZodType<{
|
|
|
41
41
|
file?: string;
|
|
42
42
|
children?: unknown[];
|
|
43
43
|
badge?: string;
|
|
44
|
+
hidden?: boolean;
|
|
44
45
|
}>;
|
|
45
46
|
/**
|
|
46
47
|
* Schema for documentation package manifest
|
|
@@ -56,12 +57,14 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
|
|
|
56
57
|
file?: string;
|
|
57
58
|
children?: unknown[];
|
|
58
59
|
badge?: string;
|
|
60
|
+
hidden?: boolean;
|
|
59
61
|
}, z.ZodTypeDef, {
|
|
60
62
|
title: string;
|
|
61
63
|
slug: string;
|
|
62
64
|
file?: string;
|
|
63
65
|
children?: unknown[];
|
|
64
66
|
badge?: string;
|
|
67
|
+
hidden?: boolean;
|
|
65
68
|
}>, "many">;
|
|
66
69
|
search: z.ZodOptional<z.ZodObject<{
|
|
67
70
|
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
@@ -98,6 +101,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
|
|
|
98
101
|
file?: string;
|
|
99
102
|
children?: unknown[];
|
|
100
103
|
badge?: string;
|
|
104
|
+
hidden?: boolean;
|
|
101
105
|
}[];
|
|
102
106
|
search?: {
|
|
103
107
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -120,6 +124,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
|
|
|
120
124
|
file?: string;
|
|
121
125
|
children?: unknown[];
|
|
122
126
|
badge?: string;
|
|
127
|
+
hidden?: boolean;
|
|
123
128
|
}[];
|
|
124
129
|
search?: {
|
|
125
130
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -146,15 +151,15 @@ export declare const DocPageMetaSchema: z.ZodObject<{
|
|
|
146
151
|
title: string;
|
|
147
152
|
description?: string | undefined;
|
|
148
153
|
keywords?: string[] | undefined;
|
|
149
|
-
sidebarLabel?: string | undefined;
|
|
150
154
|
hidden?: boolean | undefined;
|
|
155
|
+
sidebarLabel?: string | undefined;
|
|
151
156
|
order?: number | undefined;
|
|
152
157
|
}, {
|
|
153
158
|
title: string;
|
|
154
159
|
description?: string | undefined;
|
|
155
160
|
keywords?: string[] | undefined;
|
|
156
|
-
sidebarLabel?: string | undefined;
|
|
157
161
|
hidden?: boolean | undefined;
|
|
162
|
+
sidebarLabel?: string | undefined;
|
|
158
163
|
order?: number | undefined;
|
|
159
164
|
}>;
|
|
160
165
|
/**
|
|
@@ -172,15 +177,15 @@ export declare const DocPageSchema: z.ZodObject<{
|
|
|
172
177
|
title: string;
|
|
173
178
|
description?: string | undefined;
|
|
174
179
|
keywords?: string[] | undefined;
|
|
175
|
-
sidebarLabel?: string | undefined;
|
|
176
180
|
hidden?: boolean | undefined;
|
|
181
|
+
sidebarLabel?: string | undefined;
|
|
177
182
|
order?: number | undefined;
|
|
178
183
|
}, {
|
|
179
184
|
title: string;
|
|
180
185
|
description?: string | undefined;
|
|
181
186
|
keywords?: string[] | undefined;
|
|
182
|
-
sidebarLabel?: string | undefined;
|
|
183
187
|
hidden?: boolean | undefined;
|
|
188
|
+
sidebarLabel?: string | undefined;
|
|
184
189
|
order?: number | undefined;
|
|
185
190
|
}>;
|
|
186
191
|
content: z.ZodString;
|
|
@@ -191,8 +196,8 @@ export declare const DocPageSchema: z.ZodObject<{
|
|
|
191
196
|
title: string;
|
|
192
197
|
description?: string | undefined;
|
|
193
198
|
keywords?: string[] | undefined;
|
|
194
|
-
sidebarLabel?: string | undefined;
|
|
195
199
|
hidden?: boolean | undefined;
|
|
200
|
+
sidebarLabel?: string | undefined;
|
|
196
201
|
order?: number | undefined;
|
|
197
202
|
};
|
|
198
203
|
filePath: string;
|
|
@@ -202,8 +207,8 @@ export declare const DocPageSchema: z.ZodObject<{
|
|
|
202
207
|
title: string;
|
|
203
208
|
description?: string | undefined;
|
|
204
209
|
keywords?: string[] | undefined;
|
|
205
|
-
sidebarLabel?: string | undefined;
|
|
206
210
|
hidden?: boolean | undefined;
|
|
211
|
+
sidebarLabel?: string | undefined;
|
|
207
212
|
order?: number | undefined;
|
|
208
213
|
};
|
|
209
214
|
filePath: string;
|
|
@@ -223,12 +228,14 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
|
223
228
|
file?: string;
|
|
224
229
|
children?: unknown[];
|
|
225
230
|
badge?: string;
|
|
231
|
+
hidden?: boolean;
|
|
226
232
|
}, z.ZodTypeDef, {
|
|
227
233
|
title: string;
|
|
228
234
|
slug: string;
|
|
229
235
|
file?: string;
|
|
230
236
|
children?: unknown[];
|
|
231
237
|
badge?: string;
|
|
238
|
+
hidden?: boolean;
|
|
232
239
|
}>, "many">;
|
|
233
240
|
search: z.ZodOptional<z.ZodObject<{
|
|
234
241
|
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
@@ -265,6 +272,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
|
265
272
|
file?: string;
|
|
266
273
|
children?: unknown[];
|
|
267
274
|
badge?: string;
|
|
275
|
+
hidden?: boolean;
|
|
268
276
|
}[];
|
|
269
277
|
search?: {
|
|
270
278
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -287,6 +295,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
|
287
295
|
file?: string;
|
|
288
296
|
children?: unknown[];
|
|
289
297
|
badge?: string;
|
|
298
|
+
hidden?: boolean;
|
|
290
299
|
}[];
|
|
291
300
|
search?: {
|
|
292
301
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -313,6 +322,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
|
313
322
|
file?: string;
|
|
314
323
|
children?: unknown[];
|
|
315
324
|
badge?: string;
|
|
325
|
+
hidden?: boolean;
|
|
316
326
|
}[];
|
|
317
327
|
search?: {
|
|
318
328
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -338,6 +348,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
|
338
348
|
file?: string;
|
|
339
349
|
children?: unknown[];
|
|
340
350
|
badge?: string;
|
|
351
|
+
hidden?: boolean;
|
|
341
352
|
}[];
|
|
342
353
|
search?: {
|
|
343
354
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -380,14 +391,17 @@ export declare const FlatNavigationNodeSchema: z.ZodObject<{
|
|
|
380
391
|
file?: string;
|
|
381
392
|
children?: unknown[];
|
|
382
393
|
badge?: string;
|
|
394
|
+
hidden?: boolean;
|
|
383
395
|
}, z.ZodTypeDef, {
|
|
384
396
|
title: string;
|
|
385
397
|
slug: string;
|
|
386
398
|
file?: string;
|
|
387
399
|
children?: unknown[];
|
|
388
400
|
badge?: string;
|
|
401
|
+
hidden?: boolean;
|
|
389
402
|
}>>, "many">>;
|
|
390
403
|
badge: z.ZodOptional<z.ZodString>;
|
|
404
|
+
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
391
405
|
path: z.ZodString;
|
|
392
406
|
depth: z.ZodNumber;
|
|
393
407
|
parentPath: z.ZodOptional<z.ZodString>;
|
|
@@ -403,8 +417,10 @@ export declare const FlatNavigationNodeSchema: z.ZodObject<{
|
|
|
403
417
|
file?: string;
|
|
404
418
|
children?: unknown[];
|
|
405
419
|
badge?: string;
|
|
420
|
+
hidden?: boolean;
|
|
406
421
|
}[] | undefined;
|
|
407
422
|
badge?: string | undefined;
|
|
423
|
+
hidden?: boolean | undefined;
|
|
408
424
|
parentPath?: string | undefined;
|
|
409
425
|
}, {
|
|
410
426
|
title: string;
|
|
@@ -418,8 +434,10 @@ export declare const FlatNavigationNodeSchema: z.ZodObject<{
|
|
|
418
434
|
file?: string;
|
|
419
435
|
children?: unknown[];
|
|
420
436
|
badge?: string;
|
|
437
|
+
hidden?: boolean;
|
|
421
438
|
}[] | undefined;
|
|
422
439
|
badge?: string | undefined;
|
|
440
|
+
hidden?: boolean | undefined;
|
|
423
441
|
parentPath?: string | undefined;
|
|
424
442
|
}>;
|
|
425
443
|
/**
|
|
@@ -431,6 +449,7 @@ export declare const NavigationNodeInputSchema: z.ZodType<{
|
|
|
431
449
|
file?: string;
|
|
432
450
|
children?: unknown[];
|
|
433
451
|
badge?: string;
|
|
452
|
+
hidden?: boolean;
|
|
434
453
|
}>;
|
|
435
454
|
/**
|
|
436
455
|
* Schema for manifest input (with optional title/slug in navigation)
|
|
@@ -446,12 +465,14 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
|
|
|
446
465
|
file?: string;
|
|
447
466
|
children?: unknown[];
|
|
448
467
|
badge?: string;
|
|
468
|
+
hidden?: boolean;
|
|
449
469
|
}, z.ZodTypeDef, {
|
|
450
470
|
title?: string;
|
|
451
471
|
slug?: string;
|
|
452
472
|
file?: string;
|
|
453
473
|
children?: unknown[];
|
|
454
474
|
badge?: string;
|
|
475
|
+
hidden?: boolean;
|
|
455
476
|
}>, "many">;
|
|
456
477
|
search: z.ZodOptional<z.ZodObject<{
|
|
457
478
|
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
@@ -488,6 +509,7 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
|
|
|
488
509
|
file?: string;
|
|
489
510
|
children?: unknown[];
|
|
490
511
|
badge?: string;
|
|
512
|
+
hidden?: boolean;
|
|
491
513
|
}[];
|
|
492
514
|
search?: {
|
|
493
515
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
@@ -510,6 +532,7 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
|
|
|
510
532
|
file?: string;
|
|
511
533
|
children?: unknown[];
|
|
512
534
|
badge?: string;
|
|
535
|
+
hidden?: boolean;
|
|
513
536
|
}[];
|
|
514
537
|
search?: {
|
|
515
538
|
indexFields: ("title" | "description" | "content" | "keywords")[];
|
package/dist/schema.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CASA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;eApB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;;;;;;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;EAwBhB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;EAO5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;mBAvD3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;mBALT,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBALT,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;;;;;;;;;;;;;;;;;mBALT,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;;;;;;;;;;;;;;;;;;;;;mBALT,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;;;;;;;;;;;;;;;;;;;;mBALT,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;;;;;;;;;;;;;EAqDhB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eAxE5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;eALT,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;EA6EhB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CASA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;gBApBjC,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;gBALR,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBALR,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;;;;;;;gBALR,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;;;;;;;;;;;;EAwBhB,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACjF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function r(e){return e.filter(t=>!t.hidden).map(t=>({...t,children:t.children?r(t.children):void 0}))}function c(e){const t=[];return o(e.navigation,t),t}function o(e,t){for(const i of e)i.file&&t.push(i.file),i.children&&o(i.children,t)}function l(e){return e.toLowerCase().trim().replace(/[^\w\s-]/g,"").replace(/\s+/g,"-").replace(/-+/g,"-").replace(/^-|-$/g,"")}function s(e){const n=(e.split("/").pop()||e).replace(/\.(mdx?|md)$/i,"").replace(/^\d+-/,"");return l(n)}function u(e){return(e.split("/").pop()||e).replace(/\.(mdx?|md)$/i,"").replace(/^\d+-/,"").replace(/[-_]+/g," ").toLowerCase().replace(/\b\w/g,a=>a.toUpperCase()).trim()}exports.filterVisibleNavigation=r;exports.getAllFilePaths=c;exports.slugFromFilename=s;exports.titleFromFilename=u;exports.toSlug=l;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
function a(e) {
|
|
2
|
+
return e.filter((t) => !t.hidden).map((t) => ({
|
|
3
|
+
...t,
|
|
4
|
+
children: t.children ? a(t.children) : void 0
|
|
5
|
+
}));
|
|
6
|
+
}
|
|
7
|
+
function s(e) {
|
|
8
|
+
const t = [];
|
|
9
|
+
return r(e.navigation, t), t;
|
|
10
|
+
}
|
|
11
|
+
function r(e, t) {
|
|
12
|
+
for (const i of e)
|
|
13
|
+
i.file && t.push(i.file), i.children && r(i.children, t);
|
|
14
|
+
}
|
|
15
|
+
function c(e) {
|
|
16
|
+
return e.toLowerCase().trim().replace(/[^\w\s-]/g, "").replace(/\s+/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "");
|
|
17
|
+
}
|
|
18
|
+
function l(e) {
|
|
19
|
+
const n = (e.split("/").pop() || e).replace(/\.(mdx?|md)$/i, "").replace(/^\d+-/, "");
|
|
20
|
+
return c(n);
|
|
21
|
+
}
|
|
22
|
+
function u(e) {
|
|
23
|
+
return (e.split("/").pop() || e).replace(/\.(mdx?|md)$/i, "").replace(/^\d+-/, "").replace(/[-_]+/g, " ").toLowerCase().replace(/\b\w/g, (o) => o.toUpperCase()).trim();
|
|
24
|
+
}
|
|
25
|
+
export {
|
|
26
|
+
c as a,
|
|
27
|
+
a as f,
|
|
28
|
+
s as g,
|
|
29
|
+
l as s,
|
|
30
|
+
u as t
|
|
31
|
+
};
|
package/dist/types.d.ts
CHANGED
|
@@ -36,6 +36,8 @@ export interface NavigationNode {
|
|
|
36
36
|
children?: NavigationNode[];
|
|
37
37
|
/** Optional badge label (e.g., "New", "Beta", "Deprecated") */
|
|
38
38
|
badge?: string;
|
|
39
|
+
/** Hide this node from sidebar navigation (page remains URL-accessible) */
|
|
40
|
+
hidden?: boolean;
|
|
39
41
|
}
|
|
40
42
|
/**
|
|
41
43
|
* Manifest describing a documentation package's structure and metadata
|
|
@@ -132,6 +134,8 @@ export interface NavigationNodeInput {
|
|
|
132
134
|
children?: NavigationNodeInput[];
|
|
133
135
|
/** Optional badge label (e.g., "New", "Beta", "Deprecated") */
|
|
134
136
|
badge?: string;
|
|
137
|
+
/** Hide this node from sidebar navigation (page remains URL-accessible) */
|
|
138
|
+
hidden?: boolean;
|
|
135
139
|
}
|
|
136
140
|
/**
|
|
137
141
|
* Input type for manifest with optional title/slug in navigation nodes.
|