@forsakringskassan/docs-generator 2.23.0 → 2.25.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.
Files changed (32) hide show
  1. package/dist/compile-example.js +2 -2
  2. package/dist/{create-markdown-renderer-BSbHc8U0.js → create-markdown-renderer-CoJjMIzN.js} +3 -3
  3. package/dist/{create-markdown-renderer-BSbHc8U0.js.map → create-markdown-renderer-CoJjMIzN.js.map} +1 -1
  4. package/dist/index.d.ts +5 -0
  5. package/dist/index.js +386 -58
  6. package/dist/index.js.map +1 -1
  7. package/dist/markdown.d.ts +5 -0
  8. package/dist/markdown.js +3 -3
  9. package/dist/runtime.js +57 -16
  10. package/dist/style/core.css +89 -0
  11. package/dist/style/index.css +91 -0
  12. package/dist/style/site.css +2 -0
  13. package/dist/tsdoc-metadata.json +1 -1
  14. package/dist/{vendor-BxO3IPg6.js → vendor-y4sQkzVC.js} +2777 -63
  15. package/dist/vendor-y4sQkzVC.js.map +1 -0
  16. package/dist/{vue3-CZnjnYGV.js → vue3-DXIVBodU.js} +2 -2
  17. package/dist/{vue3-CZnjnYGV.js.map → vue3-DXIVBodU.js.map} +1 -1
  18. package/package.json +3 -1
  19. package/templates/api.class.template.html +1 -0
  20. package/templates/api.composable.template.html +1 -0
  21. package/templates/api.constant.template.html +1 -0
  22. package/templates/api.enum.template.html +1 -0
  23. package/templates/api.function.template.html +1 -0
  24. package/templates/api.interface.template.html +1 -0
  25. package/templates/api.method.template.html +1 -0
  26. package/templates/api.template.html +1 -0
  27. package/templates/api.type.template.html +1 -0
  28. package/templates/base.template.html +2 -2
  29. package/templates/component.template.html +16 -13
  30. package/templates/partials/search-dialog.html +3 -3
  31. package/templates/partials/search-toolbar.html +1 -1
  32. package/dist/vendor-BxO3IPg6.js.map +0 -1
