honkit 4.0.8 → 5.0.0

package/lib/models/languages.d.ts

@@ -0,0 +1,35 @@
+import Immutable from "immutable";
+import File from "./file";
+import Language from "./language";
+declare const Languages_base: Immutable.Record.Class;
+declare class Languages extends Languages_base {
+    getFile(): any;
+    getList(): any;
+    /**
+     Get default languages
+
+     @return {Language}
+     */
+    getDefaultLanguage(): Language;
+    /**
+     Get a language by its ID
+
+     @param {string} lang
+     @return {Language}
+     */
+    getLanguage(lang: string): Language;
+    /**
+     Return count of langs
+
+     @return {number}
+     */
+    getCount(): any;
+    /**
+     Create a languages list from a JS object
+
+     @return {Language}
+     */
+    static createFromList(file: File, langs: Languages): Languages;
+}
+export default Languages;
+//# sourceMappingURL=languages.d.ts.map

package/lib/models/languages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../src/models/languages.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,QAAQ,MAAM,YAAY,CAAC;;AAElC,cAAM,SAAU,SAAQ,cAGtB;IACE,OAAO;IAIP,OAAO;IAIP;;;;OAIG;IACH,kBAAkB,IAAI,QAAQ;IAI9B;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ;IAInC;;;;OAIG;IACH,QAAQ;IAIR;;;;OAIG;IAEH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,GAAG,SAAS;CAgBjE;AAED,eAAe,SAAS,CAAC"}

package/lib/models/output.d.ts

@@ -0,0 +1,53 @@
+import Immutable from "immutable";
+import Book from "./book";
+import Page from "./page";
+import type GeneratorState from "../output/website/state";
+type Assets = Immutable.List<string>;
+type State = GeneratorState;
+type Options = Immutable.Map<any, any>;
+declare const Output_base: Immutable.Record.Class;
+declare class Output extends Output_base {
+    getBook(): Book;
+    getGenerator(): string;
+    getPlugins(): Immutable.OrderedMap<string, Plugin>;
+    getPages(): Immutable.OrderedMap<string, Page>;
+    getOptions(): Options;
+    getAssets(): Assets;
+    getState(): State;
+    /**
+     Return a page byt its file path
+
+     @param {string} filePath
+     @return {Page|undefined}
+     */
+    getPage(filePath: string): Page | undefined;
+    reloadPage(contentRootDir: string, filePath: string): Immutable.Map<string, any>;
+    /**
+     Get root folder for output
+
+     @return {string}
+     */
+    getRoot(): string;
+    /**
+     Update state of output
+
+     @param {Map} newState
+     @return {Output}
+     */
+    setState(newState: State): Output;
+    /**
+     Update options
+
+     @param {Map} newOptions
+     @return {Output}
+     */
+    setOptions(newOptions: Options): Output;
+    /**
+     Return logegr for this output (same as book)
+
+     @return {Logger}
+     */
+    getLogger(): any;
+}
+export default Output;
+//# sourceMappingURL=output.d.ts.map

package/lib/models/output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/models/output.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAE1D,KAAK,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACrC,KAAK,KAAK,GAAG,cAAc,CAAC;AAC5B,KAAK,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;;AACvC,cAAM,MAAO,SAAQ,WAwBnB;IACE,OAAO,IAAI,IAAI;IAIf,YAAY,IAAI,MAAM;IAItB,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC;IAIlD,QAAQ,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC;IAI9C,UAAU,IAAI,OAAO;IAIrB,SAAS,IAAI,MAAM;IAInB,QAAQ,IAAI,KAAK;IAIjB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAO3C,UAAU,CAAC,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAanD;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,MAAM;IAIjC;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM;IAIvC;;;;OAIG;IACH,SAAS;CAGZ;AAED,eAAe,MAAM,CAAC"}

package/lib/models/page.d.ts

