honkit 3.6.21

package/lib/modifiers/summary/editArticleRef.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
+/**
+ Edit the ref of an article
+
+ @param {Summary} summary
+ @param {string} level
+ @param {string} newRef
+ @return {Summary}
+ */
+function editArticleRef(summary, level, newRef) {
+    return mergeAtLevel_1.default(summary, level, {
+        ref: newRef,
+    });
+}
+exports.default = editArticleRef;

package/lib/modifiers/summary/editArticleTitle.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
+/**
+ Edit title of an article
+
+ @param {Summary} summary
+ @param {string} level
+ @param {string} newTitle
+ @return {Summary}
+ */
+function editArticleTitle(summary, level, newTitle) {
+    return mergeAtLevel_1.default(summary, level, {
+        title: newTitle,
+    });
+}
+exports.default = editArticleTitle;

package/lib/modifiers/summary/editPartTitle.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ Edit title of a part in the summary
+
+ @param {Summary} summary
+ @param {number} index
+ @param {string} newTitle
+ @return {Summary}
+ */
+function editPartTitle(summary, index, newTitle) {
+    let parts = summary.getParts();
+    let part = parts.get(index);
+    if (!part) {
+        return summary;
+    }
+    part = part.set("title", newTitle);
+    parts = parts.set(index, part);
+    return summary.set("parts", parts);
+}
+exports.default = editPartTitle;

package/lib/modifiers/summary/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 moveArticleAfter_1 = __importDefault(require("./moveArticleAfter"));
+const moveArticle_1 = __importDefault(require("./moveArticle"));
+const insertArticle_1 = __importDefault(require("./insertArticle"));
+const removeArticle_1 = __importDefault(require("./removeArticle"));
+const unshiftArticle_1 = __importDefault(require("./unshiftArticle"));
+const editArticleTitle_1 = __importDefault(require("./editArticleTitle"));
+const editArticleRef_1 = __importDefault(require("./editArticleRef"));
+const insertPart_1 = __importDefault(require("./insertPart"));
+const removePart_1 = __importDefault(require("./removePart"));
+const editPartTitle_1 = __importDefault(require("./editPartTitle"));
+exports.default = {
+    insertArticle: insertArticle_1.default,
+    moveArticle: moveArticle_1.default,
+    moveArticleAfter: moveArticleAfter_1.default,
+    removeArticle: removeArticle_1.default,
+    unshiftArticle: unshiftArticle_1.default,
+    editArticleTitle: editArticleTitle_1.default,
+    editArticleRef: editArticleRef_1.default,
+    insertPart: insertPart_1.default,
+    removePart: removePart_1.default,
+    editPartTitle: editPartTitle_1.default,
+};

package/lib/modifiers/summary/indexArticleLevels.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ Index levels in an article tree
+
+ @param {Article}
+ @param {string} baseLevel
+ @return {Article}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function indexArticleLevels(article, baseLevel) {
+    baseLevel = baseLevel || article.getLevel();
+    let articles = article.getArticles();
+    articles = articles.map((inner, i) => {
+        return indexArticleLevels(inner, `${baseLevel}.${i + 1}`);
+    });
+    return article.merge({
+        level: baseLevel,
+        articles: articles,
+    });
+}
+exports.default = indexArticleLevels;

package/lib/modifiers/summary/indexLevels.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const indexPartLevels_1 = __importDefault(require("./indexPartLevels"));
+/**
+ Index all levels in the summary
+
+ @param {Summary}
+ @return {Summary}
+ */
+function indexLevels(summary) {
+    let parts = summary.getParts();
+    parts = parts.map(indexPartLevels_1.default);
+    return summary.set("parts", parts);
+}
+exports.default = indexLevels;

package/lib/modifiers/summary/indexPartLevels.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 indexArticleLevels_1 = __importDefault(require("./indexArticleLevels"));
+/**
+ Index levels in a part
+
+ @param {Part}
+ @param {number} index
+ @return {Part}
+ */
+function indexPartLevels(part, index) {
+    const baseLevel = String(index + 1);
+    let articles = part.getArticles();
+    articles = articles.map((inner, i) => {
+        return indexArticleLevels_1.default(inner, `${baseLevel}.${i + 1}`);
+    });
+    return part.merge({
+        level: baseLevel,
+        articles: articles,
+    });
+}
+exports.default = indexPartLevels;