@@ -257,6 +257,11 @@ export declare interface NormalizedDocumentAttributes {
257
257
  badge?: DocumentBadge;
258
258
  component?: ComponentAttribute[];
259
259
  href?: string;
260
+ /** search options */
261
+ search: {
262
+ /** list of additional search terms for this page */
263
+ terms: string[];
264
+ };
260
265
  /** normalized sortorder (defaults to Infinity) */
261
266
  sortorder: number;
262
267
  redirectFrom: string[];
package/dist/markdown.js CHANGED
@@ -1,7 +1,7 @@
1
1
  'use strict';
2
2
 
3
- var createMarkdownRenderer = require('./create-markdown-renderer-BSbHc8U0.js');
4
- require('./vendor-BxO3IPg6.js');
3
+ var createMarkdownRenderer = require('./create-markdown-renderer-CoJjMIzN.js');
4
+ require('./vendor-y4sQkzVC.js');
5
5
  require('node:url');
6
6
  require('node:path');
7
7
  require('fs');
@@ -38,7 +38,7 @@ require('querystring');
38
38
  require('node:path/posix');
39
39
  require('node:crypto');
40
40
  require('vue');
41
- require('./vue3-CZnjnYGV.js');
41
+ require('./vue3-DXIVBodU.js');
42
42
 
43
43
 
44
44
 
package/dist/runtime.js CHANGED
@@ -147434,6 +147434,12 @@ uFuzzy.permute = (arr) => {
147434
147434
  uFuzzy.highlight = highlight;
147435
147435
 
147436
147436
  // src/runtime/search.ts
147437
+ function isMoreSpecific(a2, b2) {
147438
+ if (b2 === null) {
147439
+ return true;
147440
+ }
147441
+ return a2.matchType === "title" && b2.matchType === "term";
147442
+ }
147437
147443
  function setup() {
147438
147444
  const searchData = document.querySelector("#search-data");
147439
147445
  if (!searchData) {
@@ -147451,33 +147457,68 @@ function setup() {
147451
147457
  const uf = new uFuzzy({
147452
147458
  intraIns: Infinity
147453
147459
  });
147454
- function updateResults() {
147455
- if (!index || searchTerm === "") {
147456
- results.innerHTML = "";
147457
- return;
147460
+ function getSearchResults(searchTerm2) {
147461
+ if (!index || searchTerm2 === "") {
147462
+ return [];
147458
147463
  }
147459
- const idxs = uf.filter(index.terms, searchTerm);
147464
+ const idxs = uf.filter(index.terms, searchTerm2);
147460
147465
  if (!idxs) {
147466
+ return [];
147467
+ }
147468
+ const info2 = uf.info(idxs, index.terms, searchTerm2);
147469
+ const order2 = uf.sort(info2, index.terms, searchTerm2);
147470
+ const results2 = [];
147471
+ const documentMapping = /* @__PURE__ */ new Map();
147472
+ for (const infoIdx of order2) {
147473
+ const termIdx = info2.idx[infoIdx];
147474
+ const resultIdx = index.mapping[termIdx];
147475
+ const term = index.terms[termIdx];
147476
+ const result = index.results[resultIdx];
147477
+ const highlighted = uFuzzy.highlight(term, info2.ranges[infoIdx]);
147478
+ const searchResult = {
147479
+ matchType: result.terms.includes(term) ? "term" : "title",
147480
+ highlighted,
147481
+ term,
147482
+ doc: {
147483
+ title: result.title,
147484
+ url: result.url
147485
+ }
147486
+ };
147487
+ if (documentMapping.has(result.url)) {
147488
+ const previousIndex = documentMapping.get(result.url);
147489
+ const previousResult = results2[previousIndex];
147490
+ if (isMoreSpecific(searchResult, previousResult)) {
147491
+ results2[previousIndex] = null;
147492
+ } else {
147493
+ continue;
147494
+ }
147495
+ }
147496
+ const resultIndex = results2.length;
147497
+ documentMapping.set(result.url, resultIndex);
147498
+ results2.push(searchResult);
147499
+ }
147500
+ return results2.filter((it) => it !== null);
147501
+ }
147502
+ function updateResults() {
147503
+ const searchResults = getSearchResults(searchTerm);
147504
+ if (searchResults.length === 0) {
147461
147505
  results.innerHTML = "";
147462
147506
  return;
147463
147507
  }
147464
- const info2 = uf.info(idxs, index.terms, searchTerm);
147465
- const order2 = uf.sort(info2, index.terms, searchTerm);
147466
147508
  active = 0;
147467
147509
  const rootUrl = document.documentElement.dataset.rootUrl ?? ".";
147468
147510
  const ul = document.createElement("ul");
147469
147511
  ul.classList.add("list");
147470
- for (let i3 = 0; i3 < order2.length; i3++) {
147471
- const infoIdx = order2[i3];
147472
- const termIdx = info2.idx[infoIdx];
147473
- const resultIdx = index.mapping[termIdx];
147512
+ for (let i3 = 0; i3 < searchResults.length; i3++) {
147513
+ const { matchType, highlighted, doc } = searchResults[i3];
147474
147514
  const li = document.createElement("li");
147475
147515
  const a2 = document.createElement("a");
147476
- a2.innerHTML = uFuzzy.highlight(
147477
- index.terms[termIdx],
147478
- info2.ranges[infoIdx]
147479
- );
147480
- a2.href = [rootUrl, index.results[resultIdx].url].join("/");
147516
+ if (matchType === "term") {
147517
+ a2.innerHTML = `${doc.title} (${highlighted})`;
147518
+ } else {
147519
+ a2.innerHTML = highlighted;
147520
+ }
147521
+ a2.href = [rootUrl, doc.url].join("/");
147481
147522
  a2.classList.add("list__item__itempane");
147482
147523
  li.classList.add("list__item");
147483
147524
  li.classList.toggle("list__item--active", i3 === active);
@@ -42,6 +42,41 @@
42
42
  --docs-breakpoint-lg: 1280px;
43
43
  }
44
44
 
45
+ .docs-badge {
46
+ border-radius: 4px;
47
+ border-style: solid;
48
+ border-width: 1px;
49
+ display: inline-block;
50
+ font-size: 1rem;
51
+ line-height: 1.5;
52
+ font-weight: normal;
53
+ padding: 0 0.5rem;
54
+ width: fit-content;
55
+ }
56
+ .docs-badge--component {
57
+ background: var(--docs-badge-component-background);
58
+ border-color: var(--docs-badge-component-background);
59
+ color: var(--docs-badge-component-color);
60
+ }
61
+
62
+ a.docs-badge {
63
+ text-decoration: none;
64
+ }
65
+ a.docs-badge:hover {
66
+ text-decoration: underline;
67
+ }
68
+
69
+ .docs-badge-list {
70
+ display: flex;
71
+ flex-flow: row wrap;
72
+ gap: 0.5rem;
73
+ }
74
+ @media (width >= 1280px) {
75
+ .docs-badge-list {
76
+ flex-direction: column;
77
+ }
78
+ }
79
+
45
80
  h1:not(.code-preview h1),
46
81
  h2:not(.code-preview h2),
47
82
  h3:not(.code-preview h3),
@@ -295,6 +330,15 @@ main {
295
330
  }
296
331
 
297
332
  .layout--content-with-menu #primary,
333
+ .layout--api #primary,
334
+ .layout--api--class #primary,
335
+ .layout--api--composable #primary,
336
+ .layout--api--constant #primary,
337
+ .layout--api--enum #primary,
338
+ .layout--api--function #primary,
339
+ .layout--api--interface #primary,
340
+ .layout--api--method #primary,
341
+ .layout--api--type #primary,
298
342
  .layout--article #primary,
299
343
  .layout--component #primary,
300
344
  .layout--pattern #primary {
@@ -304,6 +348,15 @@ main {
304
348
  }
305
349
  @media screen and (width >= 1280px) {
306
350
  .layout--content-with-menu #primary,
351
+ .layout--api #primary,
352
+ .layout--api--class #primary,
353
+ .layout--api--composable #primary,
354
+ .layout--api--constant #primary,
355
+ .layout--api--enum #primary,
356
+ .layout--api--function #primary,
357
+ .layout--api--interface #primary,
358
+ .layout--api--method #primary,
359
+ .layout--api--type #primary,
307
360
  .layout--article #primary,
308
361
  .layout--component #primary,
309
362
  .layout--pattern #primary {
@@ -311,6 +364,15 @@ main {
311
364
  }
312
365
  }
313
366
  .layout--content-with-menu main,
367
+ .layout--api main,
368
+ .layout--api--class main,
369
+ .layout--api--composable main,
370
+ .layout--api--constant main,
371
+ .layout--api--enum main,
372
+ .layout--api--function main,
373
+ .layout--api--interface main,
374
+ .layout--api--method main,
375
+ .layout--api--type main,
314
376
  .layout--article main,
315
377
  .layout--component main,
316
378
  .layout--pattern main {
@@ -320,6 +382,24 @@ main {
320
382
  }
321
383
  .layout--content-with-menu #title,
322
384
  .layout--content-with-menu #content,
385
+ .layout--api #title,
386
+ .layout--api #content,
387
+ .layout--api--class #title,
388
+ .layout--api--class #content,
389
+ .layout--api--composable #title,
390
+ .layout--api--composable #content,
391
+ .layout--api--constant #title,
392
+ .layout--api--constant #content,
393
+ .layout--api--enum #title,
394
+ .layout--api--enum #content,
395
+ .layout--api--function #title,
396
+ .layout--api--function #content,
397
+ .layout--api--interface #title,
398
+ .layout--api--interface #content,
399
+ .layout--api--method #title,
400
+ .layout--api--method #content,
401
+ .layout--api--type #title,
402
+ .layout--api--type #content,
323
403
  .layout--article #title,
324
404
  .layout--article #content,
325
405
  .layout--component #title,
@@ -330,6 +410,15 @@ main {
330
410
  }
331
411
  @media screen and (width < 1280px) {
332
412
  .layout--content-with-menu #aside,
413
+ .layout--api #aside,
414
+ .layout--api--class #aside,
415
+ .layout--api--composable #aside,
416
+ .layout--api--constant #aside,
417
+ .layout--api--enum #aside,
418
+ .layout--api--function #aside,
419
+ .layout--api--interface #aside,
420
+ .layout--api--method #aside,
421
+ .layout--api--type #aside,
333
422
  .layout--article #aside,
334
423
  .layout--component #aside,
335
424
  .layout--pattern #aside {
@@ -42,6 +42,41 @@
42
42
  --docs-breakpoint-lg: 1280px;
43
43
  }
44
44
 
45
+ .docs-badge {
46
+ border-radius: 4px;
47
+ border-style: solid;
48
+ border-width: 1px;
49
+ display: inline-block;
50
+ font-size: 1rem;
51
+ line-height: 1.5;
52
+ font-weight: normal;
53
+ padding: 0 0.5rem;
54
+ width: fit-content;
55
+ }
56
+ .docs-badge--component {
57
+ background: var(--docs-badge-component-background);
58
+ border-color: var(--docs-badge-component-background);
59
+ color: var(--docs-badge-component-color);
60
+ }
61
+
62
+ a.docs-badge {
63
+ text-decoration: none;
64
+ }
65
+ a.docs-badge:hover {
66
+ text-decoration: underline;
67
+ }
68
+
69
+ .docs-badge-list {
70
+ display: flex;
71
+ flex-flow: row wrap;
72
+ gap: 0.5rem;
73
+ }
74
+ @media (width >= 1280px) {
75
+ .docs-badge-list {
76
+ flex-direction: column;
77
+ }
78
+ }
79
+
45
80
  h1:not(.code-preview h1),
46
81
  h2:not(.code-preview h2),
47
82
  h3:not(.code-preview h3),
@@ -295,6 +330,15 @@ main {
295
330
  }
296
331
 
297
332
  .layout--content-with-menu #primary,
333
+ .layout--api #primary,
334
+ .layout--api--class #primary,
335
+ .layout--api--composable #primary,
336
+ .layout--api--constant #primary,
337
+ .layout--api--enum #primary,
338
+ .layout--api--function #primary,
339
+ .layout--api--interface #primary,
340
+ .layout--api--method #primary,
341
+ .layout--api--type #primary,
298
342
  .layout--article #primary,
299
343
  .layout--component #primary,
300
344
  .layout--pattern #primary {
@@ -304,6 +348,15 @@ main {
304
348
  }
305
349
  @media screen and (width >= 1280px) {
306
350
  .layout--content-with-menu #primary,
351
+ .layout--api #primary,
352
+ .layout--api--class #primary,
353
+ .layout--api--composable #primary,
354
+ .layout--api--constant #primary,
355
+ .layout--api--enum #primary,
356
+ .layout--api--function #primary,
357
+ .layout--api--interface #primary,
358
+ .layout--api--method #primary,
359
+ .layout--api--type #primary,
307
360
  .layout--article #primary,
308
361
  .layout--component #primary,
309
362
  .layout--pattern #primary {
@@ -311,6 +364,15 @@ main {
311
364
  }
312
365
  }
313
366
  .layout--content-with-menu main,
367
+ .layout--api main,
368
+ .layout--api--class main,
369
+ .layout--api--composable main,
370
+ .layout--api--constant main,
371
+ .layout--api--enum main,
372
+ .layout--api--function main,
373
+ .layout--api--interface main,
374
+ .layout--api--method main,
375
+ .layout--api--type main,
314
376
  .layout--article main,
315
377
  .layout--component main,
316
378
  .layout--pattern main {
@@ -320,6 +382,24 @@ main {
320
382
  }
321
383
  .layout--content-with-menu #title,
322
384
  .layout--content-with-menu #content,
385
+ .layout--api #title,
386
+ .layout--api #content,
387
+ .layout--api--class #title,
388
+ .layout--api--class #content,
389
+ .layout--api--composable #title,
390
+ .layout--api--composable #content,
391
+ .layout--api--constant #title,
392
+ .layout--api--constant #content,
393
+ .layout--api--enum #title,
394
+ .layout--api--enum #content,
395
+ .layout--api--function #title,
396
+ .layout--api--function #content,
397
+ .layout--api--interface #title,
398
+ .layout--api--interface #content,
399
+ .layout--api--method #title,
400
+ .layout--api--method #content,
401
+ .layout--api--type #title,
402
+ .layout--api--type #content,
323
403
  .layout--article #title,
324
404
  .layout--article #content,
325
405
  .layout--component #title,
@@ -330,6 +410,15 @@ main {
330
410
  }
331
411
  @media screen and (width < 1280px) {
332
412
  .layout--content-with-menu #aside,
413
+ .layout--api #aside,
414
+ .layout--api--class #aside,
415
+ .layout--api--composable #aside,
416
+ .layout--api--constant #aside,
417
+ .layout--api--enum #aside,
418
+ .layout--api--function #aside,
419
+ .layout--api--interface #aside,
420
+ .layout--api--method #aside,
421
+ .layout--api--type #aside,
333
422
  .layout--article #aside,
334
423
  .layout--component #aside,
335
424
  .layout--pattern #aside {
@@ -1258,6 +1347,8 @@ kbd {
1258
1347
  --docs-warning-background: #fffcf3;
1259
1348
  --docs-error-color: #ca1515;
1260
1349
  --docs-error-background: #fcf3f3;
1350
+ --docs-badge-component-color: var(--docs-text-color-default);
1351
+ --docs-badge-component-background: #ddddde;
1261
1352
  --docs-contextmenu-background-color: #ffffff;
1262
1353
  --docs-contextmenu-border-color: #ddddde;
1263
1354
  --docs-contextmenu-highlight-color: #e7f0e9;
@@ -11,6 +11,8 @@
11
11
  --docs-warning-background: #fffcf3;
12
12
  --docs-error-color: #ca1515;
13
13
  --docs-error-background: #fcf3f3;
14
+ --docs-badge-component-color: var(--docs-text-color-default);
15
+ --docs-badge-component-background: #ddddde;
14
16
  --docs-contextmenu-background-color: #ffffff;
15
17
  --docs-contextmenu-border-color: #ddddde;
16
18
  --docs-contextmenu-highlight-color: #e7f0e9;
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.52.2"
8
+ "packageVersion": "7.52.4"
9
9
  }
10
10
  ]
11
11
  }