@@ -0,0 +1,44 @@
+import Immutable from "immutable";
+import File from "./file";
+declare const Page_base: Immutable.Record.Class;
+declare class Page extends Page_base {
+    getFile(): File;
+    getAttributes(): any;
+    getContent(): string;
+    getDir(): string;
+    /**
+     * Return page as text
+     * @return {string}
+     */
+    toText(): string;
+    /**
+     * Return path of the page
+     * @return {string}
+     */
+    getPath(): string;
+    /**
+     * Create a page for a file
+     * @param {File} file
+     * @return {Page}
+     */
+    static createForFile(file: File): Page;
+    /**
+     * Load a page for a file
+     * @param {File} file
+     * @param {string} content
+     * @return {Page}
+     */
+    static loadFile(file: File, content: string): Page;
+    static fromJSON(json: {
+        file: {
+            [key: string]: any;
+        };
+        atributes: Immutable.Iterable.Keyed<unknown, unknown>;
+        content: any;
+        dir: any;
+    }): Page;
+    static toJSON(page: Page): any;
+    hash(): number;
+}
+export default Page;
+//# sourceMappingURL=page.d.ts.map

package/lib/models/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../src/models/page.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,IAAI,MAAM,QAAQ,CAAC;;AAG1B,cAAM,IAAK,SAAQ,SAWjB;IACE,OAAO,IAAI,IAAI;IAIf,aAAa;IAIb,UAAU,IAAI,MAAM;IAIpB,MAAM,IAAI,MAAM;IAIhB;;;OAGG;IACH,MAAM,IAAI,MAAM;IAYhB;;;OAGG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAOlD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;QAClB,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAC;QAC7B,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,EAAE,GAAG,CAAC;QACb,GAAG,EAAE,GAAG,CAAC;KACZ;IAYD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI;IAIxB,IAAI;CAGP;AAED,eAAe,IAAI,CAAC"}

package/lib/models/parser.d.ts

@@ -0,0 +1,44 @@
+import Immutable from "immutable";
+export type ParserOptions = {
+    baseDirectory: string;
+};
+declare const Parser_base: Immutable.Record.Class;
+declare class Parser extends Parser_base {
+    getName(): string;
+    getExtensions(): Immutable.List<string>;
+    parseReadme(content: string, options: ParserOptions): any;
+    parseSummary(content: string, options: ParserOptions): any;
+    parseGlossary(content: string, options: ParserOptions): any;
+    preparePage(content: string): any;
+    parsePage(content: string, options: ParserOptions): any;
+    parseInline(content: string, options: ParserOptions): any;
+    parseLanguages(content: string, options: ParserOptions): any;
+    renderLanguages(content: any): any;
+    renderSummary(content: any): any;
+    renderGlossary(content: any): any;
+    /**
+     Test if this parser matches an extension
+
+     @param {string} ext
+     @return {boolean}
+     */
+    matchExtension(ext: string): boolean;
+    /**
+     Create a new parser using a module (gitbook-markdown, etc)
+
+     @param {string} name
+     @param {Array<String>} extensions
+     @param {Object} module
+     @return {Parsers}
+     */
+    static create(name: string, extensions: string[] | Immutable.Iterable.Indexed<unknown>, module: {
+        readme: any;
+        langs: any;
+        summary: any;
+        glossary: any;
+        page: any;
+        inline: any;
+    }): Parser;
+}
+export default Parser;
+//# sourceMappingURL=parser.d.ts.map

package/lib/models/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/models/parser.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAGlC,MAAM,MAAM,aAAa,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;;AACF,cAAM,MAAO,SAAQ,WAanB;IACE,OAAO,IAAI,MAAM;IAIjB,aAAa,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;IAMvC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAMnD,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAMpD,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAMrD,WAAW,CAAC,OAAO,EAAE,MAAM;IAS3B,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAMjD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAMnD,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAQtD,eAAe,CAAC,OAAO,EAAE,GAAG;IAM5B,aAAa,CAAC,OAAO,EAAE,GAAG;IAM1B,cAAc,CAAC,OAAO,EAAE,GAAG;IAM3B;;;;;OAKG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM;IAK1B;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAC1D,MAAM,EAAE;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,OAAO,EAAE,GAAG,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE;CAa/F;AAED,eAAe,MAAM,CAAC"}

package/lib/models/parser.js

