npm - markdown-patch - Versions diffs - 0.2.1 → 0.3.0 - Mend

markdown-patch 0.2.1 → 0.3.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 (13) hide show

package/dist/cli.js +29 -24
package/dist/constants.js +5 -2
package/dist/debug.js +16 -9
package/dist/index.d.ts +1 -0
package/dist/index.d.ts.map +1 -1
package/dist/index.js +26 -2
package/dist/map.js +34 -7
package/dist/patch.js +64 -33
package/dist/tests/map.test.js +16 -11
package/dist/tests/patch.test.js +50 -45
package/dist/typeGuards.js +12 -5
package/dist/types.js +5 -2
package/package.json +1 -1

package/dist/cli.js CHANGED Viewed

@@ -1,10 +1,15 @@
 #!/usr/bin/env node
-import { Command } from "commander";
-import fs from "fs/promises";
-import { getDocumentMap } from "./map.js";
-import { printMap } from "./debug.js";
-import { applyPatch } from "./patch.js";
-import packageJson from "../package.json" assert { type: "json" };
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const promises_1 = __importDefault(require("fs/promises"));
+const map_js_1 = require("./map.js");
+const debug_js_1 = require("./debug.js");
+const patch_js_1 = require("./patch.js");
+const package_json_1 = __importDefault(require("../package.json"));
 async function readStdin() {
     return new Promise((resolve, reject) => {
         let data = "";
@@ -13,20 +18,20 @@ async function readStdin() {
         process.stdin.on("error", reject);
     });
 }
-const program = new Command();
+const program = new commander_1.Command();
 // Configure the CLI
 program
-    .name(Object.keys(packageJson.bin)[0])
-    .description(packageJson.description)
-    .version(packageJson.version);
+    .name(Object.keys(package_json_1.default.bin)[0])
+    .description(package_json_1.default.description)
+    .version(package_json_1.default.version);
 program
     .command("print-map")
     .argument("<path>", "filepath to show identified patchable paths for")
     .argument("[regex]", "limit displayed matches to those matching the supplied regular expression")
     .action(async (path, regex) => {
-    const document = await fs.readFile(path, "utf-8");
-    const documentMap = getDocumentMap(document);
-    printMap(document, documentMap, regex ? new RegExp(regex) : undefined);
+    const document = await promises_1.default.readFile(path, "utf-8");
+    const documentMap = (0, map_js_1.getDocumentMap)(document);
+    (0, debug_js_1.printMap)(document, documentMap, regex ? new RegExp(regex) : undefined);
 });
 program
     .command("patch")
@@ -40,24 +45,24 @@ program
     .action(async (operation, targetType, target, documentPath, options) => {
     let content;
     if (options.input) {
-        content = await fs.readFile(options.input, "utf-8");
+        content = await promises_1.default.readFile(options.input, "utf-8");
     }
     else {
         content = await readStdin();
     }
-    const document = await fs.readFile(documentPath, "utf-8");
+    const document = await promises_1.default.readFile(documentPath, "utf-8");
     const instruction = {
         operation,
         targetType,
         content,
         target: targetType !== "heading" ? target : target.split(options.delimiter),
     };
-    const patchedDocument = applyPatch(document, instruction);
+    const patchedDocument = (0, patch_js_1.applyPatch)(document, instruction);
     if (options.output === "-") {
         process.stdout.write(patchedDocument);
     }
     else {
-        await fs.writeFile(options.output ? options.output : documentPath, patchedDocument);
+        await promises_1.default.writeFile(options.output ? options.output : documentPath, patchedDocument);
     }
 });
 program
@@ -73,7 +78,7 @@ program
             patchData = await readStdin();
         }
         else {
-            patchData = await fs.readFile(patch, "utf-8");
+            patchData = await promises_1.default.readFile(patch, "utf-8");
         }
     }
     catch (e) {
@@ -93,16 +98,16 @@ program
         console.error("Could not parse patch file as JSON");
         process.exit(1);
     }
