sourcey 3.6.4 → 3.6.5

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.
@@ -11,15 +11,15 @@
11
11
  // ── Language Dropdown ──────────────────────────────────────────────
12
12
 
13
13
  // Toggle dropdown open/close
14
- document.addEventListener('click', function (e) {
15
- var trigger = e.target.closest('.code-lang-trigger');
14
+ document.addEventListener("click", function (e) {
15
+ var trigger = e.target.closest(".code-lang-trigger");
16
16
 
17
17
  // Close all open dropdowns first
18
- document.querySelectorAll('.code-lang-menu').forEach(function (menu) {
18
+ document.querySelectorAll(".code-lang-menu").forEach(function (menu) {
19
19
  if (!trigger || !menu.parentElement.contains(trigger)) {
20
- menu.classList.add('hidden');
21
- var btn = menu.parentElement.querySelector('.code-lang-trigger');
22
- if (btn) btn.setAttribute('aria-expanded', 'false');
20
+ closeMenu(menu);
21
+ var btn = menu.parentElement.querySelector(".code-lang-trigger");
22
+ if (btn) btn.setAttribute("aria-expanded", "false");
23
23
  }
24
24
  });
25
25
 
@@ -29,26 +29,31 @@
29
29
  var menu = trigger.nextElementSibling;
30
30
  if (!menu) return;
31
31
 
32
- var isOpen = !menu.classList.contains('hidden');
33
- menu.classList.toggle('hidden', isOpen);
34
- trigger.setAttribute('aria-expanded', isOpen ? 'false' : 'true');
32
+ var isOpen = !menu.classList.contains("hidden");
33
+ if (isOpen) {
34
+ closeMenu(menu);
35
+ } else {
36
+ menu.classList.remove("hidden");
37
+ positionMenu(trigger, menu);
38
+ }
39
+ trigger.setAttribute("aria-expanded", isOpen ? "false" : "true");
35
40
  });
36
41
 
37
42
  // Select a language / example variant from the dropdown
38
- document.addEventListener('click', function (e) {
39
- var option = e.target.closest('.code-lang-option');
43
+ document.addEventListener("click", function (e) {
44
+ var option = e.target.closest(".code-lang-option");
40
45
  if (!option) return;
41
46
 
42
- var dropdown = option.closest('.code-lang-dropdown');
43
- var canSync = !!(dropdown && dropdown.hasAttribute('data-lang-sync'));
47
+ var dropdown = option.closest(".code-lang-dropdown");
48
+ var canSync = !!(dropdown && dropdown.hasAttribute("data-lang-sync"));
44
49
  var lang = option.textContent.trim();
45
50
 
46
51
  // Close the menu
47
- var menu = option.closest('.code-lang-menu');
52
+ var menu = option.closest(".code-lang-menu");
48
53
  if (menu) {
49
- menu.classList.add('hidden');
50
- var trigger = menu.parentElement.querySelector('.code-lang-trigger');
51
- if (trigger) trigger.setAttribute('aria-expanded', 'false');
54
+ closeMenu(menu);
55
+ var trigger = menu.parentElement.querySelector(".code-lang-trigger");
56
+ if (trigger) trigger.setAttribute("aria-expanded", "false");
52
57
  }
53
58
 
54
59
  var scrollY = window.scrollY;
@@ -57,10 +62,11 @@
57
62
  // Sync language across code-sample groups only (not example variants).
58
63
  if (canSync && lang !== selectedLang) {
59
64
  selectedLang = lang;
60
- var ownGroup = option.closest('.code-group');
61
- document.querySelectorAll('.code-group').forEach(function (group) {
62
- if (group === ownGroup || !group.querySelector('.code-lang-dropdown[data-lang-sync]')) return;
63
- group.querySelectorAll('.code-lang-option').forEach(function (opt) {
65
+ var ownGroup = option.closest(".code-group");
66
+ document.querySelectorAll(".code-group").forEach(function (group) {
67
+ if (group === ownGroup || !group.querySelector(".code-lang-dropdown[data-lang-sync]"))
68
+ return;
69
+ group.querySelectorAll(".code-lang-option").forEach(function (opt) {
64
70
  if (opt.textContent.trim() === lang) activateLang(opt);
65
71
  });
66
72
  });
@@ -69,78 +75,115 @@
69
75
  window.scrollTo(0, scrollY);
70
76
  });
71
77
 
78
+ function closeMenu(menu) {
79
+ menu.classList.add("hidden");
80
+ menu.style.position = "";
81
+ menu.style.top = "";
82
+ menu.style.right = "";
83
+ menu.style.bottom = "";
84
+ menu.style.maxHeight = "";
85
+ }
86
+
87
+ function positionMenu(trigger, menu) {
88
+ var rect = trigger.getBoundingClientRect();
89
+ var gap = 4;
90
+ var viewportPadding = 8;
91
+ var below = window.innerHeight - rect.bottom - viewportPadding;
92
+ var above = rect.top - viewportPadding;
93
+ var openUp = below < 160 && above > below;
94
+
95
+ menu.style.position = "fixed";
96
+ menu.style.right = Math.max(viewportPadding, window.innerWidth - rect.right) + "px";
97
+ menu.style.maxHeight = Math.max(96, Math.floor((openUp ? above : below) - gap)) + "px";
98
+
99
+ if (openUp) {
100
+ menu.style.top = "";
101
+ menu.style.bottom = Math.max(viewportPadding, window.innerHeight - rect.top + gap) + "px";
102
+ } else {
103
+ menu.style.bottom = "";
104
+ menu.style.top = Math.min(window.innerHeight - viewportPadding, rect.bottom + gap) + "px";
105
+ }
106
+ }
107
+
72
108
  // The panels a dropdown controls. A header variant dropdown (in the shared
73
109
  // card header) drives the matching response status panel; otherwise panels
74
110
  // live in the dropdown's own `.code-lang-scope` or `.code-group`.
75
111
  function panelScopeForOption(option) {
76
- var headerWrap = option.closest('[data-response-dropdown]');
112
+ var headerWrap = option.closest("[data-response-dropdown]");
77
113
  if (headerWrap) {
78
- var idx = headerWrap.getAttribute('data-response-dropdown');
79
- var group = headerWrap.closest('.code-group');
80
- var panel = group && group.querySelector('.response-panel[data-response-panel="' + idx + '"]');
114
+ var idx = headerWrap.getAttribute("data-response-dropdown");
115
+ var group = headerWrap.closest(".code-group");
116
+ var panel =
117
+ group && group.querySelector('.response-panel[data-response-panel="' + idx + '"]');
81
118
  if (panel) return panel;
82
119
  }
83
- return option.closest('.code-lang-scope') || option.closest('.code-group');
120
+ return option.closest(".code-lang-scope") || option.closest(".code-group");
84
121
  }
85
122
 
86
123
  function activateLang(option) {
87
- var dropdown = option.closest('.code-lang-dropdown');
124
+ var dropdown = option.closest(".code-lang-dropdown");
88
125
  var scope = panelScopeForOption(option);
89
- var index = option.getAttribute('data-lang-index');
126
+ var index = option.getAttribute("data-lang-index");
90
127
 
91
128
  // Update the dropdown label + options (label/trigger live in the dropdown,
92
129
  // which for a header variant switcher is separate from the panel scope).
93
130
  if (dropdown) {
94
- var label = dropdown.querySelector('.code-lang-label');
95
- dropdown.querySelectorAll('.code-lang-option').forEach(function (opt) {
96
- var isActive = opt.getAttribute('data-lang-index') === index;
97
- opt.setAttribute('aria-selected', isActive ? 'true' : 'false');
98
- opt.className = opt.className.replace(/(dark:)?text-\[rgb\([^\]]+\)\]/g, '').trim();
131
+ var label = dropdown.querySelector(".code-lang-label");
132
+ dropdown.querySelectorAll(".code-lang-option").forEach(function (opt) {
133
+ var isActive = opt.getAttribute("data-lang-index") === index;
134
+ opt.setAttribute("aria-selected", isActive ? "true" : "false");
135
+ opt.className = opt.className.replace(/(dark:)?text-\[rgb\([^\]]+\)\]/g, "").trim();
99
136
  if (isActive) {
100
- opt.classList.add('text-[rgb(var(--color-primary))]', 'dark:text-[rgb(var(--color-primary-light))]');
137
+ opt.classList.add(
138
+ "text-[rgb(var(--color-primary))]",
139
+ "dark:text-[rgb(var(--color-primary-light))]",
140
+ );
101
141
  if (label) label.textContent = opt.textContent.trim();
102
- var triggerIcon = dropdown.querySelector('.code-lang-trigger .code-lang-icon');
103
- var optIcon = opt.querySelector('.lang-icon');
142
+ var triggerIcon = dropdown.querySelector(".code-lang-trigger .code-lang-icon");
143
+ var optIcon = opt.querySelector(".lang-icon");
104
144
  if (triggerIcon && optIcon) triggerIcon.innerHTML = optIcon.outerHTML;
105
145
  } else {
106
- opt.classList.add('text-[rgb(var(--color-stone-600))]', 'dark:text-[rgb(var(--color-stone-400))]');
146
+ opt.classList.add(
147
+ "text-[rgb(var(--color-stone-600))]",
148
+ "dark:text-[rgb(var(--color-stone-400))]",
149
+ );
107
150
  }
108
151
  });
109
152
  }
110
153
 
111
154
  // Update panels within the controlled scope.
112
155
  if (scope) {
113
- scope.querySelectorAll('.code-lang-panel').forEach(function (p) {
114
- p.classList.toggle('active', p.getAttribute('data-lang-panel') === index);
156
+ scope.querySelectorAll(".code-lang-panel").forEach(function (p) {
157
+ p.classList.toggle("active", p.getAttribute("data-lang-panel") === index);
115
158
  });
116
159
  }
117
160
  }
118
161
 
119
162
  // ── Response Tabs ──────────────────────────────────────────────────
120
163
 
121
- document.addEventListener('click', function (e) {
122
- var tab = e.target.closest('.response-tab');
164
+ document.addEventListener("click", function (e) {
165
+ var tab = e.target.closest(".response-tab");
123
166
  if (!tab) return;
124
167
 
125
- var container = tab.closest('.response-tabs');
126
- var index = tab.getAttribute('data-response-index');
168
+ var container = tab.closest(".response-tabs");
169
+ var index = tab.getAttribute("data-response-index");
127
170
  var scrollY = window.scrollY;
128
171
 
129
172
  // Update tabs
130
- container.querySelectorAll('.response-tab').forEach(function (t) {
131
- var isActive = t.getAttribute('data-response-index') === index;
132
- t.classList.toggle('active', isActive);
133
- t.setAttribute('aria-selected', isActive ? 'true' : 'false');
173
+ container.querySelectorAll(".response-tab").forEach(function (t) {
174
+ var isActive = t.getAttribute("data-response-index") === index;
175
+ t.classList.toggle("active", isActive);
176
+ t.setAttribute("aria-selected", isActive ? "true" : "false");
134
177
  });
135
178
 
136
179
  // Update panels
137
- container.querySelectorAll('.response-panel').forEach(function (p) {
138
- p.classList.toggle('active', p.getAttribute('data-response-panel') === index);
180
+ container.querySelectorAll(".response-panel").forEach(function (p) {
181
+ p.classList.toggle("active", p.getAttribute("data-response-panel") === index);
139
182
  });
140
183
 
141
184
  // Show only the active status's variant switcher in the header.
142
- container.querySelectorAll('[data-response-dropdown]').forEach(function (d) {
143
- d.classList.toggle('hidden', d.getAttribute('data-response-dropdown') !== index);
185
+ container.querySelectorAll("[data-response-dropdown]").forEach(function (d) {
186
+ d.classList.toggle("hidden", d.getAttribute("data-response-dropdown") !== index);
144
187
  });
145
188
 
146
189
  window.scrollTo(0, scrollY);
@@ -148,35 +191,37 @@
148
191
 
149
192
  // ── Copy Button ────────────────────────────────────────────────────
150
193
 
151
- document.addEventListener('click', function (e) {
152
- var btn = e.target.closest('.copy-btn');
194
+ document.addEventListener("click", function (e) {
195
+ var btn = e.target.closest(".copy-btn");
153
196
  if (!btn) return;
154
197
 
155
- var container = btn.closest('.code-group') || btn.closest('.prose-code-block');
198
+ var container = btn.closest(".code-group") || btn.closest(".prose-code-block");
156
199
  if (!container) return;
157
200
 
158
201
  // Find the active panel's code, or the nearest code element. With nested
159
202
  // panels (a variant switcher inside a response tab), prefer the deepest
160
203
  // active panel, which is last in document order.
161
- var activePanels = container.querySelectorAll('.code-lang-panel.active, .response-panel.active');
204
+ var activePanels = container.querySelectorAll(
205
+ ".code-lang-panel.active, .response-panel.active",
206
+ );
162
207
  var activePanel = activePanels.length ? activePanels[activePanels.length - 1] : null;
163
208
  var codeEl = activePanel
164
- ? activePanel.querySelector('code, .code-block, .font-mono')
165
- : container.querySelector('code, .code-block, .font-mono');
209
+ ? activePanel.querySelector("code, .code-block, .font-mono")
210
+ : container.querySelector("code, .code-block, .font-mono");
166
211
 
167
212
  if (!codeEl) return;
168
213
 
169
- var text = codeEl.textContent || '';
214
+ var text = codeEl.textContent || "";
170
215
  navigator.clipboard.writeText(text).then(function () {
171
- btn.classList.add('copied');
216
+ btn.classList.add("copied");
172
217
  var tooltip = btn.nextElementSibling;
173
- if (tooltip && tooltip.classList.contains('copy-tooltip')) {
174
- tooltip.textContent = 'Copied!';
218
+ if (tooltip && tooltip.classList.contains("copy-tooltip")) {
219
+ tooltip.textContent = "Copied!";
175
220
  }
176
221
  setTimeout(function () {
177
- btn.classList.remove('copied');
178
- if (tooltip && tooltip.classList.contains('copy-tooltip')) {
179
- tooltip.textContent = 'Copy';
222
+ btn.classList.remove("copied");
223
+ if (tooltip && tooltip.classList.contains("copy-tooltip")) {
224
+ tooltip.textContent = "Copy";
180
225
  }
181
226
  }, 2000);
182
227
  });
@@ -185,64 +230,68 @@
185
230
  // ── Rust Doctest Hidden-Line Toggle ──────────────────────────────
186
231
  // (Copy is handled by the shared .copy-btn inside each code block.)
187
232
 
188
- document.addEventListener('click', function (e) {
189
- var toggleBtn = e.target.closest('.rust-doctest-toggle-hidden');
233
+ document.addEventListener("click", function (e) {
234
+ var toggleBtn = e.target.closest(".rust-doctest-toggle-hidden");
190
235
  if (!toggleBtn) return;
191
- var fullSel = toggleBtn.getAttribute('data-target');
192
- var displaySel = toggleBtn.getAttribute('data-display');
193
- var fullEl = fullSel ? document.getElementById(fullSel.replace(/^#/, '')) : null;
194
- var displayEl = displaySel ? document.getElementById(displaySel.replace(/^#/, '')) : null;
236
+ var fullSel = toggleBtn.getAttribute("data-target");
237
+ var displaySel = toggleBtn.getAttribute("data-display");
238
+ var fullEl = fullSel ? document.getElementById(fullSel.replace(/^#/, "")) : null;
239
+ var displayEl = displaySel ? document.getElementById(displaySel.replace(/^#/, "")) : null;
195
240
  if (!fullEl || !displayEl) return;
196
- var fullHidden = fullEl.hasAttribute('hidden');
241
+ var fullHidden = fullEl.hasAttribute("hidden");
197
242
  if (fullHidden) {
198
- fullEl.removeAttribute('hidden');
199
- displayEl.setAttribute('hidden', '');
200
- toggleBtn.textContent = 'Hide hidden lines';
243
+ fullEl.removeAttribute("hidden");
244
+ displayEl.setAttribute("hidden", "");
245
+ toggleBtn.textContent = "Hide hidden lines";
201
246
  } else {
202
- fullEl.setAttribute('hidden', '');
203
- displayEl.removeAttribute('hidden');
204
- toggleBtn.textContent = 'Show hidden lines';
247
+ fullEl.setAttribute("hidden", "");
248
+ displayEl.removeAttribute("hidden");
249
+ toggleBtn.textContent = "Show hidden lines";
205
250
  }
206
251
  });
207
252
 
208
253
  // Close dropdowns on Escape
209
- document.addEventListener('keydown', function (e) {
210
- if (e.key === 'Escape') {
211
- document.querySelectorAll('.code-lang-menu').forEach(function (menu) {
212
- menu.classList.add('hidden');
213
- var btn = menu.parentElement.querySelector('.code-lang-trigger');
214
- if (btn) btn.setAttribute('aria-expanded', 'false');
254
+ document.addEventListener("keydown", function (e) {
255
+ if (e.key === "Escape") {
256
+ document.querySelectorAll(".code-lang-menu").forEach(function (menu) {
257
+ menu.classList.add("hidden");
258
+ var btn = menu.parentElement.querySelector(".code-lang-trigger");
259
+ if (btn) btn.setAttribute("aria-expanded", "false");
215
260
  });
216
261
  }
217
262
  });
218
263
 
219
264
  // ── Directive Tabs (:::tabs and :::code-group) ────────────────────
220
265
 
221
- document.addEventListener('click', function (e) {
222
- var tab = e.target.closest('.directive-tab');
266
+ document.addEventListener("click", function (e) {
267
+ var tab = e.target.closest(".directive-tab");
223
268
  if (!tab) return;
224
269
 
225
- var group = tab.getAttribute('data-tab-group');
226
- var index = tab.getAttribute('data-tab-index');
270
+ var group = tab.getAttribute("data-tab-group");
271
+ var index = tab.getAttribute("data-tab-index");
227
272
  var scrollY = window.scrollY;
228
273
 
229
274
  // Update tab buttons
230
- document.querySelectorAll('.directive-tab[data-tab-group="' + group + '"]').forEach(function (t) {
231
- t.classList.toggle('active', t.getAttribute('data-tab-index') === index);
232
- });
275
+ document
276
+ .querySelectorAll('.directive-tab[data-tab-group="' + group + '"]')
277
+ .forEach(function (t) {
278
+ t.classList.toggle("active", t.getAttribute("data-tab-index") === index);
279
+ });
233
280
 
234
281
  // Update panels
235
- document.querySelectorAll('.directive-tab-panel[data-tab-group="' + group + '"]').forEach(function (p) {
236
- p.classList.toggle('active', p.getAttribute('data-tab-index') === index);
237
- });
282
+ document
283
+ .querySelectorAll('.directive-tab-panel[data-tab-group="' + group + '"]')
284
+ .forEach(function (p) {
285
+ p.classList.toggle("active", p.getAttribute("data-tab-index") === index);
286
+ });
238
287
 
239
288
  window.scrollTo(0, scrollY);
240
289
  });
241
290
  }
242
291
 
243
- if ('requestIdleCallback' in window) {
292
+ if ("requestIdleCallback" in window) {
244
293
  window.requestIdleCallback(init, { timeout: 250 });
245
294
  } else {
246
- window.addEventListener('load', init, { once: true });
295
+ window.addEventListener("load", init, { once: true });
247
296
  }
248
297
  })();
@@ -11,6 +11,6 @@ export function Tags({ tags, serverUrl }) {
11
11
  .map((tag) => {
12
12
  const parents = tagLineage(tag, tagsByName);
13
13
  const displayName = tagDisplayName(tag);
14
- return (_jsxs("div", { class: tag.parent ? "mt-8" : "mt-12", children: [_jsxs("div", { id: `tag-${htmlId(tag.name)}`, "data-traverse-target": `tag-${htmlId(tag.name)}`, class: "mb-6", children: [parents.length > 0 && (_jsx("div", { class: "mb-2 text-xs font-medium uppercase tracking-[0.12em] text-[rgb(var(--color-gray-500))]", children: parents.map(tagDisplayName).join(" / ") })), _jsxs("div", { class: "mb-2 flex flex-wrap items-center gap-2", children: [_jsx("h1", { class: "text-xl font-bold text-[rgb(var(--color-gray-900))] dark:text-[rgb(var(--color-gray-200))]", children: displayName }), tag.summary && tag.summary !== tag.name && (_jsx(Badge, { children: _jsx("code", { children: tag.name }) })), tag.kind && _jsx(Badge, { children: tag.kind })] }), tag.description && (_jsx(Markdown, { content: tag.description, class: "text-sm max-w-none" }))] }), tag.operations.map((op) => (_jsx(Operation, { operation: op, serverUrl: serverUrl }, `${op.method}-${op.path}`)))] }, tag.name));
14
+ return (_jsxs("div", { class: tag.parent ? "mt-8" : "mt-12", children: [_jsxs("div", { id: `tag-${htmlId(tag.name)}`, "data-traverse-target": `tag-${htmlId(tag.name)}`, class: "mb-6", children: [parents.length > 0 && (_jsx("div", { class: "mb-2 text-xs font-medium uppercase tracking-[0.12em] text-[rgb(var(--color-gray-500))]", children: parents.map(tagDisplayName).join(" / ") })), _jsxs("div", { class: "mb-2 flex flex-wrap items-center gap-2", children: [_jsx("h1", { class: "text-2xl sm:text-3xl font-bold tracking-tight text-[rgb(var(--color-gray-900))] dark:text-[rgb(var(--color-gray-200))]", children: displayName }), tag.summary && tag.summary !== tag.name && (_jsx(Badge, { children: _jsx("code", { children: tag.name }) })), tag.kind && _jsx(Badge, { children: tag.kind })] }), tag.description && (_jsx(Markdown, { content: tag.description, class: "text-sm max-w-none" }))] }), tag.operations.map((op) => (_jsx(Operation, { operation: op, serverUrl: serverUrl }, `${op.method}-${op.path}`)))] }, tag.name));
15
15
  }) }));
16
16
  }
package/dist/index.d.ts CHANGED
@@ -25,6 +25,7 @@ export interface SiteBuildOptions {
25
25
  skipWrite?: boolean;
26
26
  embeddable?: boolean;
27
27
  strictChangelog?: boolean;
28
+ generateOgImages?: boolean;
28
29
  }
29
30
  export interface SiteBuildResult {
30
31
  outputDir: string;
@@ -39,6 +40,8 @@ export declare function buildSiteDocs(options?: SiteBuildOptions): Promise<SiteB
39
40
  export { defineConfig } from "./config.js";
40
41
  export { doxygen, godoc, markdown, mcp, mkdocs, openapi, rustdoc } from "./adapters/index.js";
41
42
  export { resolveInternalLinks } from "./site-assembly.js";
43
+ export { buildSourceySite, collectSourceyWatchPaths, writeSourceySite } from "./site.js";
44
+ export type { SourceySiteArtifacts, SourceySiteOptions, SourceySiteWriteOptions } from "./site.js";
42
45
  export type { NormalizedSpec, NormalizedOperation, NormalizedTag, NormalizedSchema, NormalizedParameter, NormalizedRequestBody, NormalizedResponse, } from "./core/types.js";
43
46
  export type { DoxygenSourceOptions, GodocSourceOptions, MarkdownSourceOptions, McpSourceOptions, MkDocsSourceOptions, OpenApiSourceOptions, ResolvedTabSource, RustdocSourceOptions, SourceAdapter, SourceAdapterContext, } from "./adapters/index.js";
44
47
  export type { RustdocConfig, ResolvedRustdocConfig, RustdocMode, RustdocFeatures, } from "./config.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,mBAAmB,EAEnB,cAAc,EACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAmBlD,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAkB3E;AAMD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C,gBAAgB,EAAE,OAAO,wBAAwB,EAAE,qBAAqB,EAAE,CAAC;IAC3E,kBAAkB,EAAE,OAAO,0BAA0B,EAAE,uBAAuB,EAAE,CAAC;IACjF,wDAAwD;IACxD,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACtC;AAED,wBAAsB,aAAa,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAgG5F;AA8CD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAG1D,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACV,aAAa,EACb,qBAAqB,EACrB,WAAW,EACX,eAAe,GAChB,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AASlD,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAkB3E;AAMD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C,gBAAgB,EAAE,OAAO,wBAAwB,EAAE,qBAAqB,EAAE,CAAC;IAC3E,kBAAkB,EAAE,OAAO,0BAA0B,EAAE,uBAAuB,EAAE,CAAC;IACjF,wDAAwD;IACxD,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACtC;AAED,wBAAsB,aAAa,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAsB5F;AAED,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACzF,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AAGnG,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACV,aAAa,EACb,qBAAqB,EACrB,WAAW,EACX,eAAe,GAChB,MAAM,aAAa,CAAC"}
package/dist/index.js CHANGED
@@ -1,11 +1,7 @@
1
- import { readFile } from "node:fs/promises";
2
- import { extname, resolve } from "node:path";
3
- import { buildSite as buildSiteHtml } from "./renderer/html-builder.js";
1
+ import { resolve } from "node:path";
4
2
  import { loadConfig, configFromSpec } from "./config.js";
5
- import { buildSiteNavigation } from "./core/navigation.js";
6
- import { buildSearchIndex } from "./core/search-indexer.js";
7
- import { generateLlmsTxt, generateLlmsFullTxt } from "./renderer/llms.js";
8
- import { assembleSite, buildSiteConfig, collectDocsPagesByTab, createMinimalSpec, enforceChangelogDiagnostics, enforceGodocDiagnostics, enforceRustdocDiagnostics, } from "./site-assembly.js";
3
+ import { buildSourceySite, writeSourceySite } from "./site.js";
4
+ import { createMinimalSpec } from "./site-assembly.js";
9
5
  /**
10
6
  * Build API documentation from a single OpenAPI/Swagger spec.
11
7
  * Wraps the spec in a single-tab site and renders through the modern layout.
@@ -30,117 +26,25 @@ export async function buildDocs(options) {
30
26
  export async function buildSiteDocs(options = {}) {
31
27
  const outputDir = resolve(options.outputDir ?? "dist");
32
28
  const config = options.config ?? (await loadConfig(options.configDir));
33
- const assembled = await assembleSite(config);
34
- const site = await buildSiteConfig(config);
35
- const sitePages = Array.from(assembled.pageMap.values());
36
- const navigation = buildSiteNavigation(assembled.siteTabs);
37
- enforceChangelogDiagnostics(assembled.changelogDiagnostics, options.strictChangelog);
38
- enforceGodocDiagnostics(assembled.godocDiagnostics);
39
- enforceRustdocDiagnostics(assembled.rustdocDiagnostics);
40
- const docsPagesByTab = collectDocsPagesByTab(assembled.pageMap, config.tabs);
41
- const searchIndex = buildSearchIndex(assembled.specsBySlug, docsPagesByTab, navigation, config.baseUrl || "/", config.search.featured, config.prettyUrls);
42
- const llmsTxt = generateLlmsTxt(sitePages, navigation, site);
43
- const llmsFullTxt = generateLlmsFullTxt(sitePages, navigation, site);
44
- const extraFiles = new Map(assembled.extraFiles);
45
- const ogImages = new Map();
46
- if (!config.ogImage) {
47
- const { generateOgImage } = await import("./og/generate-og-image.js");
48
- const CONCURRENCY = 8;
49
- for (let i = 0; i < sitePages.length; i += CONCURRENCY) {
50
- const batch = sitePages.slice(i, i + CONCURRENCY);
51
- await Promise.all(batch.map(async (page) => {
52
- const ogMeta = describePageForOg(page, config.name || "API", config.changelog.ogImages);
53
- if (!ogMeta)
54
- return;
55
- try {
56
- const ogPath = `_og/${page.outputPath.replace(/\.html$/, ".png")}`;
57
- const png = await generateOgImage({
58
- title: ogMeta.title,
59
- description: ogMeta.description,
60
- siteName: config.name,
61
- theme: config.theme,
62
- logo: site.logo?.light,
63
- });
64
- page.ogImagePath = ogPath;
65
- ogImages.set(ogPath, png);
66
- }
67
- catch (error) {
68
- const message = error instanceof Error ? error.message : String(error);
69
- console.warn(`Sourcey: skipping OG image for ${page.outputPath}: ${message}`);
70
- }
71
- }));
72
- }
73
- }
74
- else {
75
- const staticOg = config.ogImage;
76
- if (staticOg.startsWith("http://") ||
77
- staticOg.startsWith("https://") ||
78
- staticOg.startsWith("data:")) {
79
- for (const page of sitePages) {
80
- page.ogImagePath = staticOg;
81
- }
82
- }
83
- else {
84
- const ogPath = `_og/static${extname(staticOg) || ".png"}`;
85
- extraFiles.set(ogPath, await readFile(staticOg));
86
- for (const page of sitePages) {
87
- page.ogImagePath = ogPath;
88
- }
89
- }
90
- }
29
+ const sourceySite = await buildSourceySite({
30
+ config,
31
+ outputDir,
32
+ strictChangelog: options.strictChangelog,
33
+ generateOgImages: options.generateOgImages,
34
+ });
91
35
  if (!options.skipWrite) {
92
- await buildSiteHtml(sitePages, navigation, outputDir, site, {
93
- searchIndex,
94
- llmsTxt,
95
- llmsFullTxt,
96
- embeddable: options.embeddable,
97
- ogImages,
98
- extraFiles,
99
- });
36
+ await writeSourceySite(sourceySite, { embeddable: options.embeddable });
100
37
  }
101
38
  return {
102
39
  outputDir,
103
- pageCount: sitePages.length,
104
- changelogDiagnostics: assembled.changelogDiagnostics,
105
- godocDiagnostics: assembled.godocDiagnostics,
106
- rustdocDiagnostics: assembled.rustdocDiagnostics,
107
- _specs: assembled.specsBySlug,
40
+ pageCount: sourceySite.pageCount,
41
+ changelogDiagnostics: sourceySite.changelogDiagnostics,
42
+ godocDiagnostics: sourceySite.godocDiagnostics,
43
+ rustdocDiagnostics: sourceySite.rustdocDiagnostics,
44
+ _specs: sourceySite.specsBySlug,
108
45
  };
109
46
  }
110
- function describePageForOg(page, defaultSiteName, changelogPermalinkOg) {
111
- if (page.currentPage.kind === "markdown") {
112
- return {
113
- title: page.currentPage.markdown.title,
114
- description: page.currentPage.markdown.description || undefined,
115
- };
116
- }
117
- if (page.currentPage.kind === "changelog") {
118
- const changelog = page.currentPage.changelog;
119
- if (changelog.permalinkVersionId) {
120
- if (!changelogPermalinkOg)
121
- return null;
122
- const version = changelog.changelog.versions.find((candidate) => candidate.id === changelog.permalinkVersionId);
123
- if (!version)
124
- return null;
125
- return {
126
- title: `${version.version ?? "Unreleased"} - ${changelog.title}`,
127
- description: version.summary || summarizeVersion(version),
128
- };
129
- }
130
- return {
131
- title: changelog.title,
132
- description: changelog.description || changelog.changelog.description,
133
- };
134
- }
135
- return { title: `${defaultSiteName} Reference` };
136
- }
137
- function summarizeVersion(version) {
138
- if (version.summary)
139
- return version.summary;
140
- const texts = version.sections.flatMap((section) => section.entries.map((entry) => entry.text));
141
- const summary = texts.slice(0, 3).join(" ");
142
- return summary || undefined;
143
- }
144
47
  export { defineConfig } from "./config.js";
145
48
  export { doxygen, godoc, markdown, mcp, mkdocs, openapi, rustdoc } from "./adapters/index.js";
146
49
  export { resolveInternalLinks } from "./site-assembly.js";
50
+ export { buildSourceySite, collectSourceyWatchPaths, writeSourceySite } from "./site.js";
@@ -0,0 +1,6 @@
1
+ import type { PrettyUrls } from "../site-url.js";
2
+ export declare function outputPathFromRequestPath(pathname: string, baseUrl: string): string;
3
+ export declare function outputPathCandidatesForRequest(pathname: string, baseUrl: string, prettyUrls: PrettyUrls): string[];
4
+ export declare function requestPathMatchesBase(pathname: string, baseUrl: string): boolean;
5
+ export declare function contentTypeForPath(path: string): string;
6
+ //# sourceMappingURL=static-files.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"static-files.d.ts","sourceRoot":"","sources":["../../src/renderer/static-files.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAGjD,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAcnF;AAED,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CAYV;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAMjF;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAwCvD"}