package/lib/modifiers/summary/insertArticle.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const is_1 = __importDefault(require("is"));
+const summaryArticle_1 = __importDefault(require("../../models/summaryArticle"));
+const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
+const indexArticleLevels_1 = __importDefault(require("./indexArticleLevels"));
+/**
+ Returns a new Summary with the article at the given level, with
+ subsequent article shifted.
+
+ @param {Summary} summary
+ @param {Article} article
+ @param {String|Article} level: level to insert at
+ @return {Summary}
+ */
+function insertArticle(summary, article, level) {
+    article = new summaryArticle_1.default(article);
+    level = is_1.default.string(level) ? level : level.getLevel();
+    let parent = summary.getParent(level);
+    if (!parent) {
+        return summary;
+    }
+    // Find the index to insert at
+    let articles = parent.getArticles();
+    const index = getLeafIndex(level);
+    // Insert the article at the right index
+    articles = articles.insert(index, article);
+    // Reindex the level from here
+    parent = parent.set("articles", articles);
+    // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+    parent = indexArticleLevels_1.default(parent);
+    return mergeAtLevel_1.default(summary, parent.getLevel(), parent);
+}
+/**
+ @param {string}
+ @return {number} The index of this level within its parent's children
+ */
+function getLeafIndex(level) {
+    const arr = level.split(".").map((char) => {
+        return parseInt(char, 10);
+    });
+    return arr[arr.length - 1] - 1;
+}
+exports.default = insertArticle;

package/lib/modifiers/summary/insertPart.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summaryPart_1 = __importDefault(require("../../models/summaryPart"));
+const indexLevels_1 = __importDefault(require("./indexLevels"));
+/**
+ Returns a new Summary with a part inserted at given index
+
+ @param {Summary} summary
+ @param {Part} part
+ @param {number} index
+ @return {Summary}
+ */
+function insertPart(summary, part, index) {
+    part = new summaryPart_1.default(part);
+    const parts = summary.getParts().insert(index, part);
+    return indexLevels_1.default(summary.set("parts", parts));
+}
+exports.default = insertPart;

package/lib/modifiers/summary/mergeAtLevel.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ Edit a list of articles
+
+ @param {List<Article>} articles
+ @param {string} level
+ @param {Article} newArticle
+ @return {List<Article>}
+ */
+function editArticleInList(articles, level, newArticle) {
+    return articles.map((article) => {
+        const articleLevel = article.getLevel();
+        if (articleLevel === level) {
+            // it is the article to edit
+            return article.merge(newArticle);
+        }
+        else if (level.indexOf(articleLevel) === 0) {
+            // it is a parent
+            const articles = editArticleInList(article.getArticles(), level, newArticle);
+            return article.set("articles", articles);
+        }
+        else {
+            // This is not the article you are looking for
+            return article;
+        }
+    });
+}
+/**
+ Edit an article in a part
+
+ @param {Part} part
+ @param {string} level
+ @param {Article} newArticle
+ @return {Part}
+ */
+function editArticleInPart(part, level, newArticle) {
+    let articles = part.getArticles();
+    articles = editArticleInList(articles, level, newArticle);
+    return part.set("articles", articles);
+}
+/**
+ Edit an article, or a part, in a summary. Does a shallow merge.
+
+ @param {Summary} summary
+ @param {string} level
+ @param {Article|Part} newValue
+ @return {Summary}
+ */
+function mergeAtLevel(summary, level, newValue) {
+    const levelParts = level.split(".");
+    const partIndex = Number(levelParts[0]) - 1;
+    let parts = summary.getParts();
+    let part = parts.get(partIndex);
+    if (!part) {
+        return summary;
+    }
+    const isEditingPart = levelParts.length < 2;
+    if (isEditingPart) {
+        part = part.merge(newValue);
+    }
+    else {
+        part = editArticleInPart(part, level, newValue);
+    }
+    parts = parts.set(partIndex, part);
+    return summary.set("parts", parts);
+}
+exports.default = mergeAtLevel;

