markdown-patch 0.1.2 → 0.1.3

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE: string[];
+export declare const CAN_INCLUDE_BLOCK_REFERENCE: string[];
+export declare enum ContentType {
+    text = "text/plain",
+    tableRows = "application/vnd.markdown-patch.table-rows+json"
+}
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sCAAsC,UAQlD,CAAC;AAEF,eAAO,MAAM,2BAA2B,UAA6B,CAAC;AAEtE,oBAAY,WAAW;IACrB,IAAI,eAAe;IACnB,SAAS,mDAAmD;CAC7D"}

package/dist/constants.js

@@ -8,3 +8,8 @@ export const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = [
     "image",
 ];
 export const CAN_INCLUDE_BLOCK_REFERENCE = ["paragraph", "list_item"];
+export var ContentType;
+(function (ContentType) {
+    ContentType["text"] = "text/plain";
+    ContentType["tableRows"] = "application/vnd.markdown-patch.table-rows+json";
+})(ContentType || (ContentType = {}));

package/dist/debug.d.ts

@@ -0,0 +1,3 @@
+import { DocumentMap } from "./types.js";
+export declare const printMap: (content: string, documentMap: DocumentMap, regex: RegExp | undefined) => void;
+//# sourceMappingURL=debug.d.ts.map

package/dist/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,eAAO,MAAM,QAAQ,YACV,MAAM,eACF,WAAW,SACjB,MAAM,GAAG,SAAS,KACxB,IAmEF,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
+export * from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -1 +1,2 @@
+export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
 export * from "./types.js";

package/dist/map.d.ts

@@ -0,0 +1,3 @@
+import { DocumentMap } from "./types.js";
+export declare const getDocumentMap: (document: string) => DocumentMap;
+//# sourceMappingURL=map.d.ts.map

package/dist/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../src/map.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EAGZ,MAAM,YAAY,CAAC;AAyLpB,eAAO,MAAM,cAAc,aAAc,MAAM,KAAG,WAQjD,CAAC"}

package/dist/patch.d.ts

@@ -0,0 +1,19 @@
+import { DocumentMapMarkerContentPair, PatchInstruction } from "./types.js";
+export declare enum PatchFailureReason {
+    InvalidTarget = "invalid-target",
+    ContentAlreadyPreexistsInTarget = "content-already-preexists-in-target",
+    TableContentIncorrectColumnCount = "table-content-incorrect-column-count",
+    RequestedBlockTypeBehaviorUnavailable = "requested-block-type-behavior-unavailable"
+}
+export declare class PatchFailed extends Error {
+    reason: PatchFailureReason;
+    instruction: PatchInstruction;
+    targetMap: DocumentMapMarkerContentPair | null;
+    constructor(reason: PatchFailureReason, instruction: PatchInstruction, targetMap: DocumentMapMarkerContentPair | null);
+}
+export declare class PatchError extends Error {
+}
+export declare class TablePartsNotFound extends Error {
+}
+export declare const applyPatch: (document: string, instruction: PatchInstruction) => string;
+//# sourceMappingURL=patch.d.ts.map

package/dist/patch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,4BAA4B,EAE5B,gBAAgB,EAEjB,MAAM,YAAY,CAAC;AAGpB,oBAAY,kBAAkB;IAC5B,aAAa,mBAAmB;IAChC,+BAA+B,wCAAwC;IACvE,gCAAgC,yCAAyC;IACzE,qCAAqC,8CAA8C;CACpF;AAED,qBAAa,WAAY,SAAQ,KAAK;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,GAAG,IAAI,CAAC;gBAGpD,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EAAE,gBAAgB,EAC7B,SAAS,EAAE,4BAA4B,GAAG,IAAI;CAUjD;AAED,qBAAa,UAAW,SAAQ,KAAK;CAAG;AA0CxC,qBAAa,kBAAmB,SAAQ,KAAK;CAAG;AAmNhD,eAAO,MAAM,UAAU,aACX,MAAM,eACH,gBAAgB,KAC5B,MA8BF,CAAC"}

