honkit 4.0.7 → 5.0.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 (566) hide show
  1. package/lib/BuildGenerator.d.ts +13 -0
  2. package/lib/BuildGenerator.d.ts.map +1 -0
  3. package/lib/__tests__/__fixtures__/honkit/book.d.ts +7 -0
  4. package/lib/__tests__/__fixtures__/honkit/book.d.ts.map +1 -0
  5. package/lib/__tests__/e2e.test.d.ts +2 -0
  6. package/lib/__tests__/e2e.test.d.ts.map +1 -0
  7. package/lib/__tests__/init.d.ts +2 -0
  8. package/lib/__tests__/init.d.ts.map +1 -0
  9. package/lib/__tests__/satisfies.d.ts +2 -0
  10. package/lib/__tests__/satisfies.d.ts.map +1 -0
  11. package/lib/__tests__/snapshot-asciidoc.d.ts +2 -0
  12. package/lib/__tests__/snapshot-asciidoc.d.ts.map +1 -0
  13. package/lib/__tests__/snapshot-asciidoc.js +48 -0
  14. package/lib/__tests__/snapshot-honkit.d.ts +2 -0
  15. package/lib/__tests__/snapshot-honkit.d.ts.map +1 -0
  16. package/lib/api/decodeConfig.d.ts +10 -0
  17. package/lib/api/decodeConfig.d.ts.map +1 -0
  18. package/lib/api/decodeGlobal.d.ts +11 -0
  19. package/lib/api/decodeGlobal.d.ts.map +1 -0
  20. package/lib/api/decodePage.d.ts +12 -0
  21. package/lib/api/decodePage.d.ts.map +1 -0
  22. package/lib/api/deprecate.d.ts +52 -0
  23. package/lib/api/deprecate.d.ts.map +1 -0
  24. package/lib/api/encodeConfig.d.ts +12 -0
  25. package/lib/api/encodeConfig.d.ts.map +1 -0
  26. package/lib/api/encodeGlobal.d.ts +165 -0
  27. package/lib/api/encodeGlobal.d.ts.map +1 -0
  28. package/lib/api/encodeGlobal.js +11 -9
  29. package/lib/api/encodeNavigation.d.ts +19 -0
  30. package/lib/api/encodeNavigation.d.ts.map +1 -0
  31. package/lib/api/encodePage.d.ts +16 -0
  32. package/lib/api/encodePage.d.ts.map +1 -0
  33. package/lib/api/encodeProgress.d.ts +25 -0
  34. package/lib/api/encodeProgress.d.ts.map +1 -0
  35. package/lib/api/encodeSummary.d.ts +49 -0
  36. package/lib/api/encodeSummary.d.ts.map +1 -0
  37. package/lib/api/index.d.ts +12 -0
  38. package/lib/api/index.d.ts.map +1 -0
  39. package/lib/bin.d.ts +2 -0
  40. package/lib/bin.d.ts.map +1 -0
  41. package/lib/browser.d.ts +60 -0
  42. package/lib/browser.d.ts.map +1 -0
  43. package/lib/cli/build.d.ts +17 -0
  44. package/lib/cli/build.d.ts.map +1 -0
  45. package/lib/cli/buildEbook.d.ts +12 -0
  46. package/lib/cli/buildEbook.d.ts.map +1 -0
  47. package/lib/cli/getBook.d.ts +12 -0
  48. package/lib/cli/getBook.d.ts.map +1 -0
  49. package/lib/cli/getOutputFolder.d.ts +9 -0
  50. package/lib/cli/getOutputFolder.d.ts.map +1 -0
  51. package/lib/cli/index.d.ts +25 -0
  52. package/lib/cli/index.d.ts.map +1 -0
  53. package/lib/cli/init.d.ts +13 -0
  54. package/lib/cli/init.d.ts.map +1 -0
  55. package/lib/cli/options.d.ts +26 -0
  56. package/lib/cli/options.d.ts.map +1 -0
  57. package/lib/cli/parse.d.ts +13 -0
  58. package/lib/cli/parse.d.ts.map +1 -0
  59. package/lib/cli/serve.d.ts +25 -0
  60. package/lib/cli/serve.d.ts.map +1 -0
  61. package/lib/cli/server.d.ts +29 -0
  62. package/lib/cli/server.d.ts.map +1 -0
  63. package/lib/cli/watch.d.ts +10 -0
  64. package/lib/cli/watch.d.ts.map +1 -0
  65. package/lib/constants/__tests__/configSchema.d.ts +2 -0
  66. package/lib/constants/__tests__/configSchema.d.ts.map +1 -0
  67. package/lib/constants/configDefault.d.ts +3 -0
  68. package/lib/constants/configDefault.d.ts.map +1 -0
  69. package/lib/constants/configFiles.d.ts +3 -0
  70. package/lib/constants/configFiles.d.ts.map +1 -0
  71. package/lib/constants/configSchema.d.ts +221 -0
  72. package/lib/constants/configSchema.d.ts.map +1 -0
  73. package/lib/constants/defaultBlocks.d.ts +5 -0
  74. package/lib/constants/defaultBlocks.d.ts.map +1 -0
  75. package/lib/constants/defaultBlocks.js +8 -7
  76. package/lib/constants/defaultFilters.d.ts +4 -0
  77. package/lib/constants/defaultFilters.d.ts.map +1 -0
  78. package/lib/constants/defaultPlugins.d.ts +5 -0
  79. package/lib/constants/defaultPlugins.d.ts.map +1 -0
  80. package/lib/constants/extsAsciidoc.d.ts +3 -0
  81. package/lib/constants/extsAsciidoc.d.ts.map +1 -0
  82. package/lib/constants/extsMarkdown.d.ts +3 -0
  83. package/lib/constants/extsMarkdown.d.ts.map +1 -0
  84. package/lib/constants/ignoreFiles.d.ts +3 -0
  85. package/lib/constants/ignoreFiles.d.ts.map +1 -0
  86. package/lib/constants/pluginAssetsFolder.d.ts +3 -0
  87. package/lib/constants/pluginAssetsFolder.d.ts.map +1 -0
  88. package/lib/constants/pluginHooks.d.ts +3 -0
  89. package/lib/constants/pluginHooks.d.ts.map +1 -0
  90. package/lib/constants/pluginPrefix.d.ts +3 -0
  91. package/lib/constants/pluginPrefix.d.ts.map +1 -0
  92. package/lib/constants/pluginResources.d.ts +4 -0
  93. package/lib/constants/pluginResources.d.ts.map +1 -0
  94. package/lib/constants/templatesFolder.d.ts +3 -0
  95. package/lib/constants/templatesFolder.d.ts.map +1 -0
  96. package/lib/constants/themePrefix.d.ts +3 -0
  97. package/lib/constants/themePrefix.d.ts.map +1 -0
  98. package/lib/fs/__tests__/mock.d.ts +2 -0
  99. package/lib/fs/__tests__/mock.d.ts.map +1 -0
  100. package/lib/fs/mock.d.ts +9 -0
  101. package/lib/fs/mock.d.ts.map +1 -0
  102. package/lib/fs/node.d.ts +3 -0
  103. package/lib/fs/node.d.ts.map +1 -0
  104. package/lib/honkit.d.ts +15 -0
  105. package/lib/honkit.d.ts.map +1 -0
  106. package/lib/index.d.ts +3 -0
  107. package/lib/index.d.ts.map +1 -0
  108. package/lib/init.d.ts +11 -0
  109. package/lib/init.d.ts.map +1 -0
  110. package/lib/json/encodeBook.d.ts +51 -0
  111. package/lib/json/encodeBook.d.ts.map +1 -0
  112. package/lib/json/encodeBookWithPage.d.ts +52 -0
  113. package/lib/json/encodeBookWithPage.d.ts.map +1 -0
  114. package/lib/json/encodeFile.d.ts +13 -0
  115. package/lib/json/encodeFile.d.ts.map +1 -0
  116. package/lib/json/encodeGlossary.d.ts +16 -0
  117. package/lib/json/encodeGlossary.d.ts.map +1 -0
  118. package/lib/json/encodeGlossaryEntry.d.ts +13 -0
  119. package/lib/json/encodeGlossaryEntry.d.ts.map +1 -0
  120. package/lib/json/encodeLanguages.d.ts +16 -0
  121. package/lib/json/encodeLanguages.d.ts.map +1 -0
  122. package/lib/json/encodeOutput.d.ts +51 -0
  123. package/lib/json/encodeOutput.d.ts.map +1 -0
  124. package/lib/json/encodeOutputWithPage.d.ts +52 -0
  125. package/lib/json/encodeOutputWithPage.d.ts.map +1 -0
  126. package/lib/json/encodePage.d.ts +19 -0
  127. package/lib/json/encodePage.d.ts.map +1 -0
  128. package/lib/json/encodeReadme.d.ts +15 -0
  129. package/lib/json/encodeReadme.d.ts.map +1 -0
  130. package/lib/json/encodeSummary.d.ts +16 -0
  131. package/lib/json/encodeSummary.d.ts.map +1 -0
  132. package/lib/json/encodeSummaryArticle.d.ts +19 -0
  133. package/lib/json/encodeSummaryArticle.d.ts.map +1 -0
  134. package/lib/json/encodeSummaryArticleWithCache.d.ts +20 -0
  135. package/lib/json/encodeSummaryArticleWithCache.d.ts.map +1 -0
  136. package/lib/json/encodeSummaryPart.d.ts +12 -0
  137. package/lib/json/encodeSummaryPart.d.ts.map +1 -0
  138. package/lib/json/index.d.ts +24 -0
  139. package/lib/json/index.d.ts.map +1 -0
  140. package/lib/models/__tests__/config.d.ts +2 -0
  141. package/lib/models/__tests__/config.d.ts.map +1 -0
  142. package/lib/models/__tests__/glossary.d.ts +2 -0
  143. package/lib/models/__tests__/glossary.d.ts.map +1 -0
  144. package/lib/models/__tests__/glossaryEntry.d.ts +2 -0
  145. package/lib/models/__tests__/glossaryEntry.d.ts.map +1 -0
  146. package/lib/models/__tests__/page.d.ts +2 -0
  147. package/lib/models/__tests__/page.d.ts.map +1 -0
  148. package/lib/models/__tests__/plugin.d.ts +2 -0
  149. package/lib/models/__tests__/plugin.d.ts.map +1 -0
  150. package/lib/models/__tests__/pluginDependency.d.ts +2 -0
  151. package/lib/models/__tests__/pluginDependency.d.ts.map +1 -0
  152. package/lib/models/__tests__/summary.d.ts +2 -0
  153. package/lib/models/__tests__/summary.d.ts.map +1 -0
  154. package/lib/models/__tests__/summaryArticle.d.ts +2 -0
  155. package/lib/models/__tests__/summaryArticle.d.ts.map +1 -0
  156. package/lib/models/__tests__/summaryPart.d.ts +2 -0
  157. package/lib/models/__tests__/summaryPart.d.ts.map +1 -0
  158. package/lib/models/__tests__/templateBlock.d.ts +2 -0
  159. package/lib/models/__tests__/templateBlock.d.ts.map +1 -0
  160. package/lib/models/__tests__/templateEngine.d.ts +2 -0
  161. package/lib/models/__tests__/templateEngine.d.ts.map +1 -0
  162. package/lib/models/book.d.ts +158 -0
  163. package/lib/models/book.d.ts.map +1 -0
  164. package/lib/models/config.d.ts +82 -0
  165. package/lib/models/config.d.ts.map +1 -0
  166. package/lib/models/file.d.ts +54 -0
  167. package/lib/models/file.d.ts.map +1 -0
  168. package/lib/models/file.js +11 -4
  169. package/lib/models/fs.d.ts +116 -0
  170. package/lib/models/fs.d.ts.map +1 -0
  171. package/lib/models/glossary.d.ts +42 -0
  172. package/lib/models/glossary.d.ts.map +1 -0
  173. package/lib/models/glossary.js +4 -4
  174. package/lib/models/glossaryEntry.d.ts +16 -0
  175. package/lib/models/glossaryEntry.d.ts.map +1 -0
  176. package/lib/models/hash.d.ts +4 -0
  177. package/lib/models/hash.d.ts.map +1 -0
  178. package/lib/models/ignore.d.ts +20 -0
  179. package/lib/models/ignore.d.ts.map +1 -0
  180. package/lib/models/language.d.ts +9 -0
  181. package/lib/models/language.d.ts.map +1 -0
  182. package/lib/models/languages.d.ts +35 -0
  183. package/lib/models/languages.d.ts.map +1 -0
  184. package/lib/models/output.d.ts +53 -0
  185. package/lib/models/output.d.ts.map +1 -0
  186. package/lib/models/page.d.ts +44 -0
  187. package/lib/models/page.d.ts.map +1 -0
  188. package/lib/models/parser.d.ts +44 -0
  189. package/lib/models/parser.d.ts.map +1 -0
  190. package/lib/models/parser.js +14 -14
  191. package/lib/models/plugin.d.ts +69 -0
  192. package/lib/models/plugin.d.ts.map +1 -0
  193. package/lib/models/pluginDependency.d.ts +47 -0
  194. package/lib/models/pluginDependency.d.ts.map +1 -0
  195. package/lib/models/readme.d.ts +21 -0
  196. package/lib/models/readme.d.ts.map +1 -0
  197. package/lib/models/summary.d.ts +83 -0
  198. package/lib/models/summary.d.ts.map +1 -0
  199. package/lib/models/summaryArticle.d.ts +93 -0
  200. package/lib/models/summaryArticle.d.ts.map +1 -0
  201. package/lib/models/summaryPart.d.ts +23 -0
  202. package/lib/models/summaryPart.d.ts.map +1 -0
  203. package/lib/models/templateBlock.d.ts +54 -0
  204. package/lib/models/templateBlock.d.ts.map +1 -0
  205. package/lib/models/templateEngine.d.ts +35 -0
  206. package/lib/models/templateEngine.d.ts.map +1 -0
  207. package/lib/models/templateOutput.d.ts +18 -0
  208. package/lib/models/templateOutput.d.ts.map +1 -0
  209. package/lib/models/templateShortcut.d.ts +28 -0
  210. package/lib/models/templateShortcut.d.ts.map +1 -0
  211. package/lib/models/templateShortcut.js +3 -3
  212. package/lib/modifiers/config/__tests__/addPlugin.d.ts +2 -0
  213. package/lib/modifiers/config/__tests__/addPlugin.d.ts.map +1 -0
  214. package/lib/modifiers/config/__tests__/removePlugin.d.ts +2 -0
  215. package/lib/modifiers/config/__tests__/removePlugin.d.ts.map +1 -0
  216. package/lib/modifiers/config/__tests__/togglePlugin.d.ts +2 -0
  217. package/lib/modifiers/config/__tests__/togglePlugin.d.ts.map +1 -0
  218. package/lib/modifiers/config/addPlugin.d.ts +10 -0
  219. package/lib/modifiers/config/addPlugin.d.ts.map +1 -0
  220. package/lib/modifiers/config/editPlugin.d.ts +10 -0
  221. package/lib/modifiers/config/editPlugin.d.ts.map +1 -0
  222. package/lib/modifiers/config/getPluginConfig.d.ts +9 -0
  223. package/lib/modifiers/config/getPluginConfig.d.ts.map +1 -0
  224. package/lib/modifiers/config/hasPlugin.d.ts +10 -0
  225. package/lib/modifiers/config/hasPlugin.d.ts.map +1 -0
  226. package/lib/modifiers/config/index.d.ts +18 -0
  227. package/lib/modifiers/config/index.d.ts.map +1 -0
  228. package/lib/modifiers/config/isDefaultPlugin.d.ts +9 -0
  229. package/lib/modifiers/config/isDefaultPlugin.d.ts.map +1 -0
  230. package/lib/modifiers/config/removePlugin.d.ts +9 -0
  231. package/lib/modifiers/config/removePlugin.d.ts.map +1 -0
  232. package/lib/modifiers/config/togglePlugin.d.ts +10 -0
  233. package/lib/modifiers/config/togglePlugin.d.ts.map +1 -0
  234. package/lib/modifiers/index.d.ts +25 -0
  235. package/lib/modifiers/index.d.ts.map +1 -0
  236. package/lib/modifiers/summary/__tests__/editPartTitle.d.ts +2 -0
  237. package/lib/modifiers/summary/__tests__/editPartTitle.d.ts.map +1 -0
  238. package/lib/modifiers/summary/__tests__/insertArticle.d.ts +2 -0
  239. package/lib/modifiers/summary/__tests__/insertArticle.d.ts.map +1 -0
  240. package/lib/modifiers/summary/__tests__/insertPart.d.ts +2 -0
  241. package/lib/modifiers/summary/__tests__/insertPart.d.ts.map +1 -0
  242. package/lib/modifiers/summary/__tests__/mergeAtLevel.d.ts +2 -0
  243. package/lib/modifiers/summary/__tests__/mergeAtLevel.d.ts.map +1 -0
  244. package/lib/modifiers/summary/__tests__/moveArticle.d.ts +2 -0
  245. package/lib/modifiers/summary/__tests__/moveArticle.d.ts.map +1 -0
  246. package/lib/modifiers/summary/__tests__/moveArticleAfter.d.ts +2 -0
  247. package/lib/modifiers/summary/__tests__/moveArticleAfter.d.ts.map +1 -0
  248. package/lib/modifiers/summary/__tests__/removeArticle.d.ts +2 -0
  249. package/lib/modifiers/summary/__tests__/removeArticle.d.ts.map +1 -0
  250. package/lib/modifiers/summary/editArticleRef.d.ts +11 -0
  251. package/lib/modifiers/summary/editArticleRef.d.ts.map +1 -0
  252. package/lib/modifiers/summary/editArticleTitle.d.ts +11 -0
  253. package/lib/modifiers/summary/editArticleTitle.d.ts.map +1 -0
  254. package/lib/modifiers/summary/editPartTitle.d.ts +11 -0
  255. package/lib/modifiers/summary/editPartTitle.d.ts.map +1 -0
  256. package/lib/modifiers/summary/index.d.ts +24 -0
  257. package/lib/modifiers/summary/index.d.ts.map +1 -0
  258. package/lib/modifiers/summary/indexArticleLevels.d.ts +10 -0
  259. package/lib/modifiers/summary/indexArticleLevels.d.ts.map +1 -0
  260. package/lib/modifiers/summary/indexLevels.d.ts +9 -0
  261. package/lib/modifiers/summary/indexLevels.d.ts.map +1 -0
  262. package/lib/modifiers/summary/indexPartLevels.d.ts +10 -0
  263. package/lib/modifiers/summary/indexPartLevels.d.ts.map +1 -0
  264. package/lib/modifiers/summary/insertArticle.d.ts +12 -0
  265. package/lib/modifiers/summary/insertArticle.d.ts.map +1 -0
  266. package/lib/modifiers/summary/insertPart.d.ts +13 -0
  267. package/lib/modifiers/summary/insertPart.d.ts.map +1 -0
  268. package/lib/modifiers/summary/mergeAtLevel.d.ts +11 -0
  269. package/lib/modifiers/summary/mergeAtLevel.d.ts.map +1 -0
  270. package/lib/modifiers/summary/moveArticle.d.ts +12 -0
  271. package/lib/modifiers/summary/moveArticle.d.ts.map +1 -0
  272. package/lib/modifiers/summary/moveArticleAfter.d.ts +13 -0
  273. package/lib/modifiers/summary/moveArticleAfter.d.ts.map +1 -0
  274. package/lib/modifiers/summary/removeArticle.d.ts +10 -0
  275. package/lib/modifiers/summary/removeArticle.d.ts.map +1 -0
  276. package/lib/modifiers/summary/removePart.d.ts +10 -0
  277. package/lib/modifiers/summary/removePart.d.ts.map +1 -0
  278. package/lib/modifiers/summary/unshiftArticle.d.ts +10 -0
  279. package/lib/modifiers/summary/unshiftArticle.d.ts.map +1 -0
  280. package/lib/output/Generator.d.ts +14 -0
  281. package/lib/output/Generator.d.ts.map +1 -0
  282. package/lib/output/__tests__/ebook.d.ts +2 -0
  283. package/lib/output/__tests__/ebook.d.ts.map +1 -0
  284. package/lib/output/__tests__/json.d.ts +2 -0
  285. package/lib/output/__tests__/json.d.ts.map +1 -0
  286. package/lib/output/__tests__/plugin-hooks.d.ts +2 -0
  287. package/lib/output/__tests__/plugin-hooks.d.ts.map +1 -0
  288. package/lib/output/__tests__/website.d.ts +2 -0
  289. package/lib/output/__tests__/website.d.ts.map +1 -0
  290. package/lib/output/callHook.d.ts +12 -0
  291. package/lib/output/callHook.d.ts.map +1 -0
  292. package/lib/output/callPageHook.d.ts +11 -0
  293. package/lib/output/callPageHook.d.ts.map +1 -0
  294. package/lib/output/createTemplateEngine.d.ts +11 -0
  295. package/lib/output/createTemplateEngine.d.ts.map +1 -0
  296. package/lib/output/ebook/getConvertOptions.d.ts +9 -0
  297. package/lib/output/ebook/getConvertOptions.d.ts.map +1 -0
  298. package/lib/output/ebook/getCoverPath.d.ts +9 -0
  299. package/lib/output/ebook/getCoverPath.d.ts.map +1 -0
  300. package/lib/output/ebook/getPDFTemplate.d.ts +10 -0
  301. package/lib/output/ebook/getPDFTemplate.d.ts.map +1 -0
  302. package/lib/output/ebook/index.d.ts +3 -0
  303. package/lib/output/ebook/index.d.ts.map +1 -0
  304. package/lib/output/ebook/onFinish.d.ts +9 -0
  305. package/lib/output/ebook/onFinish.d.ts.map +1 -0
  306. package/lib/output/ebook/onPage.d.ts +9 -0
  307. package/lib/output/ebook/onPage.d.ts.map +1 -0
  308. package/lib/output/ebook/options.d.ts +4 -0
  309. package/lib/output/ebook/options.d.ts.map +1 -0
  310. package/lib/output/generateAssets.d.ts +10 -0
  311. package/lib/output/generateAssets.d.ts.map +1 -0
  312. package/lib/output/generateBook.d.ts +32 -0
  313. package/lib/output/generateBook.d.ts.map +1 -0
  314. package/lib/output/generatePage.d.ts +10 -0
  315. package/lib/output/generatePage.d.ts.map +1 -0
  316. package/lib/output/generatePage.js +12 -5
  317. package/lib/output/generatePages.d.ts +10 -0
  318. package/lib/output/generatePages.d.ts.map +1 -0
  319. package/lib/output/getModifiers.d.ts +9 -0
  320. package/lib/output/getModifiers.d.ts.map +1 -0
  321. package/lib/output/helper/fileToOutput.d.ts +10 -0
  322. package/lib/output/helper/fileToOutput.d.ts.map +1 -0
  323. package/lib/output/helper/fileToURL.d.ts +15 -0
  324. package/lib/output/helper/fileToURL.d.ts.map +1 -0
  325. package/lib/output/helper/index.d.ts +3 -0
  326. package/lib/output/helper/index.d.ts.map +1 -0
  327. package/lib/output/helper/resolveFileToURL.d.ts +10 -0
  328. package/lib/output/helper/resolveFileToURL.d.ts.map +1 -0
  329. package/lib/output/helper/writeFile.d.ts +11 -0
  330. package/lib/output/helper/writeFile.d.ts.map +1 -0
  331. package/lib/output/index.d.ts +13 -0
  332. package/lib/output/index.d.ts.map +1 -0
  333. package/lib/output/json/index.d.ts +10 -0
  334. package/lib/output/json/index.d.ts.map +1 -0
  335. package/lib/output/json/onFinish.d.ts +8 -0
  336. package/lib/output/json/onFinish.d.ts.map +1 -0
  337. package/lib/output/json/onPage.d.ts +9 -0
  338. package/lib/output/json/onPage.d.ts.map +1 -0
  339. package/lib/output/json/options.d.ts +4 -0
  340. package/lib/output/json/options.d.ts.map +1 -0
  341. package/lib/output/modifiers/__tests__/addHeadingId.d.ts +2 -0
  342. package/lib/output/modifiers/__tests__/addHeadingId.d.ts.map +1 -0
  343. package/lib/output/modifiers/__tests__/annotateText.d.ts +2 -0
  344. package/lib/output/modifiers/__tests__/annotateText.d.ts.map +1 -0
  345. package/lib/output/modifiers/__tests__/fetchRemoteImages.d.ts +2 -0
  346. package/lib/output/modifiers/__tests__/fetchRemoteImages.d.ts.map +1 -0
  347. package/lib/output/modifiers/__tests__/fetchRemoteImages.js +4 -2
  348. package/lib/output/modifiers/__tests__/highlightCode.d.ts +2 -0
  349. package/lib/output/modifiers/__tests__/highlightCode.d.ts.map +1 -0
  350. package/lib/output/modifiers/__tests__/inlinePng.d.ts +2 -0
  351. package/lib/output/modifiers/__tests__/inlinePng.d.ts.map +1 -0
  352. package/lib/output/modifiers/__tests__/inlineSvg.d.ts +2 -0
  353. package/lib/output/modifiers/__tests__/inlineSvg.d.ts.map +1 -0
  354. package/lib/output/modifiers/__tests__/resolveImages.d.ts +2 -0
  355. package/lib/output/modifiers/__tests__/resolveImages.d.ts.map +1 -0
  356. package/lib/output/modifiers/__tests__/resolveLinks.d.ts +2 -0
  357. package/lib/output/modifiers/__tests__/resolveLinks.d.ts.map +1 -0
  358. package/lib/output/modifiers/__tests__/svgToImg.d.ts +2 -0
  359. package/lib/output/modifiers/__tests__/svgToImg.d.ts.map +1 -0
  360. package/lib/output/modifiers/addHeadingId.d.ts +8 -0
  361. package/lib/output/modifiers/addHeadingId.d.ts.map +1 -0
  362. package/lib/output/modifiers/annotateText.d.ts +10 -0
  363. package/lib/output/modifiers/annotateText.d.ts.map +1 -0
  364. package/lib/output/modifiers/editHTMLElement.d.ts +6 -0
  365. package/lib/output/modifiers/editHTMLElement.d.ts.map +1 -0
  366. package/lib/output/modifiers/fetchRemoteImages.d.ts +7 -0
  367. package/lib/output/modifiers/fetchRemoteImages.d.ts.map +1 -0
  368. package/lib/output/modifiers/highlightCode.d.ts +10 -0
  369. package/lib/output/modifiers/highlightCode.d.ts.map +1 -0
  370. package/lib/output/modifiers/index.d.ts +22 -0
  371. package/lib/output/modifiers/index.d.ts.map +1 -0
  372. package/lib/output/modifiers/inlineAssets.d.ts +8 -0
  373. package/lib/output/modifiers/inlineAssets.d.ts.map +1 -0
  374. package/lib/output/modifiers/inlinePng.d.ts +10 -0
  375. package/lib/output/modifiers/inlinePng.d.ts.map +1 -0
  376. package/lib/output/modifiers/inlineSvg.d.ts +10 -0
  377. package/lib/output/modifiers/inlineSvg.d.ts.map +1 -0
  378. package/lib/output/modifiers/modifyHTML.d.ts +11 -0
  379. package/lib/output/modifiers/modifyHTML.d.ts.map +1 -0
  380. package/lib/output/modifiers/resolveImages.d.ts +10 -0
  381. package/lib/output/modifiers/resolveImages.d.ts.map +1 -0
  382. package/lib/output/modifiers/resolveLinks.d.ts +11 -0
  383. package/lib/output/modifiers/resolveLinks.d.ts.map +1 -0
  384. package/lib/output/modifiers/svgToImg.d.ts +9 -0
  385. package/lib/output/modifiers/svgToImg.d.ts.map +1 -0
  386. package/lib/output/page-cache.d.ts +3 -0
  387. package/lib/output/page-cache.d.ts.map +1 -0
  388. package/lib/output/prepareAssets.d.ts +9 -0
  389. package/lib/output/prepareAssets.d.ts.map +1 -0
  390. package/lib/output/preparePages.d.ts +9 -0
  391. package/lib/output/preparePages.d.ts.map +1 -0
  392. package/lib/output/preparePlugins.d.ts +9 -0
  393. package/lib/output/preparePlugins.d.ts.map +1 -0
  394. package/lib/output/testing/createMock.d.ts +13 -0
  395. package/lib/output/testing/createMock.d.ts.map +1 -0
  396. package/lib/output/testing/generateMock.d.ts +24 -0
  397. package/lib/output/testing/generateMock.d.ts.map +1 -0
  398. package/lib/output/website/__tests__/i18n.d.ts +2 -0
  399. package/lib/output/website/__tests__/i18n.d.ts.map +1 -0
  400. package/lib/output/website/copyPluginAssets.d.ts +11 -0
  401. package/lib/output/website/copyPluginAssets.d.ts.map +1 -0
  402. package/lib/output/website/createTemplateEngine.d.ts +12 -0
  403. package/lib/output/website/createTemplateEngine.d.ts.map +1 -0
  404. package/lib/output/website/index.d.ts +18 -0
  405. package/lib/output/website/index.d.ts.map +1 -0
  406. package/lib/output/website/listSearchPaths.d.ts +9 -0
  407. package/lib/output/website/listSearchPaths.d.ts.map +1 -0
  408. package/lib/output/website/onAsset.d.ts +9 -0
  409. package/lib/output/website/onAsset.d.ts.map +1 -0
  410. package/lib/output/website/onFinish.d.ts +9 -0
  411. package/lib/output/website/onFinish.d.ts.map +1 -0
  412. package/lib/output/website/onInit.d.ts +9 -0
  413. package/lib/output/website/onInit.d.ts.map +1 -0
  414. package/lib/output/website/onPage.d.ts +9 -0
  415. package/lib/output/website/onPage.d.ts.map +1 -0
  416. package/lib/output/website/options.d.ts +4 -0
  417. package/lib/output/website/options.d.ts.map +1 -0
  418. package/lib/output/website/prepareI18n.d.ts +9 -0
  419. package/lib/output/website/prepareI18n.d.ts.map +1 -0
  420. package/lib/output/website/prepareResources.d.ts +9 -0
  421. package/lib/output/website/prepareResources.d.ts.map +1 -0
  422. package/lib/output/website/state.d.ts +10 -0
  423. package/lib/output/website/state.d.ts.map +1 -0
  424. package/lib/parse/__tests__/listAssets.d.ts +2 -0
  425. package/lib/parse/__tests__/listAssets.d.ts.map +1 -0
  426. package/lib/parse/__tests__/parseBook.d.ts +2 -0
  427. package/lib/parse/__tests__/parseBook.d.ts.map +1 -0
  428. package/lib/parse/__tests__/parseGlossary.d.ts +2 -0
  429. package/lib/parse/__tests__/parseGlossary.d.ts.map +1 -0
  430. package/lib/parse/__tests__/parseIgnore.d.ts +2 -0
  431. package/lib/parse/__tests__/parseIgnore.d.ts.map +1 -0
  432. package/lib/parse/__tests__/parsePageFromString.d.ts +2 -0
  433. package/lib/parse/__tests__/parsePageFromString.d.ts.map +1 -0
  434. package/lib/parse/__tests__/parseReadme.d.ts +2 -0
  435. package/lib/parse/__tests__/parseReadme.d.ts.map +1 -0
  436. package/lib/parse/__tests__/parseSummary.d.ts +2 -0
  437. package/lib/parse/__tests__/parseSummary.d.ts.map +1 -0
  438. package/lib/parse/findParsableFile.d.ts +10 -0
  439. package/lib/parse/findParsableFile.d.ts.map +1 -0
  440. package/lib/parse/index.d.ts +28 -0
  441. package/lib/parse/index.d.ts.map +1 -0
  442. package/lib/parse/listAssets.d.ts +11 -0
  443. package/lib/parse/listAssets.d.ts.map +1 -0
  444. package/lib/parse/lookupStructureFile.d.ts +12 -0
  445. package/lib/parse/lookupStructureFile.d.ts.map +1 -0
  446. package/lib/parse/parseBook.d.ts +9 -0
  447. package/lib/parse/parseBook.d.ts.map +1 -0
  448. package/lib/parse/parseConfig.d.ts +9 -0
  449. package/lib/parse/parseConfig.d.ts.map +1 -0
  450. package/lib/parse/parseConfig.js +1 -1
  451. package/lib/parse/parseGlossary.d.ts +9 -0
  452. package/lib/parse/parseGlossary.d.ts.map +1 -0
  453. package/lib/parse/parseIgnore.d.ts +9 -0
  454. package/lib/parse/parseIgnore.d.ts.map +1 -0
  455. package/lib/parse/parseLanguages.d.ts +9 -0
  456. package/lib/parse/parseLanguages.d.ts.map +1 -0
  457. package/lib/parse/parsePage.d.ts +10 -0
  458. package/lib/parse/parsePage.d.ts.map +1 -0
  459. package/lib/parse/parsePageFromString.d.ts +10 -0
  460. package/lib/parse/parsePageFromString.d.ts.map +1 -0
  461. package/lib/parse/parsePagesList.d.ts +9 -0
  462. package/lib/parse/parsePagesList.d.ts.map +1 -0
  463. package/lib/parse/parseReadme.d.ts +9 -0
  464. package/lib/parse/parseReadme.d.ts.map +1 -0
  465. package/lib/parse/parseStructureFile.d.ts +11 -0
  466. package/lib/parse/parseStructureFile.d.ts.map +1 -0
  467. package/lib/parse/parseStructureFile.js +7 -5
  468. package/lib/parse/parseSummary.d.ts +10 -0
  469. package/lib/parse/parseSummary.d.ts.map +1 -0
  470. package/lib/parse/validateConfig.d.ts +10 -0
  471. package/lib/parse/validateConfig.d.ts.map +1 -0
  472. package/lib/parse/walkSummary.d.ts +10 -0
  473. package/lib/parse/walkSummary.d.ts.map +1 -0
  474. package/lib/parsers.d.ts +31 -0
  475. package/lib/parsers.d.ts.map +1 -0
  476. package/lib/parsers.js +5 -5
  477. package/lib/plugins/PluginResolver.d.ts +26 -0
  478. package/lib/plugins/PluginResolver.d.ts.map +1 -0
  479. package/lib/plugins/__tests__/listDependencies.d.ts +2 -0
  480. package/lib/plugins/__tests__/listDependencies.d.ts.map +1 -0
  481. package/lib/plugins/__tests__/sortDependencies.d.ts +2 -0
  482. package/lib/plugins/__tests__/sortDependencies.d.ts.map +1 -0
  483. package/lib/plugins/__tests__/validatePlugin.d.ts +2 -0
  484. package/lib/plugins/__tests__/validatePlugin.d.ts.map +1 -0
  485. package/lib/plugins/index.d.ts +14 -0
  486. package/lib/plugins/index.d.ts.map +1 -0
  487. package/lib/plugins/listBlocks.d.ts +9 -0
  488. package/lib/plugins/listBlocks.d.ts.map +1 -0
  489. package/lib/plugins/listDependencies.d.ts +10 -0
  490. package/lib/plugins/listDependencies.d.ts.map +1 -0
  491. package/lib/plugins/listDepsForBook.d.ts +11 -0
  492. package/lib/plugins/listDepsForBook.d.ts.map +1 -0
  493. package/lib/plugins/listFilters.d.ts +9 -0
  494. package/lib/plugins/listFilters.d.ts.map +1 -0
  495. package/lib/plugins/listResources.d.ts +9 -0
  496. package/lib/plugins/listResources.d.ts.map +1 -0
  497. package/lib/plugins/loadForBook.d.ts +9 -0
  498. package/lib/plugins/loadForBook.d.ts.map +1 -0
  499. package/lib/plugins/loadPlugin.d.ts +11 -0
  500. package/lib/plugins/loadPlugin.d.ts.map +1 -0
  501. package/lib/plugins/package-name-util.d.ts +13 -0
  502. package/lib/plugins/package-name-util.d.ts.map +1 -0
  503. package/lib/plugins/sortDependencies.d.ts +10 -0
  504. package/lib/plugins/sortDependencies.d.ts.map +1 -0
  505. package/lib/plugins/toNames.d.ts +9 -0
  506. package/lib/plugins/toNames.d.ts.map +1 -0
  507. package/lib/plugins/validateConfig.d.ts +11 -0
  508. package/lib/plugins/validateConfig.d.ts.map +1 -0
  509. package/lib/plugins/validatePlugin.d.ts +9 -0
  510. package/lib/plugins/validatePlugin.d.ts.map +1 -0
  511. package/lib/templating/__tests__/conrefsLoader.d.ts +2 -0
  512. package/lib/templating/__tests__/conrefsLoader.d.ts.map +1 -0
  513. package/lib/templating/__tests__/postRender.d.ts +2 -0
  514. package/lib/templating/__tests__/postRender.d.ts.map +1 -0
  515. package/lib/templating/__tests__/replaceShortcuts.d.ts +2 -0
  516. package/lib/templating/__tests__/replaceShortcuts.d.ts.map +1 -0
  517. package/lib/templating/conrefsLoader.d.ts +14 -0
  518. package/lib/templating/conrefsLoader.d.ts.map +1 -0
  519. package/lib/templating/conrefsLoader.js +3 -3
  520. package/lib/templating/index.d.ts +14 -0
  521. package/lib/templating/index.d.ts.map +1 -0
  522. package/lib/templating/listShortcuts.d.ts +11 -0
  523. package/lib/templating/listShortcuts.d.ts.map +1 -0
  524. package/lib/templating/postRender.d.ts +12 -0
  525. package/lib/templating/postRender.d.ts.map +1 -0
  526. package/lib/templating/render.d.ts +12 -0
  527. package/lib/templating/render.d.ts.map +1 -0
  528. package/lib/templating/renderFile.d.ts +11 -0
  529. package/lib/templating/renderFile.d.ts.map +1 -0
  530. package/lib/templating/replaceShortcuts.d.ts +11 -0
  531. package/lib/templating/replaceShortcuts.d.ts.map +1 -0
  532. package/lib/templating/themesLoader.d.ts +4 -0
  533. package/lib/templating/themesLoader.d.ts.map +1 -0
  534. package/lib/utils/__tests__/git.d.ts +2 -0
  535. package/lib/utils/__tests__/git.d.ts.map +1 -0
  536. package/lib/utils/__tests__/location.d.ts +2 -0
  537. package/lib/utils/__tests__/location.d.ts.map +1 -0
  538. package/lib/utils/__tests__/path.d.ts +2 -0
  539. package/lib/utils/__tests__/path.d.ts.map +1 -0
  540. package/lib/utils/command.d.ts +25 -0
  541. package/lib/utils/command.d.ts.map +1 -0
  542. package/lib/utils/error.d.ts +16 -0
  543. package/lib/utils/error.d.ts.map +1 -0
  544. package/lib/utils/fs.d.ts +58 -0
  545. package/lib/utils/fs.d.ts.map +1 -0
  546. package/lib/utils/genKey.d.ts +3 -0
  547. package/lib/utils/genKey.d.ts.map +1 -0
  548. package/lib/utils/git.d.ts +11 -0
  549. package/lib/utils/git.d.ts.map +1 -0
  550. package/lib/utils/images.d.ts +6 -0
  551. package/lib/utils/images.d.ts.map +1 -0
  552. package/lib/utils/location.d.ts +62 -0
  553. package/lib/utils/location.d.ts.map +1 -0
  554. package/lib/utils/logger.d.ts +7 -0
  555. package/lib/utils/logger.d.ts.map +1 -0
  556. package/lib/utils/mergeDefaults.d.ts +9 -0
  557. package/lib/utils/mergeDefaults.d.ts.map +1 -0
  558. package/lib/utils/path.d.ts +14 -0
  559. package/lib/utils/path.d.ts.map +1 -0
  560. package/lib/utils/promise.d.ts +52 -0
  561. package/lib/utils/promise.d.ts.map +1 -0
  562. package/lib/utils/reducedObject.d.ts +9 -0
  563. package/lib/utils/reducedObject.d.ts.map +1 -0
  564. package/lib/utils/timing.d.ts +20 -0
  565. package/lib/utils/timing.d.ts.map +1 -0
  566. package/package.json +10 -9
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=summary.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/summary.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=summaryArticle.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summaryArticle.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/summaryArticle.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=summaryPart.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summaryPart.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/summaryPart.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=templateBlock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"templateBlock.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/templateBlock.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=templateEngine.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"templateEngine.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/templateEngine.ts"],"names":[],"mappings":""}
@@ -0,0 +1,158 @@
1
+ import Immutable from "immutable";
2
+ import FS from "./fs";
3
+ import Config from "./config";
4
+ import Readme from "./readme";
5
+ import Summary from "./summary";
6
+ import Glossary from "./glossary";
7
+ import Languages from "./languages";
8
+ import Ignore from "./ignore";
9
+ declare const Book_base: Immutable.Record.Class;
10
+ declare class Book extends Book_base {
11
+ getLogger(): any;
12
+ getFS(): FS;
13
+ getIgnore(): Ignore;
14
+ getConfig(): Config;
15
+ getReadme(): Readme;
16
+ getSummary(): Summary;
17
+ getGlossary(): Glossary;
18
+ getLanguages(): Languages;
19
+ getBooks(): any;
20
+ getLanguage(): any;
21
+ /**
22
+ Return FS instance to access the content
23
+
24
+ @return {FS}
25
+ */
26
+ getContentFS(): FS;
27
+ /**
28
+ Return root of the book
29
+
30
+ @return {string}
31
+ */
32
+ getRoot(): string;
33
+ /**
34
+ Return root for content of the book
35
+
36
+ @return {string}
37
+ */
38
+ getContentRoot(): string;
39
+ /**
40
+ Check if a file is ignore (should not being parsed, etc)
41
+
42
+ @param {string} ref
43
+ @return {Page|undefined}
44
+ */
45
+ isFileIgnored(filename: any): boolean;
46
+ /**
47
+ Check if a content file is ignore (should not being parsed, etc)
48
+
49
+ @param {string} ref
50
+ @return {Page|undefined}
51
+ */
52
+ isContentFileIgnored(filename: any): boolean;
53
+ /**
54
+ Is this book the parent of language's books
55
+
56
+ @return {boolean}
57
+ */
58
+ isMultilingual(): boolean;
59
+ /**
60
+ Return true if book is associated to a language
61
+
62
+ @return {boolean}
63
+ */
64
+ isLanguageBook(): boolean;
65
+ /**
66
+ Return a languages book
67
+
68
+ @param {string} language
69
+ @return {Book}
70
+ */
71
+ getLanguageBook(language: any): any;
72
+ /**
73
+ Add a new language book
74
+
75
+ @param {string} language
76
+ @param {Book} book
77
+ @return {Book}
78
+ */
79
+ addLanguageBook(language: any, book: any): Immutable.Map<string, any>;
80
+ /**
81
+ Set the summary for this book
82
+
83
+ @param {Summary}
84
+ @return {Book}
85
+ */
86
+ setSummary(summary: any): Immutable.Map<string, any>;
87
+ /**
88
+ Set the readme for this book
89
+
90
+ @param {Readme}
91
+ @return {Book}
92
+ */
93
+ setReadme(readme: any): Immutable.Map<string, any>;
94
+ /**
95
+ Set the configuration for this book
96
+
97
+ @param {Config}
98
+ @return {Book}
99
+ */
100
+ setConfig(config: any): Immutable.Map<string, any>;
101
+ /**
102
+ Set the ignore instance for this book
103
+
104
+ @param {Ignore}
105
+ @return {Book}
106
+ */
107
+ setIgnore(ignore: any): Immutable.Map<string, any>;
108
+ /**
109
+ Change log level
110
+
111
+ @param {string} level
112
+ @return {Book}
113
+ */
114
+ setLogLevel(level: any): this;
115
+ /**
116
+ Create a book using a filesystem
117
+
118
+ @param {FS} fs
119
+ @return {Book}
120
+ */
121
+ static createForFS(fs: any): Book;
122
+ /**
123
+ Infers the default extension for files
124
+ @return {string}
125
+ */
126
+ getDefaultExt(): any;
127
+ /**
128
+ Infer the default path for a Readme.
129
+ @param {boolean} [absolute=false] False for a path relative to
130
+ this book's content root
131
+ @return {string}
132
+ */
133
+ getDefaultReadmePath(absolute: any): string;
134
+ /**
135
+ Infer the default path for a Summary.
136
+ @param {boolean} [absolute=false] False for a path relative to
137
+ this book's content root
138
+ @return {string}
139
+ */
140
+ getDefaultSummaryPath(absolute: any): string;
141
+ /**
142
+ Infer the default path for a Glossary.
143
+ @param {boolean} [absolute=false] False for a path relative to
144
+ this book's content root
145
+ @return {string}
146
+ */
147
+ getDefaultGlossaryPath(absolute: any): string;
148
+ /**
149
+ Create a language book from a parent
150
+
151
+ @param {Book} parent
152
+ @param {string} language
153
+ @return {Book}
154
+ */
155
+ static createFromParent(parent: any, language: any): Book;
156
+ }
157
+ export default Book;
158
+ //# sourceMappingURL=book.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"book.d.ts","sourceRoot":"","sources":["../../src/models/book.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,MAAM,MAAM,CAAC;AACtB,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,MAAM,MAAM,UAAU,CAAC;;AAE9B,cAAM,IAAK,SAAQ,SAwBjB;IACE,SAAS;IAIT,KAAK,IAAI,EAAE;IAIX,SAAS,IAAI,MAAM;IAInB,SAAS,IAAI,MAAM;IAInB,SAAS,IAAI,MAAM;IAInB,UAAU,IAAI,OAAO;IAIrB,WAAW,IAAI,QAAQ;IAIvB,YAAY,IAAI,SAAS;IAIzB,QAAQ;IAIR,WAAW;IAIX;;;;OAIG;IACH,YAAY,IAAI,EAAE;IAYlB;;;;OAIG;IACH,OAAO;IAKP;;;;OAIG;IACH,cAAc;IAKd;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,KAAA;IAYtB;;;;;OAKG;IACH,oBAAoB,CAAC,QAAQ,KAAA;IAW7B;;;;OAIG;IACH,cAAc;IAId;;;;OAIG;IACH,cAAc;IAId;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,KAAA;IAKxB;;;;;;OAMG;IACH,eAAe,CAAC,QAAQ,KAAA,EAAE,IAAI,KAAA;IAO9B;;;;;OAKG;IACH,UAAU,CAAC,OAAO,KAAA;IAIlB;;;;;OAKG;IACH,SAAS,CAAC,MAAM,KAAA;IAIhB;;;;;OAKG;IACH,SAAS,CAAC,MAAM,KAAA;IAIhB;;;;;OAKG;IACH,SAAS,CAAC,MAAM,KAAA;IAIhB;;;;;OAKG;IACH,WAAW,CAAC,KAAK,KAAA;IAKjB;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,KAAA;IAMrB;;;OAGG;IACH,aAAa;IAsBb;;;;;OAKG;IACH,oBAAoB,CAAC,QAAQ,KAAA;IAS7B;;;;;OAKG;IACH,qBAAqB,CAAC,QAAQ,KAAA;IAS9B;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,KAAA;IAS/B;;;;;;OAMG;IAEH,MAAM,CAAC,gBAAgB,CAAC,MAAM,KAAA,EAAE,QAAQ,KAAA;CAkB3C;AAED,eAAe,IAAI,CAAC"}
@@ -0,0 +1,82 @@
1
+ import Immutable from "immutable";
2
+ import PluginDependency from "./pluginDependency";
3
+ declare const Config_base: Immutable.Record.Class;
4
+ declare class Config extends Config_base {
5
+ getFile(): any;
6
+ getValues(): any;
7
+ /**
8
+ * Return minimum version of configuration,
9
+ * Basically it returns the current config minus the default one
10
+ * @return {Map}
11
+ */
12
+ toReducedVersion(): any;
13
+ /**
14
+ * Render config as text
15
+ * @return {Promise<String>}
16
+ */
17
+ toText(): string;
18
+ /**
19
+ * Change the file for the configuration
20
+ * @param {File} file
21
+ * @return {Config}
22
+ */
23
+ setFile(file: any): Immutable.Map<string, any>;
24
+ /**
25
+ * Return a configuration value by its key path
26
+ */
27
+ getValue(keyPath: string | string[], def?: any): any;
28
+ /**
29
+ * Update a configuration value
30
+ * @return {Config}
31
+ */
32
+ setValue(keyPath: string | string[], value: any): Config;
33
+ /**
34
+ * Return a list of plugin dependencies
35
+ * @return {List<PluginDependency>}
36
+ */
37
+ getPluginDependencies(): Immutable.Iterable<number, PluginDependency>;
38
+ /**
39
+ * Return a plugin dependency by its name
40
+ * @param {string} name
41
+ * @return {PluginDependency}
42
+ */
43
+ getPluginDependency(name: string): PluginDependency;
44
+ /**
45
+ * Update the list of plugins dependencies
46
+ * @param {List<PluginDependency>}
47
+ * @return {Config}
48
+ */
49
+ setPluginDependencies(deps: any): Config;
50
+ /**
51
+ * Update values for an existing configuration
52
+ * @param {Object} values
53
+ * @returns {Config}
54
+ */
55
+ updateValues(values: any): Immutable.Map<string, any>;
56
+ /**
57
+ * Update values for an existing configuration
58
+ * @param {Config} config
59
+ * @param {Object} values
60
+ * @returns {Config}
61
+ */
62
+ mergeValues(values: any): Immutable.Map<string, any>;
63
+ /**
64
+ * Create a new config for a file
65
+ * @param {File} file
66
+ * @param {Object} values
67
+ * @returns {Config}
68
+ */
69
+ static create(file: any, values: any): Config;
70
+ /**
71
+ * Create a new config
72
+ * @param {Object} values
73
+ * @returns {Config}
74
+ */
75
+ static createWithValues(values: any): Config;
76
+ /**
77
+ * Convert a keyPath to an array of keys
78
+ */
79
+ static keyToKeyPath(keyPath: string | string[]): string[];
80
+ }
81
+ export default Config;
82
+ //# sourceMappingURL=config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/models/config.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;;AAIlD,cAAM,MAAO,SAAQ,WAMpB;IACG,OAAO;IAIP,SAAS;IAIT;;;;OAIG;IACH,gBAAgB;IAIhB;;;OAGG;IACH,MAAM;IAIN;;;;OAIG;IACH,OAAO,CAAC,IAAI,KAAA;IAIZ;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,CAAC,EAAE,GAAG;IAW9C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,MAAM;IAWxD;;;OAGG;IACH,qBAAqB;IASrB;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM;IAQhC;;;;OAIG;IACH,qBAAqB,CAAC,IAAI,KAAA;IAM1B;;;;OAIG;IACH,YAAY,CAAC,MAAM,KAAA;IAMnB;;;;;OAKG;IACH,WAAW,CAAC,MAAM,KAAA;IASlB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,KAAA,EAAE,MAAM,KAAA;IAO1B;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,KAAA;IAM9B;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;CAMjD;AAED,eAAe,MAAM,CAAC"}
@@ -0,0 +1,54 @@
1
+ /// <reference types="node" />
2
+ import fs from "fs";
3
+ import Immutable from "immutable";
4
+ import Parser from "./parser";
5
+ declare const File_base: Immutable.Record.Class;
6
+ declare class File extends File_base {
7
+ getPath(): string;
8
+ getMTime(): Date;
9
+ /**
10
+ Does the file exists / is set
11
+
12
+ @return {boolean}
13
+ */
14
+ exists(): boolean;
15
+ /**
16
+ Return type of file ('markdown' or 'asciidoc')
17
+
18
+ @return {string}
19
+ */
20
+ getType(): string;
21
+ /**
22
+ Return extension of this file (lowercased)
23
+
24
+ @return {string}
25
+ */
26
+ getExtension(): string;
27
+ /**
28
+ Return parser for this file
29
+
30
+ @return {Parsers}
31
+ */
32
+ getParser(): Parser;
33
+ /**
34
+ Return basedirectory of this file
35
+ @return {string}
36
+ */
37
+ getBaseDirectory(): string;
38
+ /**
39
+ Create a file from stats informations
40
+
41
+ @param {string} filepath
42
+ @param {Object|fs.Stats} stat
43
+ @return {File}
44
+ */
45
+ static createFromStat(filepath: string, stat: fs.Stats): File;
46
+ /**
47
+ Create a file with only a path
48
+ @param {string} filepath
49
+ @return {File}
50
+ */
51
+ static createWithFilepath(filepath: string): File;
52
+ }
53
+ export default File;
54
+ //# sourceMappingURL=file.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/models/file.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,MAAM,MAAM,UAAU,CAAC;;AAE9B,cAAM,IAAK,SAAQ,SAMjB;IACE,OAAO,IAAI,MAAM;IAIjB,QAAQ,IAAI,IAAI;IAIhB;;;;OAIG;IAEH,MAAM,IAAI,OAAO;IAIjB;;;;OAIG;IACH,OAAO,IAAI,MAAM;IASjB;;;;OAIG;IACH,YAAY,IAAI,MAAM;IAItB;;;;OAIG;IACH,SAAS,IAAI,MAAM;IAInB;;;OAGG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI;IAO7D;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAKpD;AAED,eAAe,IAAI,CAAC"}
@@ -10,7 +10,7 @@ class File extends immutable_1.default.Record({
10
10
  // Path of the file, relative to the FS
11
11
  path: String(),
12
12
  // Time when file data last modified
13
- mtime: Date(),
13
+ mtime: Date()
14
14
  }) {
15
15
  getPath() {
16
16
  return this.get("path");
@@ -51,11 +51,18 @@ class File extends immutable_1.default.Record({
51
51
  /**
52
52
  Return parser for this file
53
53
 
54
- @return {Parser}
54
+ @return {Parsers}
55
55
  */
56
56
  getParser() {
57
57
  return parsers_1.default.getByExt(this.getExtension());
58
58
  }
59
+ /**
60
+ Return basedirectory of this file
61
+ @return {string}
62
+ */
63
+ getBaseDirectory() {
64
+ return path_1.default.dirname(this.getPath());
65
+ }
59
66
  /**
60
67
  Create a file from stats informations
61
68
 
@@ -66,7 +73,7 @@ class File extends immutable_1.default.Record({
66
73
  static createFromStat(filepath, stat) {
67
74
  return new File({
68
75
  path: filepath,
69
- mtime: stat.mtime,
76
+ mtime: stat.mtime
70
77
  });
71
78
  }
72
79
  /**
@@ -76,7 +83,7 @@ class File extends immutable_1.default.Record({
76
83
  */
77
84
  static createWithFilepath(filepath) {
78
85
  return new File({
79
- path: filepath,
86
+ path: filepath
80
87
  });
81
88
  }
82
89
  }
@@ -0,0 +1,116 @@
1
+ /// <reference types="node" />
2
+ import Immutable from "immutable";
3
+ import File from "./file";
4
+ import Promise from "../utils/promise";
5
+ declare const FS_base: Immutable.Record.Class;
6
+ declare class FS extends FS_base {
7
+ /**
8
+ Return path to the root
9
+
10
+ @return {string}
11
+ */
12
+ getRoot(): string;
13
+ /**
14
+ Verify that a file is in the fs scope
15
+
16
+ @param {string} filename
17
+ @return {boolean}
18
+ */
19
+ isInScope(filename: string): boolean;
20
+ /**
21
+ Resolve a file in this FS
22
+ @return {string}
23
+ */
24
+ resolve(...args: string[]): string;
25
+ /**
26
+ Check if a file exists, run a Promise(true) if that's the case, Promise(false) otherwise
27
+
28
+ @param {string} filename
29
+ @return {Promise<Boolean>}
30
+ */
31
+ exists(filename: string): Promise<boolean>;
32
+ /**
33
+ Read a file and returns a promise with the content as a buffer
34
+
35
+ @param {string} filename
36
+ @return {Promise<Buffer>}
37
+ */
38
+ read(filename: string): Promise<Buffer>;
39
+ /**
40
+ Read a file as a string (utf-8)
41
+ @return {Promise<String>}
42
+ */
43
+ readAsString(filename: string, encoding?: string): Promise<string>;
44
+ /**
45
+ Read file as a stream
46
+
47
+ @param {string} filename
48
+ @return {Promise<Stream>}
49
+ */
50
+ readAsStream(filename: string): any;
51
+ /**
52
+ Read stat infos about a file
53
+
54
+ @param {string} filename
55
+ @return {Promise<File>}
56
+ */
57
+ statFile(filename: string): Promise<File>;
58
+ /**
59
+ List files/directories in a directory.
60
+ Directories ends with '/'
61
+
62
+ @param {string} dirname
63
+ @return {Promise<List<String>>}
64
+ */
65
+ readDir(dirname: string): any;
66
+ /**
67
+ List only files in a diretcory
68
+ Directories ends with '/'
69
+
70
+ @param {string} dirname
71
+ @return {Promise<List<String>>}
72
+ */
73
+ listFiles(dirname: string): any;
74
+ /**
75
+ List all files in a directory
76
+
77
+ @param {string} dirName
78
+ @param {Function(dirName)} filterFn: call it for each file/directory to test if it should stop iterating
79
+ @return {Promise<List<String>>}
80
+ */
81
+ listAllFiles(dirName: string, filterFn: (arg0: string) => boolean): any;
82
+ /**
83
+ Find a file in a folder (case insensitive)
84
+ Return the found filename
85
+
86
+ @param {string} dirname
87
+ @param {string} filename
88
+ @return {Promise<String>}
89
+ */
90
+ findFile(dirname: string, filename: string): any;
91
+ /**
92
+ Load a JSON file
93
+ By default, fs only supports JSON
94
+
95
+ @param {string} filename
96
+ @return {Promise<Object>}
97
+ */
98
+ loadAsObject(filename: string): any;
99
+ /**
100
+ Create a FS instance
101
+
102
+ @param {Object} def
103
+ @return {FS}
104
+ */
105
+ static create(def: any): FS;
106
+ /**
107
+ Create a new FS instance with a reduced scope
108
+
109
+ @param {FS} fs
110
+ @param {string} scope
111
+ @return {FS}
112
+ */
113
+ static reduceScope(fs: FS, scope: string): FS;
114
+ }
115
+ export default FS;
116
+ //# sourceMappingURL=fs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../src/models/fs.ts"],"names":[],"mappings":";AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,kBAAkB,CAAC;;AAKvC,cAAM,EAAG,SAAQ,OAUf;IACE;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAOpC;;;OAGG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM;IAelC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C;;;;;OAKG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAWvC;;;OAGG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM;IAiB7B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAezC;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM;IAevB;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM;IAMzB;;;;;;OAMG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO;IA4BjE;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAQ1C;;;;;;OAMG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM;IAwB7B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,KAAA;IAIjB;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE;CAGhD;AAQD,eAAe,EAAE,CAAC"}
@@ -0,0 +1,42 @@
1
+ import Immutable from "immutable";
2
+ import File from "./file";
3
+ import GlossaryEntry from "./glossaryEntry";
4
+ declare const Glossary_base: Immutable.Record.Class;
5
+ declare class Glossary extends Glossary_base {
6
+ getFile(): any;
7
+ getEntries(): any;
8
+ /**
9
+ Return an entry by its name
10
+ @param {string} name
11
+ @return {GlossaryEntry}
12
+ */
13
+ getEntry(name: string): any;
14
+ /**
15
+ Render glossary as text
16
+
17
+ @return {Promise<String>}
18
+ */
19
+ toText(parser: any): any;
20
+ /**
21
+ Add/Replace an entry to a glossary
22
+
23
+ @param {Glossary} glossary
24
+ @param {GlossaryEntry} entry
25
+ @return {Glossary}
26
+ */
27
+ static addEntry(glossary: Glossary, entry: GlossaryEntry): Glossary;
28
+ /**
29
+ Add/Replace an entry to a glossary by name/description
30
+ */
31
+ static addEntryByName(glossary: Glossary, name: string, description: string): Glossary;
32
+ /**
33
+ Create a glossary from a list of entries
34
+
35
+ @param file
36
+ @param {Array|List} entries
37
+ @return {Glossary}
38
+ */
39
+ static createFromEntries(file: File, entries: any[]): Glossary;
40
+ }
41
+ export default Glossary;
42
+ //# sourceMappingURL=glossary.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../src/models/glossary.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,aAAa,MAAM,iBAAiB,CAAC;;AAG5C,cAAM,QAAS,SAAQ,aAGrB;IACE,OAAO;IAIP,UAAU;IAIV;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM;IAOrB;;;;OAIG;IACH,MAAM,CAAC,MAAM,KAAA;IAcb;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,GAAG,QAAQ;IAQnE;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,QAAQ;IAQtF;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE;CActD;AAED,eAAe,QAAQ,CAAC"}
@@ -10,7 +10,7 @@ const glossaryEntry_1 = __importDefault(require("./glossaryEntry"));
10
10
  const parsers_1 = __importDefault(require("../parsers"));
11
11
  class Glossary extends immutable_1.default.Record({
12
12
  file: new file_1.default(),
13
- entries: immutable_1.default.OrderedMap(),
13
+ entries: immutable_1.default.OrderedMap()
14
14
  }) {
15
15
  getFile() {
16
16
  return this.get("file");
@@ -39,7 +39,7 @@ class Glossary extends immutable_1.default.Record({
39
39
  parser = parser ? parsers_1.default.getByExt(parser) : file.getParser();
40
40
  if (!parser) {
41
41
  throw error_1.default.FileNotParsableError({
42
- filename: file.getPath(),
42
+ filename: file.getPath()
43
43
  });
44
44
  }
45
45
  return parser.renderGlossary(entries.toJS());
@@ -63,7 +63,7 @@ class Glossary extends immutable_1.default.Record({
63
63
  static addEntryByName(glossary, name, description) {
64
64
  const entry = new glossaryEntry_1.default({
65
65
  name: name,
66
- description: description,
66
+ description: description
67
67
  });
68
68
  return Glossary.addEntry(glossary, entry);
69
69
  }
@@ -83,7 +83,7 @@ class Glossary extends immutable_1.default.Record({
83
83
  });
84
84
  return new Glossary({
85
85
  file: file,
86
- entries: immutable_1.default.OrderedMap(entries),
86
+ entries: immutable_1.default.OrderedMap(entries)
87
87
  });
88
88
  }
89
89
  }
@@ -0,0 +1,16 @@
1
+ import Immutable from "immutable";
2
+ declare const GlossaryEntry_base: Immutable.Record.Class;
3
+ declare class GlossaryEntry extends GlossaryEntry_base {
4
+ getName(): string;
5
+ getDescription(): string;
6
+ /**
7
+ Get identifier for this entry
8
+ */
9
+ getID(): string;
10
+ /**
11
+ Normalize a glossary entry name into a unique id
12
+ */
13
+ static nameToID(name: string): string;
14
+ }
15
+ export default GlossaryEntry;
16
+ //# sourceMappingURL=glossaryEntry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"glossaryEntry.d.ts","sourceRoot":"","sources":["../../src/models/glossaryEntry.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;;AAOlC,cAAM,aAAc,SAAQ,kBAG1B;IACE,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;IAIxB;;OAEG;IACH,KAAK,IAAI,MAAM;IAIf;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAGxC;AAED,eAAe,aAAa,CAAC"}
@@ -0,0 +1,4 @@
1
+ export declare const hash: (o: any) => any;
2
+ declare function hashString(string: any): number;
3
+ export { hashString };
4
+ //# sourceMappingURL=hash.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/models/hash.ts"],"names":[],"mappings":"AA8BA,eAAO,MAAM,IAAI,iBAgChB,CAAC;AAkCF,iBAAS,UAAU,CAAC,MAAM,KAAA,UAYzB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
@@ -0,0 +1,20 @@
1
+ import Immutable from "immutable";
2
+ declare const Ignore_base: Immutable.Record.Class;
3
+ declare class Ignore extends Ignore_base {
4
+ getIgnore(): any;
5
+ /**
6
+ Test if a file is ignored by these rules
7
+
8
+ @return {boolean}
9
+ * @param filename
10
+ */
11
+ isFileIgnored(filename: string): boolean;
12
+ /**
13
+ Add rules
14
+ @param {string}
15
+ @return {Ignore}
16
+ */
17
+ add(rule: string | import("ignore").Ignore): Immutable.Map<string, any>;
18
+ }
19
+ export default Ignore;
20
+ //# sourceMappingURL=ignore.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ignore.d.ts","sourceRoot":"","sources":["../../src/models/ignore.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;;AAMlC,cAAM,MAAO,SAAQ,WAKpB;IACG,SAAS;IAIT;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM;IAK9B;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,QAAQ,EAAE,MAAM;CAS7C;AAED,eAAe,MAAM,CAAC"}
@@ -0,0 +1,9 @@
1
+ import Immutable from "immutable";
2
+ declare const Language_base: Immutable.Record.Class;
3
+ declare class Language extends Language_base {
4
+ getTitle(): string;
5
+ getPath(): string;
6
+ getID(): string;
7
+ }
8
+ export default Language;
9
+ //# sourceMappingURL=language.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"language.d.ts","sourceRoot":"","sources":["../../src/models/language.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;;AAElC,cAAM,QAAS,SAAQ,aAGrB;IACE,QAAQ,IAAI,MAAM;IAIlB,OAAO,IAAI,MAAM;IAIjB,KAAK,IAAI,MAAM;CAGlB;AAED,eAAe,QAAQ,CAAC"}