remark-docx 0.3.8 → 0.3.10

package/lib/types.d.ts

@@ -1,5 +1,5 @@
-import type { Paragraph, ParagraphChild, Table, TableOfContents } from "docx";
-import type * as mdast from "./mdast";
+import type { ILevelsOptions, Paragraph, ParagraphChild, Table, TableOfContents } from "docx";
+import type * as mdast from "mdast";
 import type { GetDefinition } from "mdast-util-definitions";
 export type DocxChild = Paragraph | Table | TableOfContents;
 export type DocxContent = DocxChild | ParagraphChild;
@@ -7,11 +7,48 @@ type KnownNodeType = mdast.RootContent["type"];
 type MdastNode<T extends string> = T extends KnownNodeType ? Extract<mdast.RootContent, {
     type: T;
 }> : unknown;
-export type NodeOverrides = {
-    [K in KnownNodeType]?: (node: MdastNode<K>, next: (node: mdast.RootContent[]) => DocxContent[]) => DocxContent | DocxContent[] | null;
+type Decoration = Readonly<{
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+}>;
+type ListInfo = Readonly<{
+    level: number;
+    ordered: boolean;
+    reference: string;
+    checked?: boolean;
+}>;
+export type FootnoteRegistry = {
+    ref: (id: string) => number;
+    def: (id: string, children: Paragraph[]) => void;
+    toConfig: () => {
+        [key: string]: {
+            children: Paragraph[];
+        };
+    };
+};
+export type NumberingRegistry = {
+    create: () => string;
+    toConfig: () => Array<{
+        reference: string;
+        levels: ILevelsOptions[];
+    }>;
+};
+export type Context = Readonly<{
+    next: (node: readonly mdast.RootContent[], ctx?: Context) => DocxContent[];
+    deco: Decoration;
+    indent: number;
+    list?: ListInfo;
+    definition: GetDefinition;
+    footnote: FootnoteRegistry;
+    numbering: NumberingRegistry;
+}>;
+export type NodeBuilder<T extends string> = (node: MdastNode<T>, ctx: Context) => DocxContent | DocxContent[] | null;
+export type NodeBuilders = {
+    [K in KnownNodeType]?: NodeBuilder<K>;
 };
 export type RemarkDocxPlugin = (ctx: Readonly<{
     root: mdast.Root;
     definition: GetDefinition;
-}>) => Promise<NodeOverrides>;
+}>) => Promise<NodeBuilders>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-docx",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "remark plugin to compile markdown to docx (Microsoft Word, Office Open XML).",
   "main": "lib/index.cjs",
   "module": "lib/index.js",

package/lib/mdast.d.ts

@@ -1,2 +0,0 @@
-export type * from "mdast";
-export type * from "mdast-util-math";

package/lib/utils-40yKzkXT.js

@@ -1,19 +0,0 @@
-/**
- * @internal
- */
-function invariant(cond, message) {
-    throw new Error(message);
-}
-const alreadyWarned = {};
-/**
- * @internal
- */
-function warnOnce(message, cond = false) {
-    if (!cond && !alreadyWarned[message]) {
-        alreadyWarned[message] = true;
-        console.warn(message);
-    }
-}
-
-export { invariant as i, warnOnce as w };
-//# sourceMappingURL=utils-40yKzkXT.js.map

package/lib/utils-40yKzkXT.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils-40yKzkXT.js","sources":["../src/utils.ts"],"sourcesContent":["/**\n * @internal\n */\nexport function invariant(cond: any, message: string): asserts cond {\n  if (!cond) throw new Error(message);\n}\n\nconst alreadyWarned: { [message: string]: boolean } = {};\n\n/**\n * @internal\n */\nexport function warnOnce(message: string, cond: boolean = false): void {\n  if (!cond && !alreadyWarned[message]) {\n    alreadyWarned[message] = true;\n    console.warn(message);\n  }\n}\n"],"names":[],"mappings":"AAAA;;AAEG;AACG,SAAU,SAAS,CAAC,IAAS,EAAE,OAAe,EAAA;AAClD,IAAW,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC;AACrC;AAEA,MAAM,aAAa,GAAmC,EAAE;AAExD;;AAEG;SACa,QAAQ,CAAC,OAAe,EAAE,OAAgB,KAAK,EAAA;IAC7D,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;AACpC,QAAA,aAAa,CAAC,OAAO,CAAC,GAAG,IAAI;AAC7B,QAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;IACvB;AACF;;;;"}

package/lib/utils-EYEfXxbh.js

@@ -1,22 +0,0 @@
-'use strict';
-
-/**
- * @internal
- */
-function invariant(cond, message) {
-    throw new Error(message);
-}
-const alreadyWarned = {};
-/**
- * @internal
- */
-function warnOnce(message, cond = false) {
-    if (!cond && !alreadyWarned[message]) {
-        alreadyWarned[message] = true;
-        console.warn(message);
-    }
-}
-
-exports.invariant = invariant;
-exports.warnOnce = warnOnce;
-//# sourceMappingURL=utils-EYEfXxbh.js.map

package/lib/utils-EYEfXxbh.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils-EYEfXxbh.js","sources":["../src/utils.ts"],"sourcesContent":["/**\n * @internal\n */\nexport function invariant(cond: any, message: string): asserts cond {\n  if (!cond) throw new Error(message);\n}\n\nconst alreadyWarned: { [message: string]: boolean } = {};\n\n/**\n * @internal\n */\nexport function warnOnce(message: string, cond: boolean = false): void {\n  if (!cond && !alreadyWarned[message]) {\n    alreadyWarned[message] = true;\n    console.warn(message);\n  }\n}\n"],"names":[],"mappings":";;AAAA;;AAEG;AACG,SAAU,SAAS,CAAC,IAAS,EAAE,OAAe,EAAA;AAClD,IAAW,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC;AACrC;AAEA,MAAM,aAAa,GAAmC,EAAE;AAExD;;AAEG;SACa,QAAQ,CAAC,OAAe,EAAE,OAAgB,KAAK,EAAA;IAC7D,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;AACpC,QAAA,aAAa,CAAC,OAAO,CAAC,GAAG,IAAI;AAC7B,QAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;IACvB;AACF;;;;;"}