@@ -15,7 +15,7 @@ class Parser extends immutable_1.default.Record({
     summary: Function(),
     glossary: Function(),
     page: Function(),
-    inline: Function(),
+    inline: Function()
 }) {
     getName() {
         return this.get("name");
@@ -24,17 +24,17 @@ class Parser extends immutable_1.default.Record({
         return this.get("extensions");
     }
     // PARSE
-    parseReadme(content) {
+    parseReadme(content, options) {
         const readme = this.get("readme");
-        return (0, promise_1.default)(readme(content));
+        return (0, promise_1.default)(readme(content, options));
     }
-    parseSummary(content) {
+    parseSummary(content, options) {
         const summary = this.get("summary");
         return (0, promise_1.default)(summary(content));
     }
-    parseGlossary(content) {
+    parseGlossary(content, options) {
         const glossary = this.get("glossary");
-        return (0, promise_1.default)(glossary(content));
+        return (0, promise_1.default)(glossary(content, options));
     }
     preparePage(content) {
         const page = this.get("page");
@@ -43,17 +43,17 @@ class Parser extends immutable_1.default.Record({
         }
         return (0, promise_1.default)(page.prepare(content));
     }
-    parsePage(content) {
+    parsePage(content, options) {
         const page = this.get("page");
-        return (0, promise_1.default)(page(content));
+        return (0, promise_1.default)(page(content, options));
     }
-    parseInline(content) {
+    parseInline(content, options) {
         const inline = this.get("inline");
-        return (0, promise_1.default)(inline(content));
+        return (0, promise_1.default)(inline(content, options));
     }
-    parseLanguages(content) {
+    parseLanguages(content, options) {
         const langs = this.get("langs");
-        return (0, promise_1.default)(langs(content));
+        return (0, promise_1.default)(langs(content, options));
     }
     // TO TEXT
     renderLanguages(content) {
@@ -84,7 +84,7 @@ class Parser extends immutable_1.default.Record({
      @param {string} name
      @param {Array<String>} extensions
      @param {Object} module
-     @return {Parser}
+     @return {Parsers}
      */
     static create(name, extensions, module) {
         return new Parser({
@@ -95,7 +95,7 @@ class Parser extends immutable_1.default.Record({
             summary: module.summary,
             glossary: module.glossary,
             page: module.page,
-            inline: module.inline,
+            inline: module.inline
         });
     }
 }

package/lib/models/plugin.d.ts

@@ -0,0 +1,69 @@
+import Immutable from "immutable";
+import PluginDependency from "./pluginDependency";
+type Content = Immutable.Map<any, any>;
+type Package = Immutable.Map<any, any>;
+declare const Plugin_base: Immutable.Record.Class;
+declare class Plugin extends Plugin_base {
+    getName(): string;
+    getPath(): string;
+    getVersion(): string;
+    getPackage(): Package;
+    getContent(): Content;
+    getDepth(): number;
+    getParent(): string;
+    /**
+     * Return the ID on NPM for this plugin
+     * return package.json's name
+     * @return {string}
+     */
+    getNpmID(): string;
+    /**
+     * Check if a plugin is loaded
+     * @return {boolean}
+     */
+    isLoaded(): boolean;
+    /**
+     * Check if a plugin is a theme given its name
+     * @return {boolean}
+     */
+    isTheme(): boolean;
+    /**
+     * Return map of hooks
+     */
+    getHooks(): Immutable.Map<string, Function>;
+    /**
+     * Return infos about resources for a specific type
+     * @param {string} type
+     * @return {Map<String:Mixed>}
+     */
+    getResources(type: string): any;
+    /**
+     * Return map of filters
+     * @return {Map<String:Function>}
+     */
+    getFilters(): any;
+    /**
+     * Return map of blocks
+     * @return {Map<String:TemplateBlock>}
+     */
+    getBlocks(): any;
+    /**
+     * Return a specific hook
+     * @param {string} name
+     * @return {Function|undefined}
+     */
+    getHook(name: string): Function;
+    /**
+     * Create a plugin from a string
+     * @return {Plugin}
+     * @param s
+     */
+    static createFromString(s: string): Plugin;
+    /**
+     * Create a plugin from a dependency
+     * @return {Plugin}
+     */
+    static createFromDep(dep: PluginDependency): Plugin;
+}
+export default Plugin;
+//# sourceMappingURL=plugin.d.ts.map

package/lib/models/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/models/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAKlD,KAAK,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACvC,KAAK,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;;AAEvC,cAAM,MAAO,SAAQ,WAuBpB;IACG,OAAO,IAAI,MAAM;IAIjB,OAAO,IAAI,MAAM;IAIjB,UAAU,IAAI,MAAM;IAIpB,UAAU,IAAI,OAAO;IAIrB,UAAU,IAAI,OAAO;IAIrB,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,MAAM;IAInB;;;;OAIG;IAEH,QAAQ,IAAI,MAAM;IAQlB;;;OAGG;IAEH,QAAQ,IAAI,OAAO;IAInB;;;OAGG;IAEH,OAAO,IAAI,OAAO;IAKlB;;OAEG;IACH,QAAQ,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAI3C;;;;OAIG;IAEH,YAAY,CAAC,IAAI,EAAE,MAAM;IASzB;;;OAGG;IAEH,UAAU;IAIV;;;OAGG;IAEH,SAAS;IAST;;;;OAIG;IAEH,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB;;;;OAIG;IAEH,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM;IAWjC;;;OAGG;IAEH,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,gBAAgB;CAM7C;AAED,eAAe,MAAM,CAAC"}

package/lib/models/pluginDependency.d.ts

@@ -0,0 +1,47 @@
+import Immutable from "immutable";
+declare const PluginDependency_base: Immutable.Record.Class;
+declare class PluginDependency extends PluginDependency_base {
+    getName(): any;
+    getVersion(): any;
+    getPath(): any;
+    isEnabled(): any;
+    /**
+     * Toggle this plugin state
+     * @return {PluginDependency}
+     */
+    toggle(state?: boolean): Immutable.Map<string, any>;
+    /**
+     * Is the plugin using a git dependency
+     * @return {boolean}
+     */
+    isGitDependency(): boolean;
+    /**
+     * Create a plugin with a name and a plugin
+     * @return {Plugin|undefined}
+     */
+    static create(name: string, version: string, enabled?: boolean): PluginDependency;
+    /**
+     * Create a plugin from a string
+     * @param {string} s
+     * @return {Plugin|undefined}
+     */
+    static createFromString(s: any): PluginDependency;
+    /**
+     * Create a PluginDependency from a string
+     * @param {string}
+     * @return {List<PluginDependency>}
+     */
+    static listFromString(s: any): Immutable.Iterable<number, PluginDependency>;
+    /**
+     * Create a PluginDependency from an array
+     */
+    static listFromArray(arr: (PluginDependency | string)[]): Immutable.Iterable<number, PluginDependency>;
+    /**
+     * Export plugin dependencies as an array
+     * @param {List<PluginDependency>} list
+     * @return {Array<String>}
+     */
+    static listToArray(list: any): any;
+}
+export default PluginDependency;
+//# sourceMappingURL=pluginDependency.d.ts.map

package/lib/models/pluginDependency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginDependency.d.ts","sourceRoot":"","sources":["../../src/models/pluginDependency.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,WAAW,CAAC;;AASlC,cAAM,gBAAiB,SAAQ,qBAc9B;IACG,OAAO;IAIP,UAAU;IAIV,OAAO;IAIP,SAAS;IAIT;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO;IAQtB;;;OAGG;IACH,eAAe;IAIf;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO;IAY9D;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,CAAC,KAAA;IAqDzB;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,KAAA;IAKvB;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,gBAAgB,GAAG,MAAM,CAAC,EAAE;IAiBvD;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,KAAA;CAkB1B;AAED,eAAe,gBAAgB,CAAC"}

package/lib/models/readme.d.ts

@@ -0,0 +1,21 @@
+import Immutable from "immutable";
+import File from "./file";
+declare const Readme_base: Immutable.Record.Class;
+declare class Readme extends Readme_base {
+    getFile(): File;
+    getTitle(): string;
+    getDescription(): string;
+    /**
+     Create a new readme
+
+     @param {File} file
+     @param {Object} def
+     @return {Readme}
+     */
+    static create(file: File, def: {
+        title?: any;
+        description?: any;
+    }): Readme;
+}
+export default Readme;
+//# sourceMappingURL=readme.d.ts.map

package/lib/models/readme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readme.d.ts","sourceRoot":"","sources":["../../src/models/readme.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;;AAE1B,cAAM,MAAO,SAAQ,WAInB;IACE,OAAO,IAAI,IAAI;IAIf,QAAQ,IAAI,MAAM;IAIlB,cAAc,IAAI,MAAM;IAIxB;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE;QAAE,KAAK,CAAC,EAAE,GAAG,CAAC;QAAC,WAAW,CAAC,EAAE,GAAG,CAAA;KAAE;CASpE;AAED,eAAe,MAAM,CAAC"}

package/lib/models/summary.d.ts

@@ -0,0 +1,83 @@
+import Immutable from "immutable";
+import File from "./file";
+import SummaryArticle from "./summaryArticle";
+type Parts = Immutable.List<any>;
+declare const Summary_base: Immutable.Record.Class;
+declare class Summary extends Summary_base {
+    getFile(): File;
+    getParts(): Parts;
+    /**
+     Return a part by its index
+     */
+    getPart(i: number): any;
+    /**
+     Return an article using an iterator to find it.
+     if "partIter" is set, it can also return a Part.
+
+     @param {Function} iter
+     @param {Function} [partIter]
+     @return {Article|Part}
+     */
+    getArticle(iter: any, partIter?: any): SummaryArticle | null;
+    /**
+     Return a part/article by its level
+
+     @param {string} level
+     @return {Article|Part}
+     */
+    getByLevel(level: string): SummaryArticle;
+    /**
+     Return an article by its path
+
+     @param {string} filePath
+     @return {Article}
+     */
+    getByPath(filePath: string): SummaryArticle;
+    /**
+     Return the first article
+
+     @return {Article}
+     */
+    getFirstArticle(): SummaryArticle;
+    /**
+     Return next article of an article
+
+     */
+    getNextArticle(current: SummaryArticle | string): SummaryArticle;
+    /**
+     Return previous article of an article
+
+     @param {Article} current
+     @return {Article}
+     */
+    getPrevArticle(current: any): any;
+    /**
+     Return the parent article, or parent part of an article
+
+     @param {String|Article} current
+     @return {Article|Part|Null}
+     */
+    getParent(level: any): SummaryArticle;
+    /**
+     Render summary as text
+
+     @param {string} parseExt Extension of the parser to use
+     @return {Promise<String>}
+     */
+    toText(parseExt: any): any;
+    /**
+     Return all articles as a list
+
+     @return {List<Article>}
+     */
+    getArticlesAsList(): Immutable.List<any>;
+    /**
+     Create a new summary for a list of parts
+
+     @param {Lust|Array} parts
+     @return {Summary}
+     */
+    static createFromParts(file: any, parts: any): Summary;
+}
+export default Summary;
+//# sourceMappingURL=summary.d.ts.map

package/lib/models/summary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/models/summary.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAGlC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAG9C,KAAK,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;AAEjC,cAAM,OAAQ,SAAQ,YAMrB;IACG,OAAO,IAAI,IAAI;IAIf,QAAQ,IAAI,KAAK;IAIjB;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM;IAKjB;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,KAAA,EAAE,QAAQ,CAAC,KAAA,GAAG,cAAc,GAAG,IAAI;IAWlD;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;IAQxB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc;IAQ3C;;;;OAIG;IACH,eAAe;IAMf;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,GAAG,cAAc;IAgBhE;;;;;OAKG;IACH,cAAc,CAAC,OAAO,KAAA;IAiBtB;;;;;OAKG;IACH,SAAS,CAAC,KAAK,KAAA;IAef;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,KAAA;IAiBf;;;;OAIG;IACH,iBAAiB;IAUjB;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,KAAA,EAAE,KAAK,KAAA;CAerC;AAaD,eAAe,OAAO,CAAC"}

package/lib/models/summaryArticle.d.ts

@@ -0,0 +1,93 @@
+import Immutable from "immutable";
+import File from "./file";
+import Book from "./book";
+import Readme from "./readme";
+type Articles = Immutable.List<SummaryArticle>;
+declare const SummaryArticle_base: Immutable.Record.Class;
+declare class SummaryArticle extends SummaryArticle_base {
+    getLevel(): string;
+    getTitle(): string;
+    getRef(): string;
+    getArticles(): Articles;
+    /**
+     * Return how deep the article is.
+     * The README has a depth of 1
+     *
+     * @return {number}
+     */
+    getDepth(): number;
+    /**
+     * Get path (without anchor) to the pointing file.
+     * It also normalizes the file path.
+     *
+     * @return {string}
+     */
+    getPath(): string;
+    /**
+     * Return url if article is external
+     *
+     * @return {string}
+     */
+    getUrl(): string;
+    /**
+     * Get anchor for this article (or undefined)
+     *
+     * @return {string}
+     */
+    getAnchor(): string;
+    /**
+     * Create a new level for a new child article
+     *
+     * @return {string}
+     */
+    createChildLevel(): string;
+    /**
+     * Is article pointing to a page of an absolute url
+     *
+     * @return {boolean}
+     */
+    isPage(): boolean;
+    /**
+     * Check if this article is a file (exatcly)
+     *
+     * @param {File} file
+     * @return {boolean}
+     */
+    isFile(file: File): boolean;
+    /**
+     * Check if this article is the introduction of the book
+     *
+     * @param {Book|Readme} book
+     * @return {boolean}
+     */
+    isReadme(book: Book | Readme): boolean;
+    /**
+     * Is article pointing to aan absolute url
+     *
+     * @return {boolean}
+     */
+    isExternal(): boolean;
+    /**
+     * Create a SummaryArticle
+     *
+     * @param {Object} def
+     * @return {SummaryArticle}
+     */
+    static create(def: any, level: any): SummaryArticle;
+    /**
+     * Has anchor for this article
+     *
+     * @return {boolean}
+     */
+    hasAnchor(): boolean;
+    /**
+     * Find an article from a base one
+     *
+     * @param {Article|Part} base
+     * @param {Function(article)} iter
+     * @return {Article}
+     */
+    static findArticle(base: any, iter: any): SummaryArticle | null;
+}
+export default SummaryArticle;
+//# sourceMappingURL=summaryArticle.d.ts.map

package/lib/models/summaryArticle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summaryArticle.d.ts","sourceRoot":"","sources":["../../src/models/summaryArticle.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,MAAM,MAAM,UAAU,CAAC;AAM9B,KAAK,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;;AAE/C,cAAM,cAAe,SAAQ,mBAQ5B;IACG,QAAQ,IAAI,MAAM;IAIlB,QAAQ,IAAI,MAAM;IAIlB,MAAM,IAAI,MAAM;IAIhB,WAAW,IAAI,QAAQ;IAIvB;;;;;OAKG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;OAKG;IACH,OAAO,IAAI,MAAM;IAmBjB;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;IACH,SAAS,IAAI,MAAM;IAQnB;;;;OAIG;IACH,gBAAgB,IAAI,MAAM;IAQ1B;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAI3B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAQ5B;;;;OAIG;IACH,UAAU;IAIV;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA;IAgBxB;;;;OAIG;IACH,SAAS,IAAI,OAAO;IAKpB;;;;;;OAMG;IAEH,MAAM,CAAC,WAAW,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,GAAG,cAAc,GAAG,IAAI;CAYxD;AAED,eAAe,cAAc,CAAC"}

package/lib/models/summaryPart.d.ts

@@ -0,0 +1,23 @@
+import Immutable from "immutable";
+type Articles = Immutable.List<any>;
+declare const SummaryPart_base: Immutable.Record.Class;
+declare class SummaryPart extends SummaryPart_base {
+    getLevel(): string;
+    getTitle(): string;
+    getArticles(): Articles;
+    /**
+     * Create a new level for a new child article
+     *
+     * @return {string}
+     */
+    createChildLevel(): string;
+    /**
+     * Create a SummaryPart
+     *
+     * @param {Object} def
+     * @return {SummaryPart}
+     */
+    static create(def: any, level: any): SummaryPart;
+}
+export default SummaryPart;
+//# sourceMappingURL=summaryPart.d.ts.map

package/lib/models/summaryPart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summaryPart.d.ts","sourceRoot":"","sources":["../../src/models/summaryPart.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAOlC,KAAK,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;AAEpC,cAAM,WAAY,SAAQ,gBAIxB;IACE,QAAQ,IAAI,MAAM;IAIlB,QAAQ,IAAI,MAAM;IAIlB,WAAW,IAAI,QAAQ;IAIvB;;;;OAIG;IACH,gBAAgB,IAAI,MAAM;IAQ1B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,KAAA,EAAE,KAAK,KAAA,GAAG,WAAW;CAezC;AAED,eAAe,WAAW,CAAC"}