honkit 3.6.21

package/lib/json/encodeBookWithPage.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeBook_1 = __importDefault(require("./encodeBook"));
+const encodePage_1 = __importDefault(require("./encodePage"));
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+/**
+ * Return a JSON representation of a book with a specific file
+ *
+ * @param {Book} output
+ * @param {Page} page
+ * @return {Object}
+ */
+function encodeBookWithPage(book, page) {
+    const file = page.getFile();
+    const result = encodeBook_1.default(book);
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'page' does not exist on type '{ summary:... Remove this comment to see the full error message
+    result.page = encodePage_1.default(page, book.getSummary());
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'file' does not exist on type '{ summary:... Remove this comment to see the full error message
+    result.file = encodeFile_1.default(file);
+    return result;
+}
+exports.default = encodeBookWithPage;

package/lib/json/encodeFile.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ Return a JSON representation of a file
+
+ @param {File} file
+ @return {Object}
+ */
+function encodeFileToJson(file) {
+    const filePath = file.getPath();
+    if (!filePath) {
+        return undefined;
+    }
+    return {
+        path: filePath,
+        mtime: file.getMTime(),
+        type: file.getType(),
+    };
+}
+exports.default = encodeFileToJson;

package/lib/json/encodeGlossary.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+const encodeGlossaryEntry_1 = __importDefault(require("./encodeGlossaryEntry"));
+/**
+ Encode a glossary to JSON
+
+ @param {Glossary}
+ @return {Object}
+ */
+function encodeGlossary(glossary) {
+    const file = glossary.getFile();
+    const entries = glossary.getEntries();
+    return {
+        file: encodeFile_1.default(file),
+        entries: entries.map(encodeGlossaryEntry_1.default).toJS(),
+    };
+}
+exports.default = encodeGlossary;

package/lib/json/encodeGlossaryEntry.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ Encode a SummaryArticle to JSON
+
+ @param {GlossaryEntry}
+ @return {Object}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function encodeGlossaryEntry(entry) {
+    return {
+        id: entry.getID(),
+        name: entry.getName(),
+        description: entry.getDescription(),
+    };
+}
+exports.default = encodeGlossaryEntry;

package/lib/json/encodeLanguages.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+/**
+ Encode a languages listing to JSON
+
+ @param {Languages}
+ @return {Object}
+ */
+function encodeLanguages(languages) {
+    const file = languages.getFile();
+    const list = languages.getList();
+    return {
+        file: encodeFile_1.default(file),
+        list: list
+            .valueSeq()
+            .map((lang) => {
+            return {
+                id: lang.getID(),
+                title: lang.getTitle(),
+            };
+        })
+            .toJS(),
+    };
+}
+exports.default = encodeLanguages;

package/lib/json/encodeOutput.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeBook_1 = __importDefault(require("./encodeBook"));
+/**
+ * Encode an output to JSON
+ *
+ * @param {Output}
+ * @return {Object}
+ */
+function encodeOutputToJson(output) {
+    const book = output.getBook();
+    const generator = output.getGenerator();
+    const options = output.getOptions();
+    const result = encodeBook_1.default(book);
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'output' does not exist on type '{ summar... Remove this comment to see the full error message
+    result.output = {
+        name: generator,
+    };
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'options' does not exist on type '{ summa... Remove this comment to see the full error message
+    result.options = options.toJS();
+    return result;
+}
+exports.default = encodeOutputToJson;

package/lib/json/encodeOutputWithPage.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeOutput_1 = __importDefault(require("./encodeOutput"));
+const encodePage_1 = __importDefault(require("./encodePage"));
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+/**
+ * Return a JSON representation of a book with a specific file
+ *
+ * @param {Book} output
+ * @param {Page} page
+ * @return {Object}
+ */
+function encodeOutputWithPage(output, page) {
+    const file = page.getFile();
+    const book = output.getBook();
+    const result = encodeOutput_1.default(output);
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'page' does not exist on type '{ summary:... Remove this comment to see the full error message
+    result.page = encodePage_1.default(page, book.getSummary());
+    // @ts-expect-error ts-migrate(2339) FIXME: Property 'file' does not exist on type '{ summary:... Remove this comment to see the full error message
+    result.file = encodeFile_1.default(file);
+    return result;
+}
+exports.default = encodeOutputWithPage;