-    let document = await fs.readFile(path, "utf-8");
+    let document = await promises_1.default.readFile(path, "utf-8");
     console.log("Document", document);
     for (const instruction of patchParsed) {
-        document = applyPatch(document, instruction);
+        document = (0, patch_js_1.applyPatch)(document, instruction);
     }
     if (options.output === "-") {
         process.stdout.write(document);
     }
     else {
-        await fs.writeFile(options.output ? options.output : path, document);
+        await promises_1.default.writeFile(options.output ? options.output : path, document);
     }
 });
 program
@@ -113,14 +118,14 @@ program
     .argument("<target>", "Target ('::'-delimited by default for Headings); see `mdpatch print-map <path to document>` for options)")
     .argument("<documentPath>", "Path to document to query from.")
     .action(async (targetType, target, documentPath, options) => {
-    const document = await fs.readFile(documentPath, "utf-8");
-    const documentMap = getDocumentMap(document);
+    const document = await promises_1.default.readFile(documentPath, "utf-8");
+    const documentMap = (0, map_js_1.getDocumentMap)(document);
     const actualTarget = targetType !== "heading"
         ? target
         : target.split(options.delimiter).join("\u001f");
     const value = document.slice(documentMap[targetType][actualTarget].content.start, documentMap[targetType][actualTarget].content.end);
     if (options.output) {
-        await fs.writeFile(options.output, value);
+        await promises_1.default.writeFile(options.output, value);
     }
     else {
         process.stdout.write(value);

package/dist/constants.js CHANGED Viewed

@@ -1,4 +1,7 @@
-export const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = [
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CAN_INCLUDE_BLOCK_REFERENCE = exports.TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = void 0;
+exports.TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = [
     "code",
     "heading",
     "table",
@@ -7,4 +10,4 @@ export const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = [
     "paragraph",
     "image",
 ];
-export const CAN_INCLUDE_BLOCK_REFERENCE = ["paragraph", "list_item"];
+exports.CAN_INCLUDE_BLOCK_REFERENCE = ["paragraph", "list_item"];

package/dist/debug.js CHANGED Viewed

@@ -1,7 +1,13 @@
-import chalk from "chalk";
-export const printMap = (content, documentMap, regex) => {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printMap = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const printMap = (content, documentMap, regex) => {
     for (const frontmatterField in documentMap.frontmatter) {
-        const blockName = `[${chalk.magenta("frontmatter")}] ${chalk.blueBright(frontmatterField)}`;
+        const blockName = `[${chalk_1.default.magenta("frontmatter")}] ${chalk_1.default.blueBright(frontmatterField)}`;
         console.log("\n" + blockName + "\n");
         console.log(JSON.stringify(documentMap.frontmatter[frontmatterField]));
     }
@@ -12,9 +18,9 @@ export const printMap = (content, documentMap, regex) => {
     for (const type in targetablePositions) {
         for (const positionName in targetablePositions[type]) {
             const position = targetablePositions[type][positionName];
-            const blockName = `[${chalk.magenta(type)}] ${positionName
+            const blockName = `[${chalk_1.default.magenta(type)}] ${positionName
                 .split("\u001f")
-                .map((pos) => chalk.blueBright(pos))
+                .map((pos) => chalk_1.default.blueBright(pos))
                 .join(",")}`;
             if (regex && !blockName.match(regex)) {
                 continue;
@@ -24,13 +30,13 @@ export const printMap = (content, documentMap, regex) => {
                 console.log(content
                     .slice(position.content.start - 100, position.content.start)
                     .replaceAll("\n", "\\n\n") +
-                    chalk.black.bgGreen(content
+                    chalk_1.default.black.bgGreen(content
                         .slice(position.content.start, position.content.end)
                         .replaceAll("\n", "\\n\n")) +
                     content
                         .slice(position.content.end, Math.min(position.content.end + 100, position.marker.start))
                         .replaceAll("\n", "\\n\n") +
-                    chalk.black.bgRed(content
+                    chalk_1.default.black.bgRed(content
                         .slice(position.marker.start, position.marker.end)
                         .replaceAll("\n", "\\n\n")) +
                     content
@@ -41,13 +47,13 @@ export const printMap = (content, documentMap, regex) => {
                 console.log(content
                     .slice(position.marker.start - 100, position.marker.start)
                     .replaceAll("\n", "\\n\n") +
-                    chalk.black.bgRed(content
+                    chalk_1.default.black.bgRed(content
                         .slice(position.marker.start, position.marker.end)
                         .replaceAll("\n", "\\n\n")) +
                     content
                         .slice(position.marker.end, Math.min(position.marker.end + 100, position.content.start))
                         .replaceAll("\n", "\\n\n") +
-                    chalk.black.bgGreen(content
+                    chalk_1.default.black.bgGreen(content
                         .slice(position.content.start, position.content.end)
                         .replaceAll("\n", "\\n\n")) +
                     content
@@ -57,3 +63,4 @@ export const printMap = (content, documentMap, regex) => {
         }
     }
 };
+exports.printMap = printMap;

package/dist/index.d.ts CHANGED Viewed

@@ -2,5 +2,6 @@
  * @module Reference
  */
 export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
+export { getDocumentMap } from "./map.js";
 export * from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,YAAY,CAAC;~~AAEpB~~,cAAc,YAAY,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,cAAc,YAAY,CAAC"}

package/dist/index.js CHANGED Viewed

@@ -1,5 +1,29 @@
+"use strict";
 /**
  * @module Reference
  */
-export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
-export * from "./types.js";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentMap = exports.applyPatch = exports.TablePartsNotFound = exports.PatchError = exports.PatchFailed = exports.PatchFailureReason = void 0;
+var patch_js_1 = require("./patch.js");
+Object.defineProperty(exports, "PatchFailureReason", { enumerable: true, get: function () { return patch_js_1.PatchFailureReason; } });
+Object.defineProperty(exports, "PatchFailed", { enumerable: true, get: function () { return patch_js_1.PatchFailed; } });
+Object.defineProperty(exports, "PatchError", { enumerable: true, get: function () { return patch_js_1.PatchError; } });
+Object.defineProperty(exports, "TablePartsNotFound", { enumerable: true, get: function () { return patch_js_1.TablePartsNotFound; } });
+Object.defineProperty(exports, "applyPatch", { enumerable: true, get: function () { return patch_js_1.applyPatch; } });
+var map_js_1 = require("./map.js");
+Object.defineProperty(exports, "getDocumentMap", { enumerable: true, get: function () { return map_js_1.getDocumentMap; } });
+__exportStar(require("./types.js"), exports);

package/dist/map.js CHANGED Viewed

@@ -1,6 +1,32 @@
-import * as marked from "marked";
-import { parse as parseYaml } from "yaml";
-import { CAN_INCLUDE_BLOCK_REFERENCE, TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE, } from "./constants.js";
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentMap = void 0;
+const marked = __importStar(require("marked"));
+const yaml_1 = require("yaml");
+const constants_js_1 = require("./constants.js");
 function getHeadingPositions(document, tokens, contentOffset) {
     const positions = {
         "": {
@@ -90,7 +116,7 @@ function getBlockPositions(document, tokens, contentOffset) {
             document.slice(endMarker, endMarker + 2) === "\r\n") {
             endMarker += 2;
         }
-        if (CAN_INCLUDE_BLOCK_REFERENCE.includes(token.type) && match) {
+        if (constants_js_1.CAN_INCLUDE_BLOCK_REFERENCE.includes(token.type) && match) {
             const name = match[1];
             if (!name || match.index === undefined) {
                 return;
@@ -115,7 +141,7 @@ function getBlockPositions(document, tokens, contentOffset) {
                 },
             };
         }
-        if (TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE.includes(token.type)) {
+        if (constants_js_1.TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE.includes(token.type)) {
             lastBlockDetails = {
                 token: token,
                 start: startContent,
@@ -134,7 +160,7 @@ function preProcess(document) {
     if (match) {
         const frontmatterText = match[1].trim(); // Captured frontmatter content
         contentOffset = match[0].length; // Length of the entire frontmatter section including delimiters
-        frontmatter = parseYaml(frontmatterText);
+        frontmatter = (0, yaml_1.parse)(frontmatterText);
         content = document.slice(contentOffset);
     }
     else {
@@ -147,7 +173,7 @@ function preProcess(document) {
         frontmatter,
     };
 }
-export const getDocumentMap = (document) => {
+const getDocumentMap = (document) => {
     const { frontmatter, contentOffset, content } = preProcess(document);
     const lexer = new marked.Lexer();
     const tokens = lexer.lex(content);
@@ -160,3 +186,4 @@ export const getDocumentMap = (document) => {
         lineEnding,
     };
 };
+exports.getDocumentMap = getDocumentMap;

package/dist/patch.js CHANGED Viewed

@@ -1,9 +1,35 @@
-import { getDocumentMap } from "./map.js";
-import * as marked from "marked";
-import * as yaml from "yaml";
-import { ContentType } from "./types.js";
-import { isAppendableFrontmatterType, isDictionary, isList, isString, isStringArrayArray, } from "./typeGuards.js";
-export var PatchFailureReason;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyPatch = exports.TablePartsNotFound = exports.MergeNotPossible = exports.PatchError = exports.PatchFailed = exports.PatchFailureReason = void 0;
+const map_js_1 = require("./map.js");
+const marked = __importStar(require("marked"));
+const yaml = __importStar(require("yaml"));
+const types_js_1 = require("./types.js");
+const typeGuards_js_1 = require("./typeGuards.js");
+var PatchFailureReason;
 (function (PatchFailureReason) {
     PatchFailureReason["InvalidTarget"] = "invalid-target";
     PatchFailureReason["ContentAlreadyPreexistsInTarget"] = "content-already-preexists-in-target";
@@ -11,8 +37,8 @@ export var PatchFailureReason;
     PatchFailureReason["ContentTypeInvalid"] = "content-type-invalid";
     PatchFailureReason["ContentTypeInvalidForTarget"] = "content-type-invalid-for-target";
     PatchFailureReason["ContentNotMergeable"] = "content-not-mergeable";
-})(PatchFailureReason || (PatchFailureReason = {}));
-export class PatchFailed extends Error {
+})(PatchFailureReason || (exports.PatchFailureReason = PatchFailureReason = {}));
+class PatchFailed extends Error {
     constructor(reason, instruction, targetMap) {
         super();
         this.reason = reason;
@@ -22,10 +48,13 @@ export class PatchFailed extends Error {
         Object.setPrototypeOf(this, new.target.prototype);
     }
 }
-export class PatchError extends Error {
+exports.PatchFailed = PatchFailed;
+class PatchError extends Error {
 }
-export class MergeNotPossible extends Error {
+exports.PatchError = PatchError;
+class MergeNotPossible extends Error {
 }
+exports.MergeNotPossible = MergeNotPossible;
 const replaceText = (document, instruction, target) => {
     return [
         document.slice(0, target.content.start),
@@ -51,8 +80,9 @@ const appendText = (document, instruction, target) => {
         document.slice(target.content.end),
     ].join("");
 };
-export class TablePartsNotFound extends Error {
+class TablePartsNotFound extends Error {
 }
+exports.TablePartsNotFound = TablePartsNotFound;
 const _getTableData = (document, target) => {
     const targetTable = document.slice(target.content.start, target.content.end);
     const tableToken = marked.lexer(targetTable)[0];
@@ -72,7 +102,7 @@ const replaceTable = (document, instruction, target) => {
     try {
         const table = _getTableData(document, target);
         const tableRows = [table.headerParts];
-        if (isStringArrayArray(instruction.content)) {
+        if ((0, typeGuards_js_1.isStringArrayArray)(instruction.content)) {
             for (const row of instruction.content) {
                 if (row.length !== table.token.header.length ||
                     typeof row === "string") {
@@ -98,7 +128,7 @@ const prependTable = (document, instruction, target) => {
     try {
         const table = _getTableData(document, target);
         const tableRows = [table.headerParts];
-        if (isStringArrayArray(instruction.content)) {
+        if ((0, typeGuards_js_1.isStringArrayArray)(instruction.content)) {
             for (const row of instruction.content) {
                 if (row.length !== table.token.header.length ||
                     typeof row === "string") {
@@ -125,7 +155,7 @@ const appendTable = (document, instruction, target) => {
     try {
         const table = _getTableData(document, target);
         const tableRows = [table.headerParts, table.contentParts];
-        if (isStringArrayArray(instruction.content)) {
+        if ((0, typeGuards_js_1.isStringArrayArray)(instruction.content)) {
             for (const row of instruction.content) {
                 if (row.length !== table.token.header.length ||
                     typeof row === "string") {
@@ -150,33 +180,33 @@ const appendTable = (document, instruction, target) => {
 const replace = (document, instruction, target) => {
     const contentType = "contentType" in instruction && instruction.contentType
         ? instruction.contentType
-        : ContentType.text;
+        : types_js_1.ContentType.text;
     switch (contentType) {
-        case ContentType.text:
+        case types_js_1.ContentType.text:
             return replaceText(document, instruction, target);
-        case ContentType.json:
+        case types_js_1.ContentType.json:
             return replaceTable(document, instruction, target);
     }
 };
 const prepend = (document, instruction, target) => {
     const contentType = "contentType" in instruction && instruction.contentType
         ? instruction.contentType
-        : ContentType.text;
+        : types_js_1.ContentType.text;
     switch (contentType) {
-        case ContentType.text:
+        case types_js_1.ContentType.text:
             return prependText(document, instruction, target);
-        case ContentType.json:
+        case types_js_1.ContentType.json:
             return prependTable(document, instruction, target);
     }
 };
 const append = (document, instruction, target) => {
     const contentType = "contentType" in instruction && instruction.contentType
         ? instruction.contentType
-        : ContentType.text;
+        : types_js_1.ContentType.text;
     switch (contentType) {
-        case ContentType.text:
+        case types_js_1.ContentType.text:
             return appendText(document, instruction, target);
-        case ContentType.json:
+        case types_js_1.ContentType.json:
             return appendTable(document, instruction, target);
     }
 };
@@ -237,13 +267,13 @@ const getTarget = (map, instruction) => {
     }
 };
 function mergeFrontmatterValue(obj1, obj2) {
-    if (isList(obj1) && isList(obj2)) {
+    if ((0, typeGuards_js_1.isList)(obj1) && (0, typeGuards_js_1.isList)(obj2)) {
         return [...obj1, ...obj2];
     }
-    else if (isDictionary(obj1) && isDictionary(obj2)) {
+    else if ((0, typeGuards_js_1.isDictionary)(obj1) && (0, typeGuards_js_1.isDictionary)(obj2)) {
         return { ...obj1, ...obj2 };
     }
-    else if (isString(obj1) && isString(obj2)) {
+    else if ((0, typeGuards_js_1.isString)(obj1) && (0, typeGuards_js_1.isString)(obj2)) {
         return obj1 + obj2;
     }
     throw new Error(`Cannot merge objects of different types or unsupported types: ${typeof obj1} and ${typeof obj2}`);
@@ -265,8 +295,8 @@ function regenerateDocumentWithFrontmatter(frontmatter, document, map) {
  * @param instruction The patch to apply.
  * @returns The patched document
  */
-export const applyPatch = (document, instruction) => {
-    const map = getDocumentMap(document);
+const applyPatch = (document, instruction) => {
+    const map = (0, map_js_1.getDocumentMap)(document);
     const target = getTarget(map, instruction);
     if (instruction.targetType === "block" ||
         instruction.targetType === "heading") {
@@ -300,13 +330,13 @@ export const applyPatch = (document, instruction) => {
     const frontmatter = { ...map.frontmatter };
     if (frontmatter[instruction.target] === undefined) {
         if (instruction.createTargetIfMissing) {
-            if (isList(instruction.content)) {
+            if ((0, typeGuards_js_1.isList)(instruction.content)) {
                 frontmatter[instruction.target] = [];
             }
-            else if (isString(instruction.content)) {
+            else if ((0, typeGuards_js_1.isString)(instruction.content)) {
                 frontmatter[instruction.target] = "";
             }
-            else if (isDictionary(instruction.content)) {
+            else if ((0, typeGuards_js_1.isDictionary)(instruction.content)) {
                 frontmatter[instruction.target] = {};
             }
         }
@@ -317,13 +347,13 @@ export const applyPatch = (document, instruction) => {
     try {
         switch (instruction.operation) {
             case "append":
-                if (!isAppendableFrontmatterType(instruction.content)) {
+                if (!(0, typeGuards_js_1.isAppendableFrontmatterType)(instruction.content)) {
                     throw new MergeNotPossible();
                 }
                 frontmatter[instruction.target] = mergeFrontmatterValue(frontmatter[instruction.target], instruction.content);
                 break;
             case "prepend":
-                if (!isAppendableFrontmatterType(instruction.content)) {
+                if (!(0, typeGuards_js_1.isAppendableFrontmatterType)(instruction.content)) {
                     throw new MergeNotPossible();
                 }
                 frontmatter[instruction.target] = mergeFrontmatterValue(instruction.content, frontmatter[instruction.target]);
@@ -341,3 +371,4 @@ export const applyPatch = (document, instruction) => {
         throw error;
     }
 };
+exports.applyPatch = applyPatch;

package/dist/tests/map.test.js CHANGED Viewed

@@ -1,10 +1,15 @@
-import fs from "fs";
-import path from "path";
-import { getDocumentMap } from "../map";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const map_1 = require("../map");
 describe("map", () => {
-    const sample = fs.readFileSync(path.join(__dirname, "sample.md"), "utf-8");
+    const sample = fs_1.default.readFileSync(path_1.default.join(__dirname, "sample.md"), "utf-8");
     test("heading", () => {
-        const actualHeadings = getDocumentMap(sample).heading;
+        const actualHeadings = (0, map_1.getDocumentMap)(sample).heading;
         const expectedHeadings = {
             "": {
                 content: {
@@ -143,7 +148,7 @@ describe("map", () => {
         expect(actualHeadings).toEqual(expectedHeadings);
     });
     test("block", () => {
-        const actualBlocks = getDocumentMap(sample).block;
+        const actualBlocks = (0, map_1.getDocumentMap)(sample).block;
         const expectedBlocks = {
             "2c67a6": {
                 content: {
@@ -201,7 +206,7 @@ describe("map", () => {
     });
     describe("frontmatter", () => {
         test("exists", () => {
-            const actualFrontmatter = getDocumentMap(sample).frontmatter;
+            const actualFrontmatter = (0, map_1.getDocumentMap)(sample).frontmatter;
             const expectedFrontmatter = {
                 aliases: ["Structured Markdown Patch"],
                 "project-type": "Technical",
@@ -210,14 +215,14 @@ describe("map", () => {
             expect(expectedFrontmatter).toEqual(actualFrontmatter);
         });
         test("does not exist", () => {
-            const sample = fs.readFileSync(path.join(__dirname, "sample.frontmatter.none.md"), "utf-8");
-            const actualFrontmatter = getDocumentMap(sample).frontmatter;
+            const sample = fs_1.default.readFileSync(path_1.default.join(__dirname, "sample.frontmatter.none.md"), "utf-8");
+            const actualFrontmatter = (0, map_1.getDocumentMap)(sample).frontmatter;
             const expectedFrontmatter = {};
             expect(expectedFrontmatter).toEqual(actualFrontmatter);
         });
         test("does not exist, but starts with hr", () => {
-            const sample = fs.readFileSync(path.join(__dirname, "sample.frontmatter.nonfrontmatter-hr.md"), "utf-8");
-            const actualFrontmatter = getDocumentMap(sample).frontmatter;
+            const sample = fs_1.default.readFileSync(path_1.default.join(__dirname, "sample.frontmatter.nonfrontmatter-hr.md"), "utf-8");
+            const actualFrontmatter = (0, map_1.getDocumentMap)(sample).frontmatter;
             const expectedFrontmatter = {};
             expect(expectedFrontmatter).toEqual(actualFrontmatter);
         });

package/dist/tests/patch.test.js CHANGED Viewed

@@ -1,13 +1,18 @@
-import fs from "fs";
-import path from "path";
-import { applyPatch, PatchFailed } from "../patch";
-import { ContentType } from "../types";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const patch_1 = require("../patch");
+const types_1 = require("../types");
 describe("patch", () => {
-    const sample = fs.readFileSync(path.join(__dirname, "sample.md"), "utf-8");
+    const sample = fs_1.default.readFileSync(path_1.default.join(__dirname, "sample.md"), "utf-8");
     const assertPatchResultsMatch = (inputDocumentPath, outputDocumentPath, instruction) => {
-        const inputDocument = fs.readFileSync(path.join(__dirname, inputDocumentPath), "utf-8");
-        const outputDocument = fs.readFileSync(path.join(__dirname, outputDocumentPath), "utf-8");
-        expect(applyPatch(inputDocument, instruction)).toEqual(outputDocument);
+        const inputDocument = fs_1.default.readFileSync(path_1.default.join(__dirname, inputDocumentPath), "utf-8");
+        const outputDocument = fs_1.default.readFileSync(path_1.default.join(__dirname, outputDocumentPath), "utf-8");
+        expect((0, patch_1.applyPatch)(inputDocument, instruction)).toEqual(outputDocument);
     };
     describe("heading", () => {
         test("prepend", () => {
@@ -117,8 +122,8 @@ describe("patch", () => {
                             // applyIfContentPreexists: false,  # default
                         };
                         expect(() => {
-                            applyPatch(sample, instruction);
-                        }).toThrow(PatchFailed);
+                            (0, patch_1.applyPatch)(sample, instruction);
+                        }).toThrow(patch_1.PatchFailed);
                     });
                     test("does not preexist at target", () => {
                         const instruction = {
@@ -129,8 +134,8 @@ describe("patch", () => {
                             // applyIfContentPreexists: false,  # default
                         };
                         expect(() => {
-                            applyPatch(sample, instruction);
-                        }).not.toThrow(PatchFailed);
+                            (0, patch_1.applyPatch)(sample, instruction);
+                        }).not.toThrow(patch_1.PatchFailed);
                     });
                 });
             });
@@ -145,8 +150,8 @@ describe("patch", () => {
                             applyIfContentPreexists: true,
                         };
                         expect(() => {
-                            applyPatch(sample, instruction);
-                        }).not.toThrow(PatchFailed);
+                            (0, patch_1.applyPatch)(sample, instruction);
+                        }).not.toThrow(patch_1.PatchFailed);
                     });
                 });
             });
@@ -187,7 +192,7 @@ describe("patch", () => {
                         targetType: "block",
                         target: "2c67a6",
                         operation: "prepend",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],
@@ -199,7 +204,7 @@ describe("patch", () => {
                         targetType: "block",
                         target: "2c67a6",
                         operation: "append",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],
@@ -211,7 +216,7 @@ describe("patch", () => {
                         targetType: "block",
                         target: "2c67a6",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],
@@ -228,31 +233,31 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "append",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: "OK",
                 };
                 expect(() => {
-                    applyPatch(sample, instruction);
-                }).toThrow(PatchFailed);
+                    (0, patch_1.applyPatch)(sample, instruction);
+                }).toThrow(patch_1.PatchFailed);
             });
             test("invalid type", () => {
                 const instruction = {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "append",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: 10,
                 };
                 expect(() => {
-                    applyPatch(sample, instruction);
-                }).toThrow(PatchFailed);
+                    (0, patch_1.applyPatch)(sample, instruction);
+                }).toThrow(patch_1.PatchFailed);
             });
             test("list", () => {
                 const instruction = {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "append",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: ["Beep"],
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.append.list.md", instruction);
@@ -262,7 +267,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "object-value",
                     operation: "append",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: { three: "Beep" },
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.append.dictionary.md", instruction);
@@ -272,7 +277,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "string-value",
                     operation: "append",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: "Beep",
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.append.string.md", instruction);
@@ -284,31 +289,31 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "prepend",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: "OK",
                 };
                 expect(() => {
-                    applyPatch(sample, instruction);
-                }).toThrow(PatchFailed);
+                    (0, patch_1.applyPatch)(sample, instruction);
+                }).toThrow(patch_1.PatchFailed);
             });
             test("invalid type", () => {
                 const instruction = {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "prepend",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: 10,
                 };
                 expect(() => {
-                    applyPatch(sample, instruction);
-                }).toThrow(PatchFailed);
+                    (0, patch_1.applyPatch)(sample, instruction);
+                }).toThrow(patch_1.PatchFailed);
             });
             test("list", () => {
                 const instruction = {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "prepend",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: ["Beep"],
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.prepend.list.md", instruction);
@@ -318,7 +323,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "object-value",
                     operation: "prepend",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: { three: "Beep" },
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.prepend.dictionary.md", instruction);
@@ -328,7 +333,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "string-value",
                     operation: "prepend",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: "Beep",
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.prepend.string.md", instruction);
@@ -340,7 +345,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "array-value",
                     operation: "replace",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: ["Replaced"],
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.replace.list.md", instruction);
@@ -350,7 +355,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "object-value",
                     operation: "replace",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: {
                         replaced: true,
                     },
@@ -362,7 +367,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "string-value",
                     operation: "replace",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: "Replaced",
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.replace.string.md", instruction);
@@ -372,7 +377,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "number-value",
                     operation: "replace",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: 10,
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.replace.number.md", instruction);
@@ -382,7 +387,7 @@ describe("patch", () => {
                     targetType: "frontmatter",
                     target: "boolean-value",
                     operation: "replace",
-                    contentType: ContentType.json,
+                    contentType: types_1.ContentType.json,
                     content: true,
                 };
                 assertPatchResultsMatch("sample.frontmatter.md", "sample.patch.frontmatter.replace.boolean.md", instruction);
@@ -393,7 +398,7 @@ describe("patch", () => {
                         targetType: "frontmatter",
                         target: "new-field",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: ["New Value"],
                         createTargetIfMissing: true,
                     };
@@ -404,7 +409,7 @@ describe("patch", () => {
                         targetType: "frontmatter",
                         target: "new-field",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: {
                             newValue: true,
                         },
@@ -417,7 +422,7 @@ describe("patch", () => {
                         targetType: "frontmatter",
                         target: "new-field",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: "New Value",
                         createTargetIfMissing: true,
                     };
@@ -428,7 +433,7 @@ describe("patch", () => {
                         targetType: "frontmatter",
                         target: "new-field",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: 588600,
                         createTargetIfMissing: true,
                     };
@@ -439,7 +444,7 @@ describe("patch", () => {
                         targetType: "frontmatter",
                         target: "new-field",
                         operation: "replace",
-                        contentType: ContentType.json,
+                        contentType: types_1.ContentType.json,
                         content: true,
                         createTargetIfMissing: true,
                     };

package/dist/typeGuards.js CHANGED Viewed

@@ -1,4 +1,11 @@
-export function isStringArrayArray(obj) {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStringArrayArray = isStringArrayArray;
+exports.isAppendableFrontmatterType = isAppendableFrontmatterType;
+exports.isString = isString;
+exports.isDictionary = isDictionary;
+exports.isList = isList;
+function isStringArrayArray(obj) {
     // Check if the object is an array
     if (!Array.isArray(obj))
         return false;
@@ -6,15 +13,15 @@ export function isStringArrayArray(obj) {
     return obj.every((item) => Array.isArray(item) &&
         item.every((subItem) => typeof subItem === "string"));
 }
-export function isAppendableFrontmatterType(obj) {
+function isAppendableFrontmatterType(obj) {
     return isString(obj) || isDictionary(obj) || isList(obj);
 }
-export function isString(obj) {
+function isString(obj) {
     return typeof obj === "string";
 }
-export function isDictionary(obj) {
+function isDictionary(obj) {
     return typeof obj === "object" && obj !== null && !Array.isArray(obj);
 }
-export function isList(obj) {
+function isList(obj) {
     return Array.isArray(obj);
 }

package/dist/types.js CHANGED Viewed

@@ -1,4 +1,7 @@
-export var ContentType;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentType = void 0;
+var ContentType;
 (function (ContentType) {
     /**
      * Content is simple markdown text.
@@ -8,4 +11,4 @@ export var ContentType;
      * Content is a JSON document
      */
     ContentType["json"] = "application/json";
-})(ContentType || (ContentType = {}));
+})(ContentType || (exports.ContentType = ContentType = {}));

package/package.json CHANGED Viewed

@@ -19,7 +19,7 @@
     "typescript": "^5.5.4"
   },
   "name": "markdown-patch",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "main": "./dist/index.js",
   "scripts": {
     "build": "tsc",