package/dist/patch.js

@@ -1,5 +1,6 @@
 import { getDocumentMap } from "./map.js";
 import * as marked from "marked";
+import { ContentType } from "./constants.js";
 export var PatchFailureReason;
 (function (PatchFailureReason) {
     PatchFailureReason["InvalidTarget"] = "invalid-target";
@@ -123,38 +124,35 @@ const appendTable = (document, instruction, target) => {
     }
 };
 const replace = (document, instruction, target) => {
-    const targetBlockTypeBehavior = "targetBlockTypeBehavior" in instruction &&
-        instruction.targetBlockTypeBehavior
-        ? instruction.targetBlockTypeBehavior
-        : "text";
-    switch (targetBlockTypeBehavior) {
-        case "text":
+    const contentType = "contentType" in instruction && instruction.contentType
+        ? instruction.contentType
+        : ContentType.text;
+    switch (contentType) {
+        case ContentType.text:
             return replaceText(document, instruction, target);
-        case "table":
+        case ContentType.tableRows:
             return replaceTable(document, instruction, target);
     }
 };
 const prepend = (document, instruction, target) => {
-    const targetBlockTypeBehavior = "targetBlockTypeBehavior" in instruction &&
-        instruction.targetBlockTypeBehavior
-        ? instruction.targetBlockTypeBehavior
-        : "text";
-    switch (targetBlockTypeBehavior) {
-        case "text":
+    const contentType = "contentType" in instruction && instruction.contentType
+        ? instruction.contentType
+        : ContentType.text;
+    switch (contentType) {
+        case ContentType.text:
             return prependText(document, instruction, target);
-        case "table":
+        case ContentType.tableRows:
             return prependTable(document, instruction, target);
     }
 };
 const append = (document, instruction, target) => {
-    const targetBlockTypeBehavior = "targetBlockTypeBehavior" in instruction &&
-        instruction.targetBlockTypeBehavior
-        ? instruction.targetBlockTypeBehavior
-        : "text";
-    switch (targetBlockTypeBehavior) {
-        case "text":
+    const contentType = "contentType" in instruction && instruction.contentType
+        ? instruction.contentType
+        : ContentType.text;
+    switch (contentType) {
+        case ContentType.text:
             return appendText(document, instruction, target);
-        case "table":
+        case ContentType.tableRows:
             return appendTable(document, instruction, target);
     }
 };

package/dist/tests/map.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=map.test.d.ts.map

package/dist/tests/map.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.test.d.ts","sourceRoot":"","sources":["../../src/tests/map.test.ts"],"names":[],"mappings":""}

package/dist/tests/patch.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=patch.test.d.ts.map

package/dist/tests/patch.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.test.d.ts","sourceRoot":"","sources":["../../src/tests/patch.test.ts"],"names":[],"mappings":""}

package/dist/tests/patch.test.js

@@ -1,6 +1,7 @@
 import fs from "fs";
 import path from "path";
 import { applyPatch, PatchFailed } from "../patch";
+import { ContentType } from "../constants";
 describe("patch", () => {
     const sample = fs.readFileSync(path.join(__dirname, "sample.md"), "utf-8");
     describe("heading", () => {
@@ -178,9 +179,9 @@ describe("patch", () => {
                     const expected = fs.readFileSync(path.join(__dirname, "sample.patch.block.targetBlockTypeBehavior.table.prepend.md"), "utf-8");
                     const instruction = {
                         targetType: "block",
-                        targetBlockTypeBehavior: "table",
                         target: "2c67a6",
                         operation: "prepend",
+                        contentType: ContentType.tableRows,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],
@@ -192,9 +193,9 @@ describe("patch", () => {
                     const expected = fs.readFileSync(path.join(__dirname, "sample.patch.block.targetBlockTypeBehavior.table.append.md"), "utf-8");
                     const instruction = {
                         targetType: "block",
-                        targetBlockTypeBehavior: "table",
                         target: "2c67a6",
                         operation: "append",
+                        contentType: ContentType.tableRows,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],
@@ -206,9 +207,9 @@ describe("patch", () => {
                     const expected = fs.readFileSync(path.join(__dirname, "sample.patch.block.targetBlockTypeBehavior.table.replace.md"), "utf-8");
                     const instruction = {
                         targetType: "block",
-                        targetBlockTypeBehavior: "table",
                         target: "2c67a6",
                         operation: "replace",
+                        contentType: ContentType.tableRows,
                         content: [
                             ["`something else`", "Some other application", "✅", "✅", "✅"],
                         ],

package/dist/types.d.ts

@@ -0,0 +1,95 @@
+import { ContentType } from "./constants";
+export interface DocumentRange {
+    start: number;
+    end: number;
+}
+export interface DocumentMapMarkerContentPair {
+    marker: DocumentRange;
+    content: DocumentRange;
+}
+export interface HeadingMarkerContentPair extends DocumentMapMarkerContentPair {
+    level: number;
+}
+export interface DocumentMap {
+    heading: Record<string, HeadingMarkerContentPair>;
+    block: Record<string, DocumentMapMarkerContentPair>;
+}
+export type PatchTargetType = "heading" | "block";
+export type PatchOperation = "replace" | "prepend" | "append";
+export interface BasePatchInstructionTarget {
+    targetType: PatchTargetType;
+    target: any;
+}
+export interface BasePatchInstructionOperation {
+    operation: string;
+}
+export interface BaseHeadingPatchInstruction extends BasePatchInstructionTarget {
+    targetType: "heading";
+    target: string[] | null;
+}
+export interface BaseBlockPatchInstruction extends BasePatchInstructionTarget {
+    targetType: "block";
+    target: string;
+}
+export interface NonExtendingPatchInstruction extends BasePatchInstructionOperation {
+}
+export interface ExtendingPatchInstruction extends BasePatchInstructionOperation {
+    /** Trim whitepsace from target before joining with content
+     *
+     * - For `prepend`: Trims content from the beginning of
+     *   the target content.
+     * - For `append`: Trims content from the end of the target
+     *   content.  Your content should probably end in a newline
+     *   in this case, or the trailing heading will no longer
+     *   be the start of its own line
+     */
+    trimTargetWhitespace?: boolean;
+    /** Apply patch even if content already exists at target
+     *
+     * By default, we will fail to apply a patch if the supplied
+     * content is found anywhere in your target content.  If you
+     * would instead like the patch to occur, regardless of whether
+     * it appears the content is already there, you can set
+     * `applyIfContentPreexists` to `true`.
+     */
+    applyIfContentPreexists?: boolean;
+}
+export interface StringContent {
+    contentType?: ContentType.text;
+    content: string;
+}
+export interface TableRowsContent {
+    contentType: ContentType.tableRows;
+    content: string[][];
+}
+export interface PrependHeadingPatchInstruction extends ExtendingPatchInstruction, BaseHeadingPatchInstruction, StringContent {
+    operation: "prepend";
+}
+export interface AppendHeadingPatchInstruction extends ExtendingPatchInstruction, BaseHeadingPatchInstruction, StringContent {
+    operation: "append";
+}
+export interface ReplaceHeadingPatchInstruction extends NonExtendingPatchInstruction, BaseHeadingPatchInstruction, StringContent {
+    operation: "replace";
+}
+export interface PrependBlockPatchInstruction extends ExtendingPatchInstruction, BaseBlockPatchInstruction, StringContent {
+    operation: "prepend";
+}
+export interface AppendBlockPatchInstruction extends ExtendingPatchInstruction, BaseBlockPatchInstruction, StringContent {
+    operation: "append";
+}
+export interface ReplaceBlockPatchInstruction extends NonExtendingPatchInstruction, BaseBlockPatchInstruction, StringContent {
+    operation: "replace";
+}
+export interface PrependTableRowsBlockPatchInstruction extends ExtendingPatchInstruction, BaseBlockPatchInstruction, TableRowsContent {
+    operation: "prepend";
+}
+export interface AppendTableRowsBlockPatchInstruction extends ExtendingPatchInstruction, BaseBlockPatchInstruction, TableRowsContent {
+    operation: "append";
+}
+export interface ReplaceTableRowsBlockPatchInstruction extends NonExtendingPatchInstruction, BaseBlockPatchInstruction, TableRowsContent {
+    operation: "replace";
+}
+export type HeadingPatchInstruction = PrependHeadingPatchInstruction | AppendHeadingPatchInstruction | ReplaceHeadingPatchInstruction;
+export type BlockPatchInstruction = PrependBlockPatchInstruction | AppendBlockPatchInstruction | ReplaceBlockPatchInstruction | PrependTableRowsBlockPatchInstruction | AppendTableRowsBlockPatchInstruction | ReplaceTableRowsBlockPatchInstruction;
+export type PatchInstruction = HeadingPatchInstruction | BlockPatchInstruction;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,wBAAyB,SAAQ,4BAA4B;IAC5E,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAClD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,CAAC;AAElD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE9D,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,eAAe,CAAC;IAC5B,MAAM,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BACf,SAAQ,0BAA0B;IAClC,UAAU,EAAE,SAAS,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,4BACf,SAAQ,6BAA6B;CAAG;AAE1C,MAAM,WAAW,yBACf,SAAQ,6BAA6B;IACrC;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC;IACnC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,8BACf,SAAQ,yBAAyB,EAC/B,2BAA2B,EAC3B,aAAa;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,6BACf,SAAQ,yBAAyB,EAC/B,2BAA2B,EAC3B,aAAa;IACf,SAAS,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,8BACf,SAAQ,4BAA4B,EAClC,2BAA2B,EAC3B,aAAa;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,4BACf,SAAQ,yBAAyB,EAC/B,yBAAyB,EACzB,aAAa;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,2BACf,SAAQ,yBAAyB,EAC/B,yBAAyB,EACzB,aAAa;IACf,SAAS,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,4BACf,SAAQ,4BAA4B,EAClC,yBAAyB,EACzB,aAAa;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,qCACf,SAAQ,yBAAyB,EAC/B,yBAAyB,EACzB,gBAAgB;IAClB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,oCACf,SAAQ,yBAAyB,EAC/B,yBAAyB,EACzB,gBAAgB;IAClB,SAAS,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,qCACf,SAAQ,4BAA4B,EAClC,yBAAyB,EACzB,gBAAgB;IAClB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,GAC7B,8BAA8B,CAAC;AAEnC,MAAM,MAAM,qBAAqB,GAC7B,4BAA4B,GAC5B,2BAA2B,GAC3B,4BAA4B,GAC5B,qCAAqC,GACrC,oCAAoC,GACpC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,gBAAgB,GAAG,uBAAuB,GAAG,qBAAqB,CAAC"}

package/package.json

@@ -15,11 +15,11 @@
     "typescript": "^5.5.4"
   },
   "name": "markdown-patch",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "main": "./dist/index.js",
   "scripts": {
     "build": "npx tsc",
-    "test": "node node_modules/.bin/jest"
+    "test": "npx jest"
   },
   "bin": {
     "mdpatch": "./dist/cli.js"
@@ -32,5 +32,20 @@
   "files": [
     "dist/",
     "README.md"
-  ]
+  ],
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "/dist/"
+    ],
+    "transform": {
+      "^.+\\.ts$": ["ts-jest", {"useESM": true}]
+    },
+    "extensionsToTreatAsEsm": [".ts"],
+    "moduleNameMapper": {
+    	"^(\\.{1,2}/.*)\\.js$": "$1"
+  	}
+  }
 }