package/lib/json/encodePage.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeSummaryArticle_1 = __importDefault(require("./encodeSummaryArticle"));
+/**
+ Return a JSON representation of a page
+
+ @param {Page} page
+ @param {Summary} summary
+ @return {Object}
+ */
+function encodePage(page, summary) {
+    const file = page.getFile();
+    const attributes = page.getAttributes();
+    const article = summary.getByPath(file.getPath());
+    const result = attributes.toJS();
+    if (article) {
+        result.title = article.getTitle();
+        result.level = article.getLevel();
+        result.depth = article.getDepth();
+        const nextArticle = summary.getNextArticle(article);
+        if (nextArticle) {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+            result.next = encodeSummaryArticle_1.default(nextArticle);
+        }
+        const prevArticle = summary.getPrevArticle(article);
+        if (prevArticle) {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+            result.previous = encodeSummaryArticle_1.default(prevArticle);
+        }
+    }
+    result.content = page.getContent();
+    result.dir = page.getDir();
+    return result;
+}
+exports.default = encodePage;

package/lib/json/encodeReadme.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+/**
+ Encode a readme to JSON
+
+ @param {Readme}
+ @return {Object}
+ */
+function encodeReadme(readme) {
+    const file = readme.getFile();
+    return {
+        file: encodeFile_1.default(file),
+    };
+}
+exports.default = encodeReadme;

package/lib/json/encodeSummary.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+const encodeSummaryPart_1 = __importDefault(require("./encodeSummaryPart"));
+/**
+ Encode a summary to JSON
+
+ @param {Summary}
+ @return {Object}
+ */
+function encodeSummary(summary) {
+    const file = summary.getFile();
+    const parts = summary.getParts();
+    return {
+        file: encodeFile_1.default(file),
+        parts: parts.map(encodeSummaryPart_1.default).toJS(),
+    };
+}
+exports.default = encodeSummary;

package/lib/json/encodeSummaryArticle.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ Encode a SummaryArticle to JSON
+
+ @param {SummaryArticle}
+ @return {Object}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function encodeSummaryArticle(article, recursive) {
+    let articles = undefined;
+    if (recursive !== false) {
+        articles = article.getArticles().map(encodeSummaryArticle).toJS();
+    }
+    return {
+        title: article.getTitle(),
+        level: article.getLevel(),
+        depth: article.getDepth(),
+        anchor: article.getAnchor(),
+        url: article.getUrl(),
+        path: article.getPath(),
+        ref: article.getRef(),
+        articles: articles,
+    };
+}
+exports.default = encodeSummaryArticle;

package/lib/json/encodeSummaryPart.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeSummaryArticle_1 = __importDefault(require("./encodeSummaryArticle"));
+/**
+ Encode a SummaryPart to JSON
+
+ @param {SummaryPart}
+ @return {Object}
+ */
+function encodeSummaryPart(part) {
+    return {
+        title: part.getTitle(),
+        articles: part.getArticles().map(encodeSummaryArticle_1.default).toJS(),
+    };
+}
+exports.default = encodeSummaryPart;

package/lib/json/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const encodeOutput_1 = __importDefault(require("./encodeOutput"));
+const encodeBookWithPage_1 = __importDefault(require("./encodeBookWithPage"));
+const encodeOutputWithPage_1 = __importDefault(require("./encodeOutputWithPage"));
+const encodeBook_1 = __importDefault(require("./encodeBook"));
+const encodeFile_1 = __importDefault(require("./encodeFile"));
+const encodePage_1 = __importDefault(require("./encodePage"));
+const encodeSummary_1 = __importDefault(require("./encodeSummary"));
+const encodeSummaryArticle_1 = __importDefault(require("./encodeSummaryArticle"));
+const encodeReadme_1 = __importDefault(require("./encodeReadme"));
+const encodeLanguages_1 = __importDefault(require("./encodeLanguages"));
+exports.default = {
+    encodeOutput: encodeOutput_1.default,
+    encodeBookWithPage: encodeBookWithPage_1.default,
+    encodeOutputWithPage: encodeOutputWithPage_1.default,
+    encodeBook: encodeBook_1.default,
+    encodeFile: encodeFile_1.default,
+    encodePage: encodePage_1.default,
+    encodeSummary: encodeSummary_1.default,
+    encodeSummaryArticle: encodeSummaryArticle_1.default,
+    encodeReadme: encodeReadme_1.default,
+    encodeLanguages: encodeLanguages_1.default,
+};