package/lib/modifiers/summary/moveArticle.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 is_1 = __importDefault(require("is"));
+const removeArticle_1 = __importDefault(require("./removeArticle"));
+const insertArticle_1 = __importDefault(require("./insertArticle"));
+/**
+ Returns a new summary, with the given article removed from its
+ origin level, and placed at the given target level.
+
+ @param {Summary} summary
+ @param {String|SummaryArticle} origin: level to remove
+ @param {String|SummaryArticle} target: the level where the article will be found
+ @return {Summary}
+ */
+function moveArticle(summary, origin, target) {
+    // Coerce to level
+    const originLevel = is_1.default.string(origin) ? origin : origin.getLevel();
+    const targetLevel = is_1.default.string(target) ? target : target.getLevel();
+    const article = summary.getByLevel(originLevel);
+    // Remove first
+    const removed = removeArticle_1.default(summary, originLevel);
+    return insertArticle_1.default(removed, article, targetLevel);
+}
+exports.default = moveArticle;

package/lib/modifiers/summary/moveArticleAfter.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const is_1 = __importDefault(require("is"));
+const removeArticle_1 = __importDefault(require("./removeArticle"));
+const insertArticle_1 = __importDefault(require("./insertArticle"));
+/**
+ Returns a new summary, with the an article moved after another
+ article. Unlike `moveArticle`, does not ensure that the article
+ will be found at the target's level plus one.
+
+ @param {Summary} summary
+ @param {String|SummaryArticle} origin
+ @param {String|SummaryArticle} afterTarget
+ @return {Summary}
+ */
+function moveArticleAfter(summary, origin, afterTarget) {
+    // Coerce to level
+    const originLevel = is_1.default.string(origin) ? origin : origin.getLevel();
+    const afterTargetLevel = is_1.default.string(afterTarget) ? afterTarget : afterTarget.getLevel();
+    const article = summary.getByLevel(originLevel);
+    const targetLevel = increment(afterTargetLevel);
+    if (targetLevel < origin) {
+        // Remove first
+        const removed = removeArticle_1.default(summary, originLevel);
+        // Insert then
+        return insertArticle_1.default(removed, article, targetLevel);
+    }
+    else {
+        // Insert right after first
+        const inserted = insertArticle_1.default(summary, article, targetLevel);
+        // Remove old one
+        return removeArticle_1.default(inserted, originLevel);
+    }
+}
+/**
+ @param {string}
+ @return {Array<Number>}
+ */
+function levelToArray(l) {
+    return l.split(".").map((char) => {
+        return parseInt(char, 10);
+    });
+}
+/**
+ @param {Array<Number>}
+ @return {string}
+ */
+function arrayToLevel(a) {
+    return a.join(".");
+}
+function increment(level) {
+    level = levelToArray(level);
+    level[level.length - 1]++;
+    return arrayToLevel(level);
+}
+exports.default = moveArticleAfter;

package/lib/modifiers/summary/removeArticle.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const is_1 = __importDefault(require("is"));
+const mergeAtLevel_1 = __importDefault(require("./mergeAtLevel"));
+const indexArticleLevels_1 = __importDefault(require("./indexArticleLevels"));
+/**
+ Remove an article from a level.
+
+ @param {Summary} summary
+ @param {String|SummaryArticle} level: level to remove
+ @return {Summary}
+ */
+function removeArticle(summary, level) {
+    // Coerce to level
+    level = is_1.default.string(level) ? level : level.getLevel();
+    let parent = summary.getParent(level);
+    let articles = parent.getArticles();
+    // Find the index to remove
+    const index = articles.findIndex((art) => {
+        return art.getLevel() === level;
+    });
+    if (index === -1) {
+        return summary;
+    }
+    // Remove from children
+    articles = articles.remove(index);
+    parent = parent.set("articles", articles);
+    // Reindex the level from here
+    // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+    parent = indexArticleLevels_1.default(parent);
+    return mergeAtLevel_1.default(summary, parent.getLevel(), parent);
+}
+exports.default = removeArticle;

package/lib/modifiers/summary/removePart.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const indexLevels_1 = __importDefault(require("./indexLevels"));
+/**
+ Remove a part at given index
+
+ @param {Summary} summary
+ @param {Number|} index
+ @return {Summary}
+ */
+function removePart(summary, index) {
+    const parts = summary.getParts().remove(index);
+    return indexLevels_1.default(summary.set("parts", parts));
+}
+exports.default = removePart;