@jpmorganchase/mosaic-plugins 0.1.0-beta.9 → 0.1.0-beta.91

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 (81) hide show
  1. package/dist/$AliasPlugin.d.ts +10 -0
  2. package/dist/$AliasPlugin.js +34 -46
  3. package/dist/$AliasPlugin.js.map +1 -1
  4. package/dist/$CodeModPlugin.d.ts +7 -0
  5. package/dist/$CodeModPlugin.js +12 -28
  6. package/dist/$CodeModPlugin.js.map +1 -1
  7. package/dist/$RefPlugin.d.ts +31 -0
  8. package/dist/$RefPlugin.js +109 -108
  9. package/dist/$RefPlugin.js.map +1 -1
  10. package/dist/$TagPlugin.d.ts +28 -0
  11. package/dist/$TagPlugin.js +24 -44
  12. package/dist/$TagPlugin.js.map +1 -1
  13. package/dist/BreadcrumbsPlugin.d.ts +19 -0
  14. package/dist/BreadcrumbsPlugin.js +81 -37
  15. package/dist/BreadcrumbsPlugin.js.map +1 -1
  16. package/dist/BrokenLinksPlugin.d.ts +10 -0
  17. package/dist/BrokenLinksPlugin.js +80 -0
  18. package/dist/BrokenLinksPlugin.js.map +1 -0
  19. package/dist/DocumentAssetsPlugin.d.ts +28 -0
  20. package/dist/DocumentAssetsPlugin.js +144 -0
  21. package/dist/DocumentAssetsPlugin.js.map +1 -0
  22. package/dist/FragmentPlugin.d.ts +3 -0
  23. package/dist/FragmentPlugin.js +64 -0
  24. package/dist/FragmentPlugin.js.map +1 -0
  25. package/dist/LazyPagePlugin.d.ts +14 -0
  26. package/dist/LazyPagePlugin.js +45 -79
  27. package/dist/LazyPagePlugin.js.map +1 -1
  28. package/dist/PagesWithoutFileExtPlugin.d.ts +9 -0
  29. package/dist/PagesWithoutFileExtPlugin.js +14 -29
  30. package/dist/PagesWithoutFileExtPlugin.js.map +1 -1
  31. package/dist/PropsTablePlugin.d.ts +6 -0
  32. package/dist/PropsTablePlugin.js +88 -0
  33. package/dist/PropsTablePlugin.js.map +1 -0
  34. package/dist/PublicAssetsPlugin.d.ts +18 -0
  35. package/dist/PublicAssetsPlugin.js +27 -0
  36. package/dist/PublicAssetsPlugin.js.map +1 -0
  37. package/dist/ReadingTimePlugin.d.ts +10 -0
  38. package/dist/ReadingTimePlugin.js +39 -0
  39. package/dist/ReadingTimePlugin.js.map +1 -0
  40. package/dist/SearchIndexPlugin.d.ts +56 -0
  41. package/dist/SearchIndexPlugin.js +154 -0
  42. package/dist/SearchIndexPlugin.js.map +1 -0
  43. package/dist/SharedConfigPlugin.d.ts +14 -0
  44. package/dist/SharedConfigPlugin.js +124 -32
  45. package/dist/SharedConfigPlugin.js.map +1 -1
  46. package/dist/SidebarPlugin.d.ts +45 -0
  47. package/dist/SidebarPlugin.js +276 -87
  48. package/dist/SidebarPlugin.js.map +1 -1
  49. package/dist/SiteMapPlugin.d.ts +9 -0
  50. package/dist/SiteMapPlugin.js +20 -34
  51. package/dist/SiteMapPlugin.js.map +1 -1
  52. package/dist/TableOfContentsPlugin.d.ts +26 -0
  53. package/dist/TableOfContentsPlugin.js +67 -0
  54. package/dist/TableOfContentsPlugin.js.map +1 -0
  55. package/dist/utils/PluginError.d.ts +7 -0
  56. package/dist/utils/PluginError.js +13 -0
  57. package/dist/utils/PluginError.js.map +1 -0
  58. package/dist/utils/createPageTest.d.ts +1 -0
  59. package/dist/utils/createPageTest.js +8 -0
  60. package/dist/utils/createPageTest.js.map +1 -0
  61. package/dist/utils/mergePageContent.d.ts +16 -0
  62. package/dist/utils/mergePageContent.js +23 -0
  63. package/dist/utils/mergePageContent.js.map +1 -0
  64. package/dist/utils/normaliseRefs.d.ts +1 -0
  65. package/dist/utils/normaliseRefs.js +52 -69
  66. package/dist/utils/normaliseRefs.js.map +1 -1
  67. package/dist/utils/sortSidebarData.d.ts +29 -0
  68. package/dist/utils/sortSidebarData.js +47 -0
  69. package/dist/utils/sortSidebarData.js.map +1 -0
  70. package/package.json +45 -27
  71. package/CHANGELOG.md +0 -109
  72. package/dist/LocalFolderSavePlugin.js +0 -48
  73. package/dist/LocalFolderSavePlugin.js.map +0 -1
  74. package/dist/NextPrevPagePlugin.js +0 -63
  75. package/dist/NextPrevPagePlugin.js.map +0 -1
  76. package/dist/ReadingTimePlugin.mjs +0 -119
  77. package/dist/ReadingTimePlugin.mjs.map +0 -1
  78. package/dist/SearchIndexPlugin.mjs +0 -268
  79. package/dist/SearchIndexPlugin.mjs.map +0 -1
  80. package/dist/TableOfContentsPlugin.mjs +0 -131
  81. package/dist/TableOfContentsPlugin.mjs.map +0 -1