package/lib/models/__tests__/config.js

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const immutable_1 = __importDefault(require("immutable"));
+const config_1 = __importDefault(require("../config"));
+describe("Config", () => {
+    const config = config_1.default.createWithValues({
+        hello: {
+            world: 1,
+            test: "Hello",
+            isFalse: false,
+        },
+    });
+    describe("getValue", () => {
+        test("must return value as immutable", () => {
+            const value = config.getValue("hello");
+            expect(immutable_1.default.Map.isMap(value)).toBeTruthy();
+        });
+        test("must return deep value", () => {
+            const value = config.getValue("hello.world");
+            expect(value).toBe(1);
+        });
+        test("must return default value if non existant", () => {
+            const value = config.getValue("hello.nonExistant", "defaultValue");
+            expect(value).toBe("defaultValue");
+        });
+        test("must not return default value for falsy values", () => {
+            const value = config.getValue("hello.isFalse", "defaultValue");
+            expect(value).toBe(false);
+        });
+    });
+    describe("setValue", () => {
+        test("must set value as immutable", () => {
+            const testConfig = config.setValue("hello", {
+                cool: 1,
+            });
+            const value = testConfig.getValue("hello");
+            expect(immutable_1.default.Map.isMap(value)).toBeTruthy();
+            expect(value.size).toBe(1);
+            expect(value.has("cool")).toBeTruthy();
+        });
+        test("must set deep value", () => {
+            const testConfig = config.setValue("hello.world", 2);
+            const hello = testConfig.getValue("hello");
+            const world = testConfig.getValue("hello.world");
+            expect(immutable_1.default.Map.isMap(hello)).toBeTruthy();
+            expect(hello.size).toBe(3);
+            expect(world).toBe(2);
+        });
+    });
+    describe("toReducedVersion", () => {
+        test("must only return diffs for simple values", () => {
+            const _config = config_1.default.createWithValues({
+                gitbook: "3.0.0",
+            });
+            const reducedVersion = _config.toReducedVersion();
+            expect(reducedVersion.toJS()).toEqual({
+                gitbook: "3.0.0",
+            });
+        });
+        test("must only return diffs for deep values", () => {
+            const _config = config_1.default.createWithValues({
+                structure: {
+                    readme: "intro.md",
+                },
+            });
+            const reducedVersion = _config.toReducedVersion();
+            expect(reducedVersion.toJS()).toEqual({
+                structure: {
+                    readme: "intro.md",
+                },
+            });
+        });
+    });
+    describe("getPluginDependencies", () => {
+        const config = config_1.default.createWithValues({
+            plugins: [
+                "example",
+                "honkit-plugin-example",
+                "@example/example",
+                "@example/honkit-plugin-example",
+                "@honkit/honkit-plugin-example",
+                "-no-use",
+                "-honkit-plugin-no-use",
+                "-@honkit/honkit-plugin-no-use",
+                // GitBook logic - deprecated
+                "example-v@1.0.0",
+                "gitbook-plugin-example-v@1.0.0",
+                "example@git+ssh://samy@github.com/GitbookIO/plugin-ga.git",
+            ],
+        });
+        const dependencies = config.getPluginDependencies();
+        expect(dependencies.toJS()).toEqual([
+            {
+                enabled: true,
+                name: "example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@example/example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@example/honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@honkit/honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "honkit-plugin-no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "@honkit/honkit-plugin-no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "example-v",
+                path: "",
+                version: "1.0.0",
+            },
+            {
+                enabled: true,
+                name: "gitbook-plugin-example-v",
+                path: "",
+                version: "1.0.0",
+            },
+            {
+                enabled: true,
+                name: "example",
+                path: "",
+                version: "git+ssh://samy@github.com/GitbookIO/plugin-ga.git",
+            },
+        ]);
+    });
+});