@bsv/overlay-express 0.5.2 → 0.7.1
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/dist/cjs/package.json +6 -5
- package/dist/cjs/src/OverlayExpress.js +12 -2
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/generalGuide.md.js +77 -0
- package/dist/cjs/src/generalGuide.md.js.map +1 -0
- package/dist/cjs/src/makeUserInterface.js +289 -93
- package/dist/cjs/src/makeUserInterface.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/OverlayExpress.js +13 -3
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/generalGuide.md.js +75 -0
- package/dist/esm/src/generalGuide.md.js.map +1 -0
- package/dist/esm/src/makeUserInterface.js +286 -93
- package/dist/esm/src/makeUserInterface.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/generalGuide.md.d.ts +3 -0
- package/dist/types/src/generalGuide.md.d.ts.map +1 -0
- package/dist/types/src/makeUserInterface.d.ts +5 -0
- package/dist/types/src/makeUserInterface.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/package.json +6 -5
- package/src/OverlayExpress.ts +14 -3
- package/src/generalGuide.md.ts +74 -0
- package/src/makeUserInterface.ts +301 -97
- package/src/__tests/OverlayExpress.test.ts +0 -0
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import generalGuide from './generalGuide.md.js';
|
|
1
2
|
export default (config = {}) => {
|
|
2
|
-
const { faviconUrl = 'https://bsvblockchain.org/favicon.ico', backgroundColor = '#
|
|
3
|
+
const { host = '', faviconUrl = 'https://bsvblockchain.org/favicon.ico', backgroundColor = '#191919', primaryTextColor = '#f0f0f0', primaryColor = '#3b6efb', secondaryColor = '#001242', fontFamily = 'Helvetica, Arial, sans-serif', headingFontFamily = 'Helvetica, Arial, sans-serif', additionalStyles = '', sectionBackgroundColor = '#323940', linkColor = '#579DFF', hoverColor = '#3A4147', borderColor = '#B6C2CF', secondaryBackgroundColor = '#f8f8f8', secondaryTextColor = '#0e0e0e', defaultContent = generalGuide } = config;
|
|
3
4
|
return `<!DOCTYPE html>
|
|
4
5
|
<html>
|
|
5
6
|
<head>
|
|
@@ -18,6 +19,9 @@ export default (config = {}) => {
|
|
|
18
19
|
--link-color: ${linkColor};
|
|
19
20
|
--hover-color: ${hoverColor};
|
|
20
21
|
--border-color: ${borderColor};
|
|
22
|
+
--secondary-background-color: ${secondaryBackgroundColor};
|
|
23
|
+
--secondary-text-color: ${secondaryTextColor};
|
|
24
|
+
--primary-text-color: ${primaryTextColor};
|
|
21
25
|
}
|
|
22
26
|
|
|
23
27
|
body {
|
|
@@ -25,13 +29,24 @@ export default (config = {}) => {
|
|
|
25
29
|
background-color: var(--background-color);
|
|
26
30
|
margin: 0;
|
|
27
31
|
padding: 0;
|
|
28
|
-
color: var(--primary-color);
|
|
32
|
+
color: var(--primary-text-color);
|
|
29
33
|
}
|
|
30
34
|
|
|
31
35
|
h1, h2, h3 {
|
|
32
36
|
font-family: var(--heading-font-family);
|
|
33
37
|
}
|
|
34
38
|
|
|
39
|
+
p {
|
|
40
|
+
line-height: 1.5;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
.welcome {
|
|
44
|
+
background-clip: text;
|
|
45
|
+
color: transparent;
|
|
46
|
+
background-image: linear-gradient(90deg, var(--primary-color), var(--secondary-color));
|
|
47
|
+
cursor: pointer;
|
|
48
|
+
}
|
|
49
|
+
|
|
35
50
|
a {
|
|
36
51
|
color: var(--link-color);
|
|
37
52
|
text-decoration: none;
|
|
@@ -48,69 +63,57 @@ export default (config = {}) => {
|
|
|
48
63
|
overflow: hidden;
|
|
49
64
|
}
|
|
50
65
|
|
|
51
|
-
.
|
|
66
|
+
.column_right {
|
|
52
67
|
padding: 1.5em;
|
|
53
68
|
overflow-y: auto;
|
|
54
69
|
}
|
|
55
70
|
|
|
56
71
|
.column_left {
|
|
57
|
-
|
|
58
|
-
|
|
72
|
+
padding: 15px 15px 15px 35px;
|
|
73
|
+
overflow-y: auto;
|
|
74
|
+
width: 360px;
|
|
75
|
+
background-color: var(--secondary-background-color);
|
|
76
|
+
color: var(--secondary-text-color);
|
|
59
77
|
}
|
|
60
78
|
|
|
61
79
|
.column_right {
|
|
62
|
-
width:
|
|
63
|
-
border-left: 1px solid var(--border-color);
|
|
80
|
+
width: calc(100% - 360px);
|
|
64
81
|
}
|
|
65
82
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
border-bottom: 1px solid var(--border-color);
|
|
83
|
+
#documentation_container {
|
|
84
|
+
padding: 0 8em;
|
|
85
|
+
margin: 0;
|
|
70
86
|
}
|
|
71
87
|
|
|
72
88
|
/* List styles */
|
|
73
89
|
.list-item {
|
|
74
|
-
|
|
75
|
-
align-items: center;
|
|
76
|
-
margin: 0.5em 0;
|
|
90
|
+
margin: 0;
|
|
77
91
|
}
|
|
78
92
|
|
|
79
93
|
.list-item a {
|
|
80
|
-
display:
|
|
81
|
-
align-items: center;
|
|
94
|
+
display: block;
|
|
82
95
|
width: 100%;
|
|
83
|
-
padding: 0.5em;
|
|
96
|
+
padding: 0.5em 0.75em;
|
|
84
97
|
background-color: transparent;
|
|
85
98
|
border-radius: 5px;
|
|
86
99
|
transition: background-color 0.3s;
|
|
87
100
|
text-decoration: none;
|
|
88
101
|
color: inherit;
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
.list-item a:hover {
|
|
92
|
-
background-color: var(--hover-color);
|
|
102
|
+
font-weight: 500;
|
|
93
103
|
cursor: pointer;
|
|
94
104
|
}
|
|
95
105
|
|
|
96
|
-
.list-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
.list-text {
|
|
103
|
-
display: flex;
|
|
104
|
-
flex-direction: column;
|
|
106
|
+
.list-item a:hover, .list-item a.active {
|
|
107
|
+
background: var(--primary-color) linear-gradient(90deg, var(--primary-color), var(--secondary-color));
|
|
108
|
+
color: white;
|
|
109
|
+
cursor: pointer;
|
|
110
|
+
border-radius: 8px 0 0 8px;
|
|
105
111
|
}
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
.list-description {
|
|
112
|
-
font-size: 0.9em;
|
|
113
|
-
color: var(--secondary-color);
|
|
112
|
+
|
|
113
|
+
ul#manager_list, ul#provider_list, ul#external_list {
|
|
114
|
+
list-style-type: none;
|
|
115
|
+
padding-left: 0;
|
|
116
|
+
margin-top: 0.5em;
|
|
114
117
|
}
|
|
115
118
|
|
|
116
119
|
/* Detail styles */
|
|
@@ -143,41 +146,186 @@ export default (config = {}) => {
|
|
|
143
146
|
color: var(--link-color);
|
|
144
147
|
}
|
|
145
148
|
|
|
149
|
+
/* Code highlighting styles */
|
|
150
|
+
pre {
|
|
151
|
+
position: relative;
|
|
152
|
+
padding: 1em;
|
|
153
|
+
border-radius: 5px;
|
|
154
|
+
overflow: auto;
|
|
155
|
+
background-color: #282c34;
|
|
156
|
+
margin: 1em 0;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
pre[data-language]:before {
|
|
160
|
+
content: attr(data-language);
|
|
161
|
+
position: absolute;
|
|
162
|
+
top: 0;
|
|
163
|
+
right: 0;
|
|
164
|
+
padding: 0.25em 0.5em;
|
|
165
|
+
font-size: 0.75em;
|
|
166
|
+
color: #abb2bf;
|
|
167
|
+
background-color: #3e4451;
|
|
168
|
+
border-radius: 0 0 0 4px;
|
|
169
|
+
text-transform: uppercase;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
code {
|
|
173
|
+
font-family: Menlo, Monaco, 'Courier New', monospace;
|
|
174
|
+
font-size: 0.9em;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/* Inline code */
|
|
178
|
+
p code, li code {
|
|
179
|
+
background-color: #3e4451;
|
|
180
|
+
padding: 0.2em 0.4em;
|
|
181
|
+
border-radius: 3px;
|
|
182
|
+
white-space: nowrap;
|
|
183
|
+
}
|
|
184
|
+
|
|
146
185
|
/* Responsive design */
|
|
147
186
|
@media screen and (max-width: 850px) {
|
|
148
187
|
.main {
|
|
149
188
|
flex-direction: column;
|
|
150
189
|
}
|
|
151
190
|
|
|
191
|
+
.column_left {
|
|
192
|
+
max-height: 30vh;
|
|
193
|
+
}
|
|
194
|
+
|
|
152
195
|
.column_left, .column_right {
|
|
153
|
-
width:
|
|
196
|
+
width: 90%;
|
|
197
|
+
margin: 0;
|
|
198
|
+
padding: 0 5%;
|
|
154
199
|
}
|
|
155
200
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
201
|
+
#documentation_container {
|
|
202
|
+
margin: 0;
|
|
203
|
+
padding: 0;
|
|
159
204
|
}
|
|
160
205
|
}
|
|
161
206
|
|
|
162
207
|
${additionalStyles}
|
|
163
208
|
</style>
|
|
164
209
|
<script src="https://cdn.jsdelivr.net/npm/showdown@2.0.3/dist/showdown.min.js"></script>
|
|
210
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.7.0/build/styles/atom-one-dark.min.css">
|
|
211
|
+
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.7.0/build/highlight.min.js"></script>
|
|
165
212
|
<script>
|
|
166
213
|
const faviconUrl = '${faviconUrl}';
|
|
167
214
|
|
|
168
215
|
const showdown = window.showdown;
|
|
216
|
+
window.hljs.configure({ languages: ['typescript', 'javascript', 'json', 'html', 'css', 'bash', 'markdown'] });
|
|
217
|
+
|
|
169
218
|
|
|
170
219
|
const Convert = (md) => {
|
|
171
|
-
let converter = new showdown.Converter(
|
|
172
|
-
|
|
220
|
+
let converter = new showdown.Converter({
|
|
221
|
+
ghCompatibleHeaderId: true,
|
|
222
|
+
simpleLineBreaks: true,
|
|
223
|
+
ghMentions: true,
|
|
224
|
+
tables: true,
|
|
225
|
+
tasklists: true,
|
|
226
|
+
strikethrough: true,
|
|
227
|
+
parseImgDimensions: true,
|
|
228
|
+
simplifiedAutoLink: true
|
|
229
|
+
});
|
|
230
|
+
// Set to use GitHub flavor markdown
|
|
231
|
+
converter.setFlavor('github');
|
|
232
|
+
|
|
233
|
+
// Set language detection for code blocks
|
|
234
|
+
converter.setOption('ghCodeBlocks', true);
|
|
235
|
+
converter.setOption('omitExtraWLInCodeBlocks', true);
|
|
236
|
+
converter.setOption('literalMidWordUnderscores', true);
|
|
237
|
+
converter.setOption('parseImgDimensions', true);
|
|
238
|
+
|
|
239
|
+
// Add custom extension for adding language-specific class to code blocks
|
|
240
|
+
const codeExtension = () => [
|
|
241
|
+
{
|
|
242
|
+
type: 'output',
|
|
243
|
+
filter: function(text) {
|
|
244
|
+
return text.replace(/<pre><code\s*class="([^"]*)">(.*?)<\\/code><\\/pre>/gs, function(match, language, content) {
|
|
245
|
+
if (language) {
|
|
246
|
+
// Clean up the language identifier
|
|
247
|
+
const lang = language.replace('language-', '').trim();
|
|
248
|
+
return \`<pre data-language="\${lang}"><code class="language-\${lang} hljs">\${content}</code></pre>\`;
|
|
249
|
+
} else {
|
|
250
|
+
return \`<pre><code class="hljs">\${content}</code></pre>\`;
|
|
251
|
+
}
|
|
252
|
+
});
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
];
|
|
256
|
+
|
|
257
|
+
// Add the extension
|
|
258
|
+
converter.addExtension(codeExtension());
|
|
259
|
+
const html = converter.makeHtml(md);
|
|
260
|
+
|
|
261
|
+
return html;
|
|
262
|
+
};
|
|
263
|
+
|
|
264
|
+
window.returnHome = () => {
|
|
265
|
+
if (!window.defaultHtml) {
|
|
266
|
+
let newStuff = Convert(${defaultContent});
|
|
267
|
+
window.defaultHtml = newStuff;
|
|
268
|
+
}
|
|
269
|
+
document.getElementById('documentation_container').innerHTML = window.defaultHtml;
|
|
270
|
+
window.location.hash = '';
|
|
271
|
+
document.querySelectorAll('.list-item a').forEach(item => {
|
|
272
|
+
item.classList.remove('active');
|
|
273
|
+
});
|
|
274
|
+
};
|
|
275
|
+
|
|
276
|
+
// Function to apply syntax highlighting after content is inserted
|
|
277
|
+
const applyHighlighting = () => {
|
|
278
|
+
document.querySelectorAll('pre code').forEach(block => {
|
|
279
|
+
const blockElement = block;
|
|
280
|
+
|
|
281
|
+
// Check for language class
|
|
282
|
+
const classList = Array.from(blockElement.classList);
|
|
283
|
+
const langClass = classList.find(cls => cls.startsWith('language-'));
|
|
284
|
+
|
|
285
|
+
if (langClass) {
|
|
286
|
+
const language = langClass.replace('language-', '');
|
|
287
|
+
// Set language label on the parent pre element
|
|
288
|
+
const preElement = blockElement.parentElement;
|
|
289
|
+
if (preElement) {
|
|
290
|
+
preElement.setAttribute('data-language', language);
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
// Apply highlighting to all code blocks
|
|
295
|
+
try {
|
|
296
|
+
// @ts-ignore - hljs is loaded from CDN
|
|
297
|
+
window.hljs.highlightElement(blockElement);
|
|
298
|
+
} catch (e) {
|
|
299
|
+
console.error('Error highlighting code:', e);
|
|
300
|
+
}
|
|
301
|
+
});
|
|
173
302
|
};
|
|
174
303
|
|
|
175
304
|
let managersData = {};
|
|
176
305
|
let providersData = {};
|
|
177
306
|
|
|
307
|
+
// Function to update URL hash and highlight selected item
|
|
308
|
+
const updateSelectedItem = (type, id) => {
|
|
309
|
+
// Update URL hash
|
|
310
|
+
window.location.hash = \`\${type}/\${id}\`;
|
|
311
|
+
|
|
312
|
+
// Remove active class from all list items
|
|
313
|
+
document.querySelectorAll('.list-item a').forEach(item => {
|
|
314
|
+
item.classList.remove('active');
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
// Add active class to selected item
|
|
318
|
+
const selector = \`[data-\${type}="\${id}"]\`;
|
|
319
|
+
const selectedItem = document.querySelector(selector);
|
|
320
|
+
if (selectedItem) {
|
|
321
|
+
selectedItem.classList.add('active');
|
|
322
|
+
}
|
|
323
|
+
};
|
|
324
|
+
|
|
325
|
+
// @ts-ignore - Adding custom property to window
|
|
178
326
|
window.managerDocumentation = async (manager) => {
|
|
179
327
|
try {
|
|
180
|
-
let res = await fetch(
|
|
328
|
+
let res = await fetch(\`${host}/getDocumentationForTopicManager?manager=\${manager}\`);
|
|
181
329
|
let docs = await res.text();
|
|
182
330
|
let managerReadme = Convert(docs);
|
|
183
331
|
|
|
@@ -185,25 +333,19 @@ export default (config = {}) => {
|
|
|
185
333
|
let iconURL = managerData.iconURL || faviconUrl;
|
|
186
334
|
|
|
187
335
|
document.getElementById('documentation_container').innerHTML = managerReadme;
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
<h1 class="detail-title">\${managerData.name}</h1>
|
|
193
|
-
<p class="detail-description">\${managerData.shortDescription || ''}</p>
|
|
194
|
-
\${managerData.version ? '<p class="detail-version">Version: ' + managerData.version + '</p>' : ''}
|
|
195
|
-
\${managerData.informationURL ? '<p class="detail-info"><a href="' + managerData.informationURL + '" target="_blank">More Information</a></p>' : ''}
|
|
196
|
-
</div>
|
|
197
|
-
</div>
|
|
198
|
-
\`;
|
|
336
|
+
applyHighlighting();
|
|
337
|
+
|
|
338
|
+
// Update active item and URL
|
|
339
|
+
updateSelectedItem('manager', manager);
|
|
199
340
|
} catch (error) {
|
|
200
341
|
console.error('Error fetching manager documentation:', error);
|
|
201
342
|
}
|
|
202
343
|
};
|
|
203
344
|
|
|
345
|
+
// @ts-ignore - Adding custom property to window
|
|
204
346
|
window.topicDocumentation = async (provider) => {
|
|
205
347
|
try {
|
|
206
|
-
let res = await fetch(
|
|
348
|
+
let res = await fetch(\`${host}/getDocumentationForLookupServiceProvider?lookupService=\${provider}\`);
|
|
207
349
|
let docs = await res.text();
|
|
208
350
|
let providerReadme = Convert(docs);
|
|
209
351
|
|
|
@@ -211,81 +353,127 @@ export default (config = {}) => {
|
|
|
211
353
|
let iconURL = providerData.iconURL || faviconUrl;
|
|
212
354
|
|
|
213
355
|
document.getElementById('documentation_container').innerHTML = providerReadme;
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
<h1 class="detail-title">\${providerData.name}</h1>
|
|
219
|
-
<p class="detail-description">\${providerData.shortDescription || ''}</p>
|
|
220
|
-
\${providerData.version ? '<p class="detail-version">Version: ' + providerData.version + '</p>' : ''}
|
|
221
|
-
\${providerData.informationURL ? '<p class="detail-info"><a href="' + providerData.informationURL + '" target="_blank">More Information</a></p>' : ''}
|
|
222
|
-
</div>
|
|
223
|
-
</div>
|
|
224
|
-
\`;
|
|
356
|
+
applyHighlighting();
|
|
357
|
+
|
|
358
|
+
// Update active item and URL
|
|
359
|
+
updateSelectedItem('provider', provider);
|
|
225
360
|
} catch (error) {
|
|
226
361
|
console.error('Error fetching provider documentation:', error);
|
|
227
362
|
}
|
|
228
363
|
};
|
|
229
364
|
|
|
365
|
+
// Function to parse hash and load appropriate content
|
|
366
|
+
const handleUrlHash = () => {
|
|
367
|
+
const hash = window.location.hash.substring(1); // Remove the # character
|
|
368
|
+
if (hash) {
|
|
369
|
+
const [type, id] = hash.split('/');
|
|
370
|
+
if (type && id) {
|
|
371
|
+
if (type === 'manager') {
|
|
372
|
+
// Check if managers data is loaded
|
|
373
|
+
if (Object.keys(managersData).length > 0 && managersData[id]) {
|
|
374
|
+
window.managerDocumentation(id);
|
|
375
|
+
}
|
|
376
|
+
} else if (type === 'provider') {
|
|
377
|
+
// Check if providers data is loaded
|
|
378
|
+
if (Object.keys(providersData).length > 0 && providersData[id]) {
|
|
379
|
+
window.topicDocumentation(id);
|
|
380
|
+
}
|
|
381
|
+
}
|
|
382
|
+
}
|
|
383
|
+
}
|
|
384
|
+
};
|
|
385
|
+
|
|
230
386
|
document.addEventListener('DOMContentLoaded', () => {
|
|
231
|
-
|
|
387
|
+
let managersLoaded = false;
|
|
388
|
+
let providersLoaded = false;
|
|
389
|
+
|
|
390
|
+
// Check if both managers and providers are loaded before handling hash
|
|
391
|
+
const checkAllLoaded = () => {
|
|
392
|
+
if (managersLoaded && providersLoaded) {
|
|
393
|
+
handleUrlHash();
|
|
394
|
+
}
|
|
395
|
+
};
|
|
396
|
+
|
|
397
|
+
fetch('${host}/listTopicManagers')
|
|
232
398
|
.then(res => res.json())
|
|
233
399
|
.then(managers => {
|
|
234
400
|
managersData = managers;
|
|
235
401
|
const managerList = document.getElementById('manager_list');
|
|
236
402
|
Object.keys(managers).forEach(manager => {
|
|
237
403
|
let managerData = managers[manager];
|
|
238
|
-
let iconURL = managerData.iconURL || faviconUrl;
|
|
239
404
|
let li = document.createElement('li');
|
|
240
405
|
li.className = 'list-item';
|
|
241
406
|
li.innerHTML = \`
|
|
242
|
-
<a onclick="window.managerDocumentation('\${manager}')">
|
|
243
|
-
|
|
244
|
-
<div class="list-text">
|
|
245
|
-
<span class="list-title">\${managerData.name}</span>
|
|
246
|
-
<span class="list-description">\${managerData.shortDescription || ''}</span>
|
|
247
|
-
</div>
|
|
407
|
+
<a data-manager="\${manager}" onclick="window.managerDocumentation('\${manager}')">
|
|
408
|
+
\${managerData.name}
|
|
248
409
|
</a>
|
|
249
410
|
\`;
|
|
250
411
|
managerList.appendChild(li);
|
|
251
412
|
});
|
|
413
|
+
managersLoaded = true;
|
|
414
|
+
checkAllLoaded();
|
|
252
415
|
})
|
|
253
416
|
.catch(() => {
|
|
254
417
|
let message = document.createElement('h4');
|
|
255
418
|
message.innerText = 'Something went wrong!';
|
|
256
419
|
manager_list.insertBefore(message, manager_list.children[0]);
|
|
420
|
+
managersLoaded = true;
|
|
421
|
+
checkAllLoaded();
|
|
257
422
|
});
|
|
258
423
|
|
|
259
|
-
fetch('/listLookupServiceProviders')
|
|
424
|
+
fetch('${host}/listLookupServiceProviders')
|
|
260
425
|
.then(res => res.json())
|
|
261
426
|
.then(providers => {
|
|
262
427
|
providersData = providers;
|
|
263
428
|
const providerList = document.getElementById('provider_list');
|
|
264
429
|
Object.keys(providers).forEach(provider => {
|
|
265
430
|
let providerData = providers[provider];
|
|
266
|
-
let iconURL = providerData.iconURL || faviconUrl;
|
|
267
431
|
let li = document.createElement('li');
|
|
268
432
|
li.className = 'list-item';
|
|
269
433
|
li.innerHTML = \`
|
|
270
|
-
<a onclick="window.topicDocumentation('\${provider}')">
|
|
271
|
-
|
|
272
|
-
<div class="list-text">
|
|
273
|
-
<span class="list-title">\${providerData.name}</span>
|
|
274
|
-
<span class="list-description">\${providerData.shortDescription || ''}</span>
|
|
275
|
-
</div>
|
|
434
|
+
<a data-provider="\${provider}" onclick="window.topicDocumentation('\${provider}')">
|
|
435
|
+
\${providerData.name}
|
|
276
436
|
</a>
|
|
277
437
|
\`;
|
|
278
438
|
providerList.appendChild(li);
|
|
279
439
|
});
|
|
440
|
+
providersLoaded = true;
|
|
441
|
+
checkAllLoaded();
|
|
280
442
|
})
|
|
281
443
|
.catch(() => {
|
|
282
444
|
let message = document.createElement('h4');
|
|
283
445
|
message.innerText = 'Something went wrong!';
|
|
284
446
|
provider_list.insertBefore(message, provider_list.children[0]);
|
|
447
|
+
providersLoaded = true;
|
|
448
|
+
checkAllLoaded();
|
|
285
449
|
});
|
|
286
450
|
|
|
287
|
-
//
|
|
288
|
-
|
|
451
|
+
// Check URL hash to see if we should load specific documentation
|
|
452
|
+
const checkUrlHash = () => {
|
|
453
|
+
const hash = window.location.hash.substring(1); // Remove the # symbol
|
|
454
|
+
if (hash) {
|
|
455
|
+
const parts = hash.split('/');
|
|
456
|
+
if (parts.length === 2) {
|
|
457
|
+
const type = parts[0];
|
|
458
|
+
const id = parts[1];
|
|
459
|
+
|
|
460
|
+
if (type === 'manager' && id && managersData[id]) {
|
|
461
|
+
window.managerDocumentation(id);
|
|
462
|
+
} else if (type === 'provider' && id && providersData[id]) {
|
|
463
|
+
window.topicDocumentation(id);
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
} else {
|
|
467
|
+
// Display default message when no manager or provider is selected
|
|
468
|
+
returnHome();
|
|
469
|
+
}
|
|
470
|
+
};
|
|
471
|
+
|
|
472
|
+
// Listen for hash changes
|
|
473
|
+
window.addEventListener('hashchange', checkUrlHash);
|
|
474
|
+
|
|
475
|
+
// Check hash on initial page load
|
|
476
|
+
checkUrlHash();
|
|
289
477
|
});
|
|
290
478
|
</script>
|
|
291
479
|
</head>
|
|
@@ -294,22 +482,27 @@ export default (config = {}) => {
|
|
|
294
482
|
<div class="main">
|
|
295
483
|
<div class="column_left">
|
|
296
484
|
<div class="page_head">
|
|
297
|
-
<h1
|
|
298
|
-
<p>Learn more on <a href="https://github.com/bitcoin-sv/overlay-services" target="_blank">GitHub</a></p>
|
|
485
|
+
<h1 class="welcome" onclick="window.returnHome()">Overlay Services</h1>
|
|
299
486
|
</div>
|
|
300
487
|
<div class="topic_container">
|
|
301
|
-
<
|
|
302
|
-
<h3>Supported Topic Managers:</h3>
|
|
488
|
+
<h3>Topic Managers</h3>
|
|
303
489
|
<ul id="manager_list"></ul>
|
|
304
490
|
</div>
|
|
305
491
|
<div class="provider_container">
|
|
306
|
-
<h3>
|
|
492
|
+
<h3>Lookup Services</h3>
|
|
307
493
|
<ul id="provider_list"></ul>
|
|
308
494
|
</div>
|
|
495
|
+
<div>
|
|
496
|
+
<h3>External Links</h3>
|
|
497
|
+
<ul id="external_list">
|
|
498
|
+
<li class="list-item"><a href="https://github.com/bsv-blockchain/overlay-services" target="_blank">Overlay Services GitHub</a></li>
|
|
499
|
+
<li class="list-item"><a href="https://bsv.brc.dev/overlays/0088" target="_blank">BRC-88 GASP</a></li>
|
|
500
|
+
<li class="list-item"><a href="https://fast.brc.dev" target="_blank">Quick Start for App Developers</a></li>
|
|
501
|
+
</ul>
|
|
502
|
+
</div>
|
|
309
503
|
</div>
|
|
310
504
|
<div class="column_right">
|
|
311
|
-
<div id="
|
|
312
|
-
<div id="documentation_container" style="margin-left: 1.5em"></div>
|
|
505
|
+
<div id="documentation_container"></div>
|
|
313
506
|
</div>
|
|
314
507
|
</div>
|
|
315
508
|
</body>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"makeUserInterface.js","sourceRoot":"","sources":["../../../src/makeUserInterface.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"makeUserInterface.js","sourceRoot":"","sources":["../../../src/makeUserInterface.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,sBAAsB,CAAA;AAqB/C,eAAe,CAAC,SAAmB,EAAE,EAAU,EAAE;IAC/C,MAAM,EACJ,IAAI,GAAG,EAAE,EACT,UAAU,GAAG,uCAAuC,EACpD,eAAe,GAAG,SAAS,EAC3B,gBAAgB,GAAG,SAAS,EAC5B,YAAY,GAAG,SAAS,EACxB,cAAc,GAAG,SAAS,EAC1B,UAAU,GAAG,8BAA8B,EAC3C,iBAAiB,GAAG,8BAA8B,EAClD,gBAAgB,GAAG,EAAE,EACrB,sBAAsB,GAAG,SAAS,EAClC,SAAS,GAAG,SAAS,EACrB,UAAU,GAAG,SAAS,EACtB,WAAW,GAAG,SAAS,EACvB,wBAAwB,GAAG,SAAS,EACpC,kBAAkB,GAAG,SAAS,EAC9B,cAAc,GAAG,YAAY,EAC9B,GAAG,MAAM,CAAC;IAEX,OAAO;;;;;;+CAMsC,UAAU;;;4BAG7B,eAAe;yBAClB,YAAY;2BACV,cAAc;uBAClB,UAAU;+BACF,iBAAiB;oCACZ,sBAAsB;sBACpC,SAAS;uBACR,UAAU;wBACT,WAAW;sCACG,wBAAwB;gCAC9B,kBAAkB;8BACpB,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAuLxC,gBAAgB;;;;;;0BAMI,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAqDH,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCA8Db,IAAI;;;;;;;;;;;;;;;;;;;;kCAoBJ,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiDvB,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;eA2BJ,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqFX,CAAC;AACT,CAAC,CAAC"}
|