@@ -1,119 +0,0 @@
1
- function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
2
- try {
3
- var info = gen[key](arg);
4
- var value = info.value;
5
- } catch (error) {
6
- reject(error);
7
- return;
8
- }
9
- if (info.done) {
10
- resolve(value);
11
- } else {
12
- Promise.resolve(value).then(_next, _throw);
13
- }
14
- }
15
- function _asyncToGenerator(fn) {
16
- return function() {
17
- var self = this, args = arguments;
18
- return new Promise(function(resolve, reject) {
19
- var gen = fn.apply(self, args);
20
- function _next(value) {
21
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
22
- }
23
- function _throw(err) {
24
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
25
- }
26
- _next(undefined);
27
- });
28
- };
29
- }
30
- import regeneratorRuntime from "regenerator-runtime";
31
- import getReadingTime from "reading-time";
32
- import markdown from "remark-parse";
33
- import { unified } from "unified";
34
- import { visit } from "unist-util-visit";
35
- /**
36
- * Calculates reading time for pages and adds to frontmatter
37
- */ var ReadingTimePlugin = {
38
- $afterSource: function $afterSource(pages) {
39
- return _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee() {
40
- var processor, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _iterator, _step, page, tree, textContent;
41
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
42
- while(1)switch(_ctx.prev = _ctx.next){
43
- case 0:
44
- processor = unified().use(markdown);
45
- _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
46
- _ctx.prev = 2;
47
- _iterator = pages[Symbol.iterator]();
48
- case 4:
49
- if (_iteratorNormalCompletion = (_step = _iterator.next()).done) {
50
- _ctx.next = 15;
51
- break;
52
- }
53
- page = _step.value;
54
- _ctx.next = 8;
55
- return processor.parse(page.content);
56
- case 8:
57
- tree = _ctx.sent;
58
- textContent = "";
59
- visit(tree, function(node) {
60
- return node.type === "text" || node.type === "code";
61
- }, function(node) {
62
- textContent += node.value;
63
- });
64
- page.readingTime = getReadingTime(textContent);
65
- case 12:
66
- _iteratorNormalCompletion = true;
67
- _ctx.next = 4;
68
- break;
69
- case 15:
70
- _ctx.next = 21;
71
- break;
72
- case 17:
73
- _ctx.prev = 17;
74
- _ctx.t0 = _ctx["catch"](2);
75
- _didIteratorError = true;
76
- _iteratorError = _ctx.t0;
77
- case 21:
78
- _ctx.prev = 21;
79
- _ctx.prev = 22;
80
- if (!_iteratorNormalCompletion && _iterator.return != null) {
81
- _iterator.return();
82
- }
83
- case 24:
84
- _ctx.prev = 24;
85
- if (!_didIteratorError) {
86
- _ctx.next = 27;
87
- break;
88
- }
89
- throw _iteratorError;
90
- case 27:
91
- return _ctx.finish(24);
92
- case 28:
93
- return _ctx.finish(21);
94
- case 29:
95
- return _ctx.abrupt("return", pages);
96
- case 30:
97
- case "end":
98
- return _ctx.stop();
99
- }
100
- }, _callee, null, [
101
- [
102
- 2,
103
- 17,
104
- 21,
105
- 29
106
- ],
107
- [
108
- 22,
109
- ,
110
- 24,
111
- 28
112
- ]
113
- ]);
114
- }))();
115
- }
116
- };
117
- export default ReadingTimePlugin;
118
-
119
- //# sourceMappingURL=ReadingTimePlugin.mjs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/ReadingTimePlugin.mjs.ts"],"sourcesContent":["import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';\nimport getReadingTime from 'reading-time';\nimport markdown from 'remark-parse';\nimport { unified } from 'unified';\nimport { visit } from 'unist-util-visit';\nimport type { Node } from 'unist';\n\ntype LeafNode = Node & {\n value?: string;\n};\n\ninterface ReadingTimePluginPage extends Page {\n readingTime?: ReturnType<typeof getReadingTime>;\n}\n\n/**\n * Calculates reading time for pages and adds to frontmatter\n */\nconst ReadingTimePlugin: PluginType<ReadingTimePluginPage> = {\n async $afterSource(pages) {\n const processor = unified().use(markdown);\n for (const page of pages) {\n const tree = await processor.parse(page.content);\n let textContent = '';\n\n visit(\n tree,\n node => node.type === 'text' || node.type === 'code',\n (node: LeafNode) => {\n textContent += node.value;\n }\n );\n page.readingTime = getReadingTime(textContent);\n }\n\n return pages;\n }\n};\n\nexport default ReadingTimePlugin;\n"],"names":["getReadingTime","markdown","unified","visit","ReadingTimePlugin","$afterSource","pages","processor","page","tree","textContent","use","parse","content","node","type","value","readingTime"],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAOA,cAAc,MAAM,cAAc,CAAC;AAC1C,OAAOC,QAAQ,MAAM,cAAc,CAAC;AACpC,SAASC,OAAO,QAAQ,SAAS,CAAC;AAClC,SAASC,KAAK,QAAQ,kBAAkB,CAAC;AAWzC;;CAEC,GACD,IAAMC,iBAAiB,GAAsC;IACrDC,YAAY,EAAlB,SAAMA,YAAY,CAACC,KAAK;eAAE,wDAAA,mBAAA;gBAClBC,SAAS,EACV,yBAAU,EAAV,iBAAU,EAAV,cAAU,EAAV,SAAU,EAAV,KAAU,EAAJC,IAAI,EACPC,IAAI,EACNC,WAAW;;;;wBAHXH,SAAS,GAAGL,OAAO,EAAE,CAACS,GAAG,CAACV,QAAQ,CAAC,CAAC;wBACrC,yBAAU,SAAV,iBAAU,UAAV,cAAU;;wBAAV,SAAU,GAAIK,KAAK;;4BAAnB,yBAAU,IAAV,KAAU,GAAV,SAAU;;;;wBAAJE,IAAI,GAAV,KAAU,MAAA;;+BACMD,SAAS,CAACK,KAAK,CAACJ,IAAI,CAACK,OAAO,CAAC;;wBAA1CJ,IAAI,YAAsC,CAAA;wBAC5CC,WAAW,GAAG,EAAE,CAAC;wBAErBP,KAAK,CACHM,IAAI,EACJK,SAAAA,IAAI;mCAAIA,IAAI,CAACC,IAAI,KAAK,MAAM,IAAID,IAAI,CAACC,IAAI,KAAK,MAAM;yBAAA,EACpD,SAACD,IAAc,EAAK;4BAClBJ,WAAW,IAAII,IAAI,CAACE,KAAK,CAAC;yBAC3B,CACF,CAAC;wBACFR,IAAI,CAACS,WAAW,GAAGjB,cAAc,CAACU,WAAW,CAAC,CAAC;;wBAX5C,yBAAU;;;;;;;;;wBAAV,iBAAU;wBAAV,cAAU;;;;6BAAV,yBAAU,IAAV,SAAU;4BAAV,SAAU;;;;4BAAV,CAAA,iBAAU;;;;8BAAV,cAAU;;;;;;qDAcRJ,KAAK;;;;;;;;;;;;;;;;;;;SACb,EAAA;KAAA;CACF,AAAC;AAEF,eAAeF,iBAAiB,CAAC"}
@@ -1,268 +0,0 @@
1
- function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
2
- try {
3
- var info = gen[key](arg);
4
- var value = info.value;
5
- } catch (error) {
6
- reject(error);
7
- return;
8
- }
9
- if (info.done) {
10
- resolve(value);
11
- } else {
12
- Promise.resolve(value).then(_next, _throw);
13
- }
14
- }
15
- function _asyncToGenerator(fn) {
16
- return function() {
17
- var self = this, args = arguments;
18
- return new Promise(function(resolve, reject) {
19
- var gen = fn.apply(self, args);
20
- function _next(value) {
21
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
22
- }
23
- function _throw(err) {
24
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
25
- }
26
- _next(undefined);
27
- });
28
- };
29
- }
30
- function _defineProperty(obj, key, value) {
31
- if (key in obj) {
32
- Object.defineProperty(obj, key, {
33
- value: value,
34
- enumerable: true,
35
- configurable: true,
36
- writable: true
37
- });
38
- } else {
39
- obj[key] = value;
40
- }
41
- return obj;
42
- }
43
- function _objectSpread(target) {
44
- for(var i = 1; i < arguments.length; i++){
45
- var source = arguments[i] != null ? arguments[i] : {};
46
- var ownKeys = Object.keys(source);
47
- if (typeof Object.getOwnPropertySymbols === "function") {
48
- ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
49
- return Object.getOwnPropertyDescriptor(source, sym).enumerable;
50
- }));
51
- }
52
- ownKeys.forEach(function(key) {
53
- _defineProperty(target, key, source[key]);
54
- });
55
- }
56
- return target;
57
- }
58
- function ownKeys(object, enumerableOnly) {
59
- var keys = Object.keys(object);
60
- if (Object.getOwnPropertySymbols) {
61
- var symbols = Object.getOwnPropertySymbols(object);
62
- if (enumerableOnly) {
63
- symbols = symbols.filter(function(sym) {
64
- return Object.getOwnPropertyDescriptor(object, sym).enumerable;
65
- });
66
- }
67
- keys.push.apply(keys, symbols);
68
- }
69
- return keys;
70
- }
71
- function _objectSpreadProps(target, source) {
72
- source = source != null ? source : {};
73
- if (Object.getOwnPropertyDescriptors) {
74
- Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
75
- } else {
76
- ownKeys(Object(source)).forEach(function(key) {
77
- Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
78
- });
79
- }
80
- return target;
81
- }
82
- import regeneratorRuntime from "regenerator-runtime";
83
- import { unified } from "unified";
84
- import markdown from "remark-parse";
85
- import remarkMdx from "remark-mdx";
86
- import { visit } from "unist-util-visit";
87
- /**
88
- * Converts raw content string into an array of sentences suitable for inclusion
89
- * in the search index
90
- *
91
- * @param options.content the raw content string
92
- * @param options.title the title of the page (used for adding context to parse errors)
93
- * @param options.maxLineLength the maximum length of a sentence (set this to match the
94
- * "location" option in your Fuse.js configuration). Sentences longer than this value will be
95
- * truncated.
96
- * @param options.maxLineCount the maximum number of lines to include in the search index for
97
- * each page. Pages with more lines than this value will be truncated.
98
- * @returns array of sentence strings
99
- */ var optimizeContentForSearch = function() {
100
- var _ref = _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee(param) {
101
- var content, title, maxLineLength, maxLineCount, processor, tree, sentences;
102
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
103
- while(1)switch(_ctx.prev = _ctx.next){
104
- case 0:
105
- content = param.content, title = param.title, maxLineLength = param.maxLineLength, maxLineCount = param.maxLineCount;
106
- if (!(!content || content.length < 1)) {
107
- _ctx.next = 3;
108
- break;
109
- }
110
- return _ctx.abrupt("return", [
111
- content
112
- ]);
113
- case 3:
114
- processor = unified().use(markdown).use(remarkMdx);
115
- ;
116
- _ctx.prev = 5;
117
- _ctx.next = 8;
118
- return processor.parse(content);
119
- case 8:
120
- tree = _ctx.sent;
121
- _ctx.next = 15;
122
- break;
123
- case 11:
124
- _ctx.prev = 11;
125
- _ctx.t0 = _ctx["catch"](5);
126
- console.error("Search Index Plugin failed to parse content for ".concat(title), _ctx.t0.reason);
127
- return _ctx.abrupt("return", []);
128
- case 15:
129
- sentences = [];
130
- visit(tree, function(node) {
131
- return node.type === "text" || node.type === "code";
132
- }, function(node) {
133
- if (maxLineLength) {
134
- sentences.push(node.value.slice(0, maxLineLength));
135
- } else {
136
- sentences.push(node.value);
137
- }
138
- });
139
- if (!maxLineLength) {
140
- _ctx.next = 19;
141
- break;
142
- }
143
- return _ctx.abrupt("return", sentences.slice(0, maxLineCount));
144
- case 19:
145
- return _ctx.abrupt("return", sentences);
146
- case 20:
147
- case "end":
148
- return _ctx.stop();
149
- }
150
- }, _callee, null, [
151
- [
152
- 5,
153
- 11
154
- ]
155
- ]);
156
- }));
157
- return function optimizeContentForSearch(_) {
158
- return _ref.apply(this, arguments);
159
- };
160
- }();
161
- /**
162
- * Creates a search-data.json file that contains all the information from a page that is required
163
- * to generate a search index
164
- */ var SearchIndexPlugin = {
165
- afterUpdate: function afterUpdate(mutableFilesystem, param, param1) {
166
- var sharedFilesystem = param.sharedFilesystem, serialiser = param.serialiser, ignorePages = param.ignorePages, maxLineLength = param1.maxLineLength, maxLineCount = param1.maxLineCount, keys = param1.keys;
167
- return _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee() {
168
- var pages, searchData;
169
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
170
- while(1)switch(_ctx.prev = _ctx.next){
171
- case 0:
172
- _ctx.t0 = Promise;
173
- _ctx.next = 3;
174
- return mutableFilesystem.promises.glob("**", {
175
- onlyFiles: true,
176
- ignore: ignorePages.map(function(ignore) {
177
- return "**/".concat(ignore);
178
- }),
179
- cwd: "/"
180
- });
181
- case 3:
182
- _ctx.t1 = _ctx.sent.map(function() {
183
- var _ref = _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee(pagePath) {
184
- var deserialisedPage;
185
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
186
- while(1)switch(_ctx.prev = _ctx.next){
187
- case 0:
188
- _ctx.t0 = serialiser;
189
- _ctx.t1 = pagePath;
190
- _ctx.next = 4;
191
- return mutableFilesystem.promises.readFile(pagePath);
192
- case 4:
193
- _ctx.t2 = _ctx.sent;
194
- _ctx.next = 7;
195
- return _ctx.t0.deserialise.call(_ctx.t0, _ctx.t1, _ctx.t2);
196
- case 7:
197
- deserialisedPage = _ctx.sent;
198
- return _ctx.abrupt("return", deserialisedPage);
199
- case 9:
200
- case "end":
201
- return _ctx.stop();
202
- }
203
- }, _callee);
204
- }));
205
- return function(pagePath) {
206
- return _ref.apply(this, arguments);
207
- };
208
- }());
209
- _ctx.next = 6;
210
- return _ctx.t0.all.call(_ctx.t0, _ctx.t1);
211
- case 6:
212
- pages = _ctx.sent;
213
- _ctx.next = 9;
214
- return Promise.all(pages.map(function() {
215
- var _ref = _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee(page) {
216
- var content, defaultResults, extendedResults;
217
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
218
- while(1)switch(_ctx.prev = _ctx.next){
219
- case 0:
220
- _ctx.next = 2;
221
- return optimizeContentForSearch({
222
- content: page.content || "",
223
- title: page.title || "",
224
- maxLineLength: maxLineLength,
225
- maxLineCount: maxLineCount
226
- });
227
- case 2:
228
- content = _ctx.sent;
229
- defaultResults = {
230
- title: page.title,
231
- content: content,
232
- route: page.route
233
- };
234
- if (!(keys && keys.length > 0)) {
235
- _ctx.next = 7;
236
- break;
237
- }
238
- extendedResults = keys.reduce(function(acc, key) {
239
- return _objectSpreadProps(_objectSpread({}, acc), _defineProperty({}, key, page[key]));
240
- }, {});
241
- return _ctx.abrupt("return", _objectSpread({}, defaultResults, extendedResults));
242
- case 7:
243
- return _ctx.abrupt("return", defaultResults);
244
- case 8:
245
- case "end":
246
- return _ctx.stop();
247
- }
248
- }, _callee);
249
- }));
250
- return function(page) {
251
- return _ref.apply(this, arguments);
252
- };
253
- }()));
254
- case 9:
255
- searchData = _ctx.sent;
256
- _ctx.next = 12;
257
- return sharedFilesystem.promises.writeFile("/search-data.json", JSON.stringify(searchData));
258
- case 12:
259
- case "end":
260
- return _ctx.stop();
261
- }
262
- }, _callee);
263
- }))();
264
- }
265
- };
266
- export default SearchIndexPlugin;
267
-
268
- //# sourceMappingURL=SearchIndexPlugin.mjs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/SearchIndexPlugin.mjs.ts"],"sourcesContent":["import { unified } from 'unified';\nimport markdown from 'remark-parse';\nimport remarkMdx from 'remark-mdx';\nimport { visit } from 'unist-util-visit';\nimport type { Node } from 'unist';\nimport type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';\n\ntype LeafNode = Node & {\n value: string;\n};\n\ninterface SearchIndexPluginOptions {\n maxLineLength?: number;\n maxLineCount?: number;\n keys?: string[];\n}\n\ninterface Optimization {\n content: string;\n title: string;\n maxLineCount: number;\n maxLineLength: number;\n}\n\n/**\n * Converts raw content string into an array of sentences suitable for inclusion\n * in the search index\n *\n * @param options.content the raw content string\n * @param options.title the title of the page (used for adding context to parse errors)\n * @param options.maxLineLength the maximum length of a sentence (set this to match the\n * \"location\" option in your Fuse.js configuration). Sentences longer than this value will be\n * truncated.\n * @param options.maxLineCount the maximum number of lines to include in the search index for\n * each page. Pages with more lines than this value will be truncated.\n * @returns array of sentence strings\n */\nconst optimizeContentForSearch = async ({\n content,\n title,\n maxLineLength,\n maxLineCount\n}: Optimization) => {\n if (!content || content.length < 1) return [content];\n const processor = unified().use(markdown).use(remarkMdx);\n let tree;\n\n try {\n tree = await processor.parse(content);\n } catch (err) {\n console.error(`Search Index Plugin failed to parse content for ${title}`, err.reason);\n return [];\n }\n\n const sentences: string[] = [];\n\n visit(\n tree,\n node => node.type === 'text' || node.type === 'code',\n (node: LeafNode) => {\n if (maxLineLength) {\n sentences.push(node.value.slice(0, maxLineLength));\n } else {\n sentences.push(node.value);\n }\n }\n );\n\n if (maxLineLength) {\n return sentences.slice(0, maxLineCount);\n }\n return sentences;\n};\n\n/**\n * Creates a search-data.json file that contains all the information from a page that is required\n * to generate a search index\n */\nconst SearchIndexPlugin: PluginType<Page, SearchIndexPluginOptions> = {\n async afterUpdate(\n mutableFilesystem,\n { sharedFilesystem, serialiser, ignorePages },\n { maxLineLength, maxLineCount, keys }\n ) {\n const pages = await Promise.all(\n (\n (await mutableFilesystem.promises.glob('**', {\n onlyFiles: true,\n ignore: ignorePages.map(ignore => `**/${ignore}`),\n cwd: '/'\n })) as string[]\n ).map(async pagePath => {\n const deserialisedPage = await serialiser.deserialise(\n pagePath,\n await mutableFilesystem.promises.readFile(pagePath)\n );\n return deserialisedPage;\n })\n );\n\n const searchData = await Promise.all(\n pages.map(async page => {\n const content = await optimizeContentForSearch({\n content: page.content || '',\n title: page.title || '',\n maxLineLength,\n maxLineCount\n });\n const defaultResults = {\n title: page.title,\n content,\n route: page.route\n };\n\n if (keys && keys.length > 0) {\n const extendedResults = keys.reduce((acc, key) => ({ ...acc, [key]: page[key] }), {});\n return { ...defaultResults, ...extendedResults };\n }\n\n return defaultResults;\n })\n );\n\n await sharedFilesystem.promises.writeFile('/search-data.json', JSON.stringify(searchData));\n }\n};\n\nexport default SearchIndexPlugin;\n"],"names":["unified","markdown","remarkMdx","visit","optimizeContentForSearch","content","title","maxLineLength","maxLineCount","processor","tree","sentences","length","use","parse","console","error","err","reason","node","type","push","value","slice","SearchIndexPlugin","afterUpdate","mutableFilesystem","sharedFilesystem","serialiser","ignorePages","keys","pages","searchData","Promise","promises","glob","onlyFiles","ignore","map","cwd","pagePath","deserialisedPage","readFile","deserialise","all","page","defaultResults","extendedResults","route","reduce","acc","key","writeFile","JSON","stringify"],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAASA,OAAO,QAAQ,SAAS,CAAC;AAClC,OAAOC,QAAQ,MAAM,cAAc,CAAC;AACpC,OAAOC,SAAS,MAAM,YAAY,CAAC;AACnC,SAASC,KAAK,QAAQ,kBAAkB,CAAC;AAqBzC;;;;;;;;;;;;CAYC,GACD,IAAMC,wBAAwB;eAAG,wDAAA,wBAKb;YAJlBC,OAAO,EACPC,KAAK,EACLC,aAAa,EACbC,YAAY,EAGNC,SAAS,EACXC,IAAI,EASFC,SAAS;;;;oBAhBfN,OAAO,SAAPA,OAAO,EACPC,KAAK,SAALA,KAAK,EACLC,aAAa,SAAbA,aAAa,EACbC,YAAY,SAAZA,YAAY;wBAER,CAAA,CAAA,CAACH,OAAO,IAAIA,OAAO,CAACO,MAAM,GAAG,CAAC,CAAA;;;;iDAAS;wBAACP,OAAO;qBAAC;;oBAC9CI,SAAS,GAAGT,OAAO,EAAE,CAACa,GAAG,CAACZ,QAAQ,CAAC,CAACY,GAAG,CAACX,SAAS,CAAC,CAAC;qBAChD;;;2BAGMO,SAAS,CAACK,KAAK,CAACT,OAAO,CAAC;;oBAArCK,IAAI,YAAiC,CAAA;;;;;;oBAErCK,OAAO,CAACC,KAAK,CAAC,AAAC,kDAAgD,CAAQ,MAAA,CAANV,KAAK,CAAE,EAAEW,QAAIC,MAAM,CAAC,CAAC;iDAC/E,EAAE;;oBAGLP,SAAS,GAAa,EAAE,CAAC;oBAE/BR,KAAK,CACHO,IAAI,EACJS,SAAAA,IAAI;+BAAIA,IAAI,CAACC,IAAI,KAAK,MAAM,IAAID,IAAI,CAACC,IAAI,KAAK,MAAM;qBAAA,EACpD,SAACD,IAAc,EAAK;wBAClB,IAAIZ,aAAa,EAAE;4BACjBI,SAAS,CAACU,IAAI,CAACF,IAAI,CAACG,KAAK,CAACC,KAAK,CAAC,CAAC,EAAEhB,aAAa,CAAC,CAAC,CAAC;yBACpD,MAAM;4BACLI,SAAS,CAACU,IAAI,CAACF,IAAI,CAACG,KAAK,CAAC,CAAC;yBAC5B;qBACF,CACF,CAAC;wBAEEf,CAAAA,aAAa;;;;iDACRI,SAAS,CAACY,KAAK,CAAC,CAAC,EAAEf,YAAY,CAAC;;iDAElCG,SAAS;;;;;;;;;;;KACjB,EAAA;oBAnCKP,wBAAwB;;;GAmC7B,AAAC;AAEF;;;CAGC,GACD,IAAMoB,iBAAiB,GAA+C;IAC9DC,WAAW,EAAjB,SAAMA,WAAW,CACfC,iBAAiB,EACjB,KAA6C,EAC7C,MAAqC;YADnCC,gBAAgB,GAAlB,KAA6C,CAA3CA,gBAAgB,EAAEC,UAAU,GAA9B,KAA6C,CAAzBA,UAAU,EAAEC,WAAW,GAA3C,KAA6C,CAAbA,WAAW,EACzCtB,aAAa,GAAf,MAAqC,CAAnCA,aAAa,EAAEC,YAAY,GAA7B,MAAqC,CAApBA,YAAY,EAAEsB,IAAI,GAAnC,MAAqC,CAANA,IAAI;eACnC,wDAAA,mBAAA;gBACMC,KAAK,EAgBLC,UAAU;;;;kCAhBIC,OAAO;;+BAEhBP,iBAAiB,CAACQ,QAAQ,CAACC,IAAI,CAAC,IAAI,EAAE;4BAC3CC,SAAS,EAAE,IAAI;4BACfC,MAAM,EAAER,WAAW,CAACS,GAAG,CAACD,SAAAA,MAAM;uCAAI,AAAC,KAAG,CAAS,MAAA,CAAPA,MAAM,CAAE;6BAAA,CAAC;4BACjDE,GAAG,EAAE,GAAG;yBACT,CAAC;;kCALJ,UAMED,GAAG;uCAAC,wDAAA,iBAAME,QAAQ,EAAI;oCAChBC,gBAAgB;;;;sDAASb,UAAU;sDACvCY,QAAQ;;mDACFd,iBAAiB,CAACQ,QAAQ,CAACQ,QAAQ,CAACF,QAAQ,CAAC;;;;mDAFtBZ,QAAWe,WAAW,gCAGpD;;4CAHKF,gBAAgB,YAGrB,CAAA;yEACMA,gBAAgB;;;;;;6BACxB,EAAA;4CANWD,QAAQ;;;4BAMlB;;+BAbgBP,QAAQW,GAAG,uBAc9B;;wBAdKb,KAAK,YAcV,CAAA;;+BAEwBE,OAAO,CAACW,GAAG,CAClCb,KAAK,CAACO,GAAG;uCAAC,wDAAA,iBAAMO,IAAI,EAAI;oCAChBxC,OAAO,EAMPyC,cAAc,EAOZC,eAAe;;;;;mDAbD3C,wBAAwB,CAAC;gDAC7CC,OAAO,EAAEwC,IAAI,CAACxC,OAAO,IAAI,EAAE;gDAC3BC,KAAK,EAAEuC,IAAI,CAACvC,KAAK,IAAI,EAAE;gDACvBC,aAAa,EAAbA,aAAa;gDACbC,YAAY,EAAZA,YAAY;6CACb,CAAC;;4CALIH,OAAO,YAKX,CAAA;4CACIyC,cAAc,GAAG;gDACrBxC,KAAK,EAAEuC,IAAI,CAACvC,KAAK;gDACjBD,OAAO,EAAPA,OAAO;gDACP2C,KAAK,EAAEH,IAAI,CAACG,KAAK;6CAClB,CAAC;gDAEElB,CAAAA,CAAAA,IAAI,IAAIA,IAAI,CAAClB,MAAM,GAAG,CAAC,CAAA;;;;4CACnBmC,eAAe,GAAGjB,IAAI,CAACmB,MAAM,CAAC,SAACC,GAAG,EAAEC,GAAG;uDAAM,qCAAKD,GAAG,GAAE,oBAACC,GAAG,EAAGN,IAAI,CAACM,GAAG,CAAC,CAAA,CAAE;6CAAC,EAAE,EAAE,CAAC,CAAC;yEAC/E,kBAAKL,cAAc,EAAKC,eAAe,CAAE;;yEAG3CD,cAAc;;;;;;6BACtB,EAAA;4CAnBeD,IAAI;;;4BAmBlB,CACH;;wBArBKb,UAAU,YAqBf,CAAA;;+BAEKL,gBAAgB,CAACO,QAAQ,CAACkB,SAAS,CAAC,mBAAmB,EAAEC,IAAI,CAACC,SAAS,CAACtB,UAAU,CAAC,CAAC;;;;;;SAC3F,EAAA;KAAA;CACF,AAAC;AAEF,eAAeR,iBAAiB,CAAC"}
@@ -1,131 +0,0 @@
1
- function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
2
- try {
3
- var info = gen[key](arg);
4
- var value = info.value;
5
- } catch (error) {
6
- reject(error);
7
- return;
8
- }
9
- if (info.done) {
10
- resolve(value);
11
- } else {
12
- Promise.resolve(value).then(_next, _throw);
13
- }
14
- }
15
- function _asyncToGenerator(fn) {
16
- return function() {
17
- var self = this, args = arguments;
18
- return new Promise(function(resolve, reject) {
19
- var gen = fn.apply(self, args);
20
- function _next(value) {
21
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
22
- }
23
- function _throw(err) {
24
- asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
25
- }
26
- _next(undefined);
27
- });
28
- };
29
- }
30
- import regeneratorRuntime from "regenerator-runtime";
31
- import Slugger from "github-slugger";
32
- import remarkParse from "remark-parse";
33
- import { unified } from "unified";
34
- import remarkStringify from "remark-stringify";
35
- import remarkHeadings from "@vcarl/remark-headings";
36
- /**
37
- * Calculates table of contents from page headings
38
- */ var TableOfContentsPlugin = {
39
- $afterSource: function $afterSource(pages, _, param) {
40
- var minRank = param.minRank, maxRank = param.maxRank;
41
- return _asyncToGenerator(/*#__PURE__*/ regeneratorRuntime.mark(function _callee() {
42
- var processor, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _iterator, _step, page, slugger, vfile, headings, items;
43
- return regeneratorRuntime.wrap(function _callee$(_ctx) {
44
- while(1)switch(_ctx.prev = _ctx.next){
45
- case 0:
46
- processor = unified().use(remarkParse).use(remarkStringify).use(remarkHeadings);
47
- _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
48
- _ctx.prev = 2;
49
- _iterator = pages[Symbol.iterator]();
50
- case 4:
51
- if (_iteratorNormalCompletion = (_step = _iterator.next()).done) {
52
- _ctx.next = 17;
53
- break;
54
- }
55
- page = _step.value;
56
- slugger = new Slugger();
57
- if (!page.content) {
58
- _ctx.next = 14;
59
- break;
60
- }
61
- _ctx.next = 10;
62
- return processor.process(page.content);
63
- case 10:
64
- vfile = _ctx.sent;
65
- headings = vfile.data.headings;
66
- items = headings.filter(function(heading) {
67
- return heading.depth >= minRank && heading.depth <= maxRank;
68
- }).map(function(validHeading) {
69
- var text = validHeading.value.trim();
70
- return {
71
- level: validHeading.depth,
72
- id: slugger.slug(text),
73
- text: text
74
- };
75
- });
76
- page.tableOfContents = items;
77
- case 14:
78
- _iteratorNormalCompletion = true;
79
- _ctx.next = 4;
80
- break;
81
- case 17:
82
- _ctx.next = 23;
83
- break;
84
- case 19:
85
- _ctx.prev = 19;
86
- _ctx.t0 = _ctx["catch"](2);
87
- _didIteratorError = true;
88
- _iteratorError = _ctx.t0;
89
- case 23:
90
- _ctx.prev = 23;
91
- _ctx.prev = 24;
92
- if (!_iteratorNormalCompletion && _iterator.return != null) {
93
- _iterator.return();
94
- }
95
- case 26:
96
- _ctx.prev = 26;
97
- if (!_didIteratorError) {
98
- _ctx.next = 29;
99
- break;
100
- }
101
- throw _iteratorError;
102
- case 29:
103
- return _ctx.finish(26);
104
- case 30:
105
- return _ctx.finish(23);
106
- case 31:
107
- return _ctx.abrupt("return", pages);
108
- case 32:
109
- case "end":
110
- return _ctx.stop();
111
- }
112
- }, _callee, null, [
113
- [
114
- 2,
115
- 19,
116
- 23,
117
- 31
118
- ],
119
- [
120
- 24,
121
- ,
122
- 26,
123
- 30
124
- ]
125
- ]);
126
- }))();
127
- }
128
- };
129
- export default TableOfContentsPlugin;
130
-
131
- //# sourceMappingURL=TableOfContentsPlugin.mjs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/TableOfContentsPlugin.mjs.ts"],"sourcesContent":["import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';\nimport Slugger from 'github-slugger';\nimport remarkParse from 'remark-parse';\nimport { unified } from 'unified';\nimport remarkStringify from 'remark-stringify';\nimport remarkHeadings from '@vcarl/remark-headings';\nimport type { Heading as MarkdownHeading } from 'mdast';\n\ntype TOCItem = { level: number; id: string; text: string };\n\ninterface TableOfContentsPluginPage extends Page {\n tableOfContents?: TOCItem[];\n}\ntype Rank = MarkdownHeading['depth'];\ninterface TableOfContentsPluginOptions {\n minRank: Rank;\n maxRank: Rank;\n}\n\n/**\n * Calculates table of contents from page headings\n */\nconst TableOfContentsPlugin: PluginType<TableOfContentsPluginPage, TableOfContentsPluginOptions> = {\n async $afterSource(pages, _, { minRank, maxRank }) {\n const processor = unified().use(remarkParse).use(remarkStringify).use(remarkHeadings);\n for (const page of pages) {\n const slugger = new Slugger();\n if (page.content) {\n const vfile = await processor.process(page.content);\n const headings = vfile.data.headings as [{ depth: number; value: string }];\n const items: TOCItem[] = headings\n .filter(heading => heading.depth >= minRank && heading.depth <= maxRank)\n .map(validHeading => {\n const text = validHeading.value.trim();\n return {\n level: validHeading.depth,\n id: slugger.slug(text),\n text\n };\n });\n page.tableOfContents = items;\n }\n }\n\n return pages;\n }\n};\n\nexport default TableOfContentsPlugin;\n"],"names":["Slugger","remarkParse","unified","remarkStringify","remarkHeadings","TableOfContentsPlugin","$afterSource","pages","_","minRank","maxRank","processor","page","slugger","vfile","headings","items","use","content","process","data","filter","heading","depth","map","validHeading","text","value","trim","level","id","slug","tableOfContents"],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAOA,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAOC,WAAW,MAAM,cAAc,CAAC;AACvC,SAASC,OAAO,QAAQ,SAAS,CAAC;AAClC,OAAOC,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAOC,cAAc,MAAM,wBAAwB,CAAC;AAcpD;;CAEC,GACD,IAAMC,qBAAqB,GAAwE;IAC3FC,YAAY,EAAlB,SAAMA,YAAY,CAACC,KAAK,EAAEC,CAAC,EAAE,KAAoB;YAAlBC,OAAO,GAAT,KAAoB,CAAlBA,OAAO,EAAEC,OAAO,GAAlB,KAAoB,CAATA,OAAO;eAAI,wDAAA,mBAAA;gBAC3CC,SAAS,EACV,yBAAU,EAAV,iBAAU,EAAV,cAAU,EAAV,SAAU,EAAV,KAAU,EAAJC,IAAI,EACPC,OAAO,EAELC,KAAK,EACLC,QAAQ,EACRC,KAAK;;;;wBANTL,SAAS,GAAGT,OAAO,EAAE,CAACe,GAAG,CAAChB,WAAW,CAAC,CAACgB,GAAG,CAACd,eAAe,CAAC,CAACc,GAAG,CAACb,cAAc,CAAC,CAAC;wBACjF,yBAAU,SAAV,iBAAU,UAAV,cAAU;;wBAAV,SAAU,GAAIG,KAAK;;4BAAnB,yBAAU,IAAV,KAAU,GAAV,SAAU;;;;wBAAJK,IAAI,GAAV,KAAU,MAAA;wBACPC,OAAO,GAAG,IAAIb,OAAO,EAAE,CAAC;4BAC1BY,CAAAA,IAAI,CAACM,OAAO;;;;;+BACMP,SAAS,CAACQ,OAAO,CAACP,IAAI,CAACM,OAAO,CAAC;;wBAA7CJ,KAAK,YAAwC,CAAA;wBAC7CC,QAAQ,GAAGD,KAAK,CAACM,IAAI,CAACL,QAAQ,AAAsC,CAAC;wBACrEC,KAAK,GAAcD,QAAQ,CAC9BM,MAAM,CAACC,SAAAA,OAAO;mCAAIA,OAAO,CAACC,KAAK,IAAId,OAAO,IAAIa,OAAO,CAACC,KAAK,IAAIb,OAAO;yBAAA,CAAC,CACvEc,GAAG,CAACC,SAAAA,YAAY,EAAI;4BACnB,IAAMC,IAAI,GAAGD,YAAY,CAACE,KAAK,CAACC,IAAI,EAAE,AAAC;4BACvC,OAAO;gCACLC,KAAK,EAAEJ,YAAY,CAACF,KAAK;gCACzBO,EAAE,EAAEjB,OAAO,CAACkB,IAAI,CAACL,IAAI,CAAC;gCACtBA,IAAI,EAAJA,IAAI;6BACL,CAAC;yBACH,CAAC,CAAC;wBACLd,IAAI,CAACoB,eAAe,GAAGhB,KAAK,CAAC;;wBAf5B,yBAAU;;;;;;;;;wBAAV,iBAAU;wBAAV,cAAU;;;;6BAAV,yBAAU,IAAV,SAAU;4BAAV,SAAU;;;;4BAAV,CAAA,iBAAU;;;;8BAAV,cAAU;;;;;;qDAmBRT,KAAK;;;;;;;;;;;;;;;;;;;SACb,EAAA;KAAA;CACF,AAAC;AAEF,eAAeF,qBAAqB,CAAC"}