@hywax/mdc-tiptap 0.0.2 → 0.1.1

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 (7) hide show
  1. package/README.md +2 -24
  2. package/dist/index.cjs +559 -537
  3. package/dist/index.d.cts +51 -30
  4. package/dist/index.d.mts +51 -30
  5. package/dist/index.d.ts +51 -30
  6. package/dist/index.mjs +558 -529
  7. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -1,17 +1,33 @@
1
1
  import { JSONContent } from '@tiptap/vue-3';
2
- import { MDCRoot, MDCNode, MDCElement } from '@nuxtjs/mdc';
2
+ import { MDCRoot, MDCNode, MDCElement, MDCText } from '@nuxtjs/mdc';
3
3
 
4
4
  type MDCToTipTapMap = Record<string, (node: MDCRoot | MDCNode) => JSONContent>;
5
5
  interface MDCToTiptapOptions {
6
- mdcToTiptapMap?: MDCToTipTapMap;
6
+ customMap?: MDCToTipTapMap;
7
7
  }
8
- declare function mdcToTiptap(body: MDCRoot, options?: MDCToTiptapOptions): JSONContent;
9
- declare function mdcNodeToTiptap(node: MDCRoot | MDCNode, parent?: MDCNode, mdcToTiptapMap?: MDCToTipTapMap): JSONContent;
10
- declare function createMark(node: MDCNode, mark: string, accumulatedMarks?: {
11
- type: string;
12
- attrs?: object;
13
- }[]): JSONContent[];
14
- declare function createTipTapNode(node: MDCElement, type: string, extra?: Record<string, unknown>): Record<string, unknown>;
8
+ declare function createMDCToTiptap(options?: MDCToTiptapOptions): {
9
+ mdcToTiptap: (body: MDCRoot) => JSONContent;
10
+ createMark: (node: MDCNode, mark: string, accumulatedMarks?: {
11
+ type: string;
12
+ attrs?: object;
13
+ }[]) => JSONContent[];
14
+ createTipTapNode: (node: MDCElement, type: string, extra?: Record<string, unknown>) => Record<string, unknown>;
15
+ createTemplateNode: (node: MDCElement) => Record<string, unknown>;
16
+ createPreNode: (node: MDCElement) => Record<string, unknown>;
17
+ createParagraphNode: (node: MDCElement) => JSONContent[] | {
18
+ type: string;
19
+ content: JSONContent[];
20
+ attrs: Record<string, any> | undefined;
21
+ };
22
+ createTextNode: (node: MDCText) => {
23
+ type: string;
24
+ text: string;
25
+ }[] | {
26
+ type: string;
27
+ text: string;
28
+ };
29
+ createSpanStyleNode: (node: MDCElement) => Record<string, unknown>;
30
+ };
15
31
 
16
32
  interface SyntaxHighlightTheme {
17
33
  default: string;
@@ -20,30 +36,35 @@ interface SyntaxHighlightTheme {
20
36
  }
21
37
 
22
38
  type TiptapToMDCMap = Record<string, (node: JSONContent) => MDCRoot | MDCNode | MDCNode[]>;
39
+ interface TiptapToMDCMapOptions {
40
+ customMap?: TiptapToMDCMap;
41
+ }
23
42
  interface TiptapToMDCOptions {
24
43
  highlightTheme?: SyntaxHighlightTheme;
25
- tiptapToMDCMap?: TiptapToMDCMap;
26
44
  }
27
- declare function tiptapToMdc(node: JSONContent, options?: TiptapToMDCOptions): Promise<{
28
- body: MDCRoot;
29
- data: Record<string, unknown>;
30
- }>;
31
- declare function tiptapNodeToMDC(node: JSONContent, tiptapToMDCMap?: TiptapToMDCMap): MDCRoot | MDCNode | MDCNode[];
32
- /***************************************************************
33
- *********************** Create element methods ****************
34
- ***************************************************************/
35
- declare function createElement(node: JSONContent, tag?: string, extra?: unknown): MDCElement;
36
- declare function createParagraphElement(node: JSONContent, propsArray: string[][], rest?: object): MDCElement;
45
+ declare function createTiptapToMDC(options?: TiptapToMDCMapOptions): {
46
+ tiptapToMdc: (node: JSONContent, options?: TiptapToMDCOptions) => Promise<{
47
+ body: MDCRoot;
48
+ data: Record<string, unknown>;
49
+ }>;
50
+ tiptapNodeToMDC: (node: JSONContent) => MDCRoot | MDCNode | MDCNode[];
51
+ createParagraphElement: (node: JSONContent, propsArray: string[][], rest?: object) => MDCElement;
52
+ createHeadingElement: (node: JSONContent) => MDCElement;
53
+ createCodeBlockElement: (node: JSONContent) => MDCElement;
54
+ createImageElement: (node: JSONContent) => MDCElement;
55
+ createLinkElement: (node: JSONContent) => MDCElement;
56
+ createTextElement: (node: JSONContent) => MDCText | MDCText[];
57
+ createListItemElement: (node: JSONContent) => MDCElement;
58
+ };
37
59
 
38
- interface MarkdownToTiptapOptions {
39
- tiptapToMDCMap?: TiptapToMDCMap;
40
- highlightTheme?: SyntaxHighlightTheme;
41
- }
42
- interface TiptapToMarkdownOptions {
43
- mdcToTiptapMap?: MDCToTipTapMap;
60
+ interface MarkdownOptions {
61
+ mdcToTiptap?: MDCToTiptapOptions;
62
+ tiptapToMDC?: TiptapToMDCMapOptions;
44
63
  }
45
- declare function tiptapToMarkdown(node: JSONContent, options?: MarkdownToTiptapOptions): Promise<string | null>;
46
- declare function markdownToTiptap(markdown: string, options?: TiptapToMarkdownOptions): Promise<JSONContent>;
64
+ declare function createMarkdown(options?: MarkdownOptions): {
65
+ tiptapToMarkdown: (node: JSONContent) => Promise<string | null>;
66
+ markdownToTiptap: (markdown: string) => Promise<JSONContent>;
67
+ };
47
68
 
48
- export { createElement, createMark, createParagraphElement, createTipTapNode, markdownToTiptap, mdcNodeToTiptap, mdcToTiptap, tiptapNodeToMDC, tiptapToMarkdown, tiptapToMdc };
49
- export type { MDCToTipTapMap, MDCToTiptapOptions, TiptapToMDCMap };
69
+ export { createMDCToTiptap, createMarkdown, createTiptapToMDC };
70
+ export type { MDCToTipTapMap, MDCToTiptapOptions, MarkdownOptions, TiptapToMDCMap, TiptapToMDCMapOptions };
package/dist/index.d.mts CHANGED
@@ -1,17 +1,33 @@
1
1
  import { JSONContent } from '@tiptap/vue-3';
2
- import { MDCRoot, MDCNode, MDCElement } from '@nuxtjs/mdc';
2
+ import { MDCRoot, MDCNode, MDCElement, MDCText } from '@nuxtjs/mdc';
3
3
 
4
4
  type MDCToTipTapMap = Record<string, (node: MDCRoot | MDCNode) => JSONContent>;
5
5
  interface MDCToTiptapOptions {
6
- mdcToTiptapMap?: MDCToTipTapMap;
6
+ customMap?: MDCToTipTapMap;
7
7
  }
8
- declare function mdcToTiptap(body: MDCRoot, options?: MDCToTiptapOptions): JSONContent;
9
- declare function mdcNodeToTiptap(node: MDCRoot | MDCNode, parent?: MDCNode, mdcToTiptapMap?: MDCToTipTapMap): JSONContent;
10
- declare function createMark(node: MDCNode, mark: string, accumulatedMarks?: {
11
- type: string;
12
- attrs?: object;
13
- }[]): JSONContent[];
14
- declare function createTipTapNode(node: MDCElement, type: string, extra?: Record<string, unknown>): Record<string, unknown>;
8
+ declare function createMDCToTiptap(options?: MDCToTiptapOptions): {
9
+ mdcToTiptap: (body: MDCRoot) => JSONContent;
10
+ createMark: (node: MDCNode, mark: string, accumulatedMarks?: {
11
+ type: string;
12
+ attrs?: object;
13
+ }[]) => JSONContent[];
14
+ createTipTapNode: (node: MDCElement, type: string, extra?: Record<string, unknown>) => Record<string, unknown>;
15
+ createTemplateNode: (node: MDCElement) => Record<string, unknown>;
16
+ createPreNode: (node: MDCElement) => Record<string, unknown>;
17
+ createParagraphNode: (node: MDCElement) => JSONContent[] | {
18
+ type: string;
19
+ content: JSONContent[];
20
+ attrs: Record<string, any> | undefined;
21
+ };
22
+ createTextNode: (node: MDCText) => {
23
+ type: string;
24
+ text: string;
25
+ }[] | {
26
+ type: string;
27
+ text: string;
28
+ };
29
+ createSpanStyleNode: (node: MDCElement) => Record<string, unknown>;
30
+ };
15
31
 
16
32
  interface SyntaxHighlightTheme {
17
33
  default: string;
@@ -20,30 +36,35 @@ interface SyntaxHighlightTheme {
20
36
  }
21
37
 
22
38
  type TiptapToMDCMap = Record<string, (node: JSONContent) => MDCRoot | MDCNode | MDCNode[]>;
39
+ interface TiptapToMDCMapOptions {
40
+ customMap?: TiptapToMDCMap;
41
+ }
23
42
  interface TiptapToMDCOptions {
24
43
  highlightTheme?: SyntaxHighlightTheme;
25
- tiptapToMDCMap?: TiptapToMDCMap;
26
44
  }
27
- declare function tiptapToMdc(node: JSONContent, options?: TiptapToMDCOptions): Promise<{
28
- body: MDCRoot;
29
- data: Record<string, unknown>;
30
- }>;
31
- declare function tiptapNodeToMDC(node: JSONContent, tiptapToMDCMap?: TiptapToMDCMap): MDCRoot | MDCNode | MDCNode[];
32
- /***************************************************************
33
- *********************** Create element methods ****************
34
- ***************************************************************/
35
- declare function createElement(node: JSONContent, tag?: string, extra?: unknown): MDCElement;
36
- declare function createParagraphElement(node: JSONContent, propsArray: string[][], rest?: object): MDCElement;
45
+ declare function createTiptapToMDC(options?: TiptapToMDCMapOptions): {
46
+ tiptapToMdc: (node: JSONContent, options?: TiptapToMDCOptions) => Promise<{
47
+ body: MDCRoot;
48
+ data: Record<string, unknown>;
49
+ }>;
50
+ tiptapNodeToMDC: (node: JSONContent) => MDCRoot | MDCNode | MDCNode[];
51
+ createParagraphElement: (node: JSONContent, propsArray: string[][], rest?: object) => MDCElement;
52
+ createHeadingElement: (node: JSONContent) => MDCElement;
53
+ createCodeBlockElement: (node: JSONContent) => MDCElement;
54
+ createImageElement: (node: JSONContent) => MDCElement;
55
+ createLinkElement: (node: JSONContent) => MDCElement;
56
+ createTextElement: (node: JSONContent) => MDCText | MDCText[];
57
+ createListItemElement: (node: JSONContent) => MDCElement;
58
+ };
37
59
 
38
- interface MarkdownToTiptapOptions {
39
- tiptapToMDCMap?: TiptapToMDCMap;
40
- highlightTheme?: SyntaxHighlightTheme;
41
- }
42
- interface TiptapToMarkdownOptions {
43
- mdcToTiptapMap?: MDCToTipTapMap;
60
+ interface MarkdownOptions {
61
+ mdcToTiptap?: MDCToTiptapOptions;
62
+ tiptapToMDC?: TiptapToMDCMapOptions;
44
63
  }
45
- declare function tiptapToMarkdown(node: JSONContent, options?: MarkdownToTiptapOptions): Promise<string | null>;
46
- declare function markdownToTiptap(markdown: string, options?: TiptapToMarkdownOptions): Promise<JSONContent>;
64
+ declare function createMarkdown(options?: MarkdownOptions): {
65
+ tiptapToMarkdown: (node: JSONContent) => Promise<string | null>;
66
+ markdownToTiptap: (markdown: string) => Promise<JSONContent>;
67
+ };
47
68
 
48
- export { createElement, createMark, createParagraphElement, createTipTapNode, markdownToTiptap, mdcNodeToTiptap, mdcToTiptap, tiptapNodeToMDC, tiptapToMarkdown, tiptapToMdc };
49
- export type { MDCToTipTapMap, MDCToTiptapOptions, TiptapToMDCMap };
69
+ export { createMDCToTiptap, createMarkdown, createTiptapToMDC };
70
+ export type { MDCToTipTapMap, MDCToTiptapOptions, MarkdownOptions, TiptapToMDCMap, TiptapToMDCMapOptions };
package/dist/index.d.ts CHANGED
@@ -1,17 +1,33 @@
1
1
  import { JSONContent } from '@tiptap/vue-3';
2
- import { MDCRoot, MDCNode, MDCElement } from '@nuxtjs/mdc';
2
+ import { MDCRoot, MDCNode, MDCElement, MDCText } from '@nuxtjs/mdc';
3
3
 
4
4
  type MDCToTipTapMap = Record<string, (node: MDCRoot | MDCNode) => JSONContent>;
5
5
  interface MDCToTiptapOptions {
6
- mdcToTiptapMap?: MDCToTipTapMap;
6
+ customMap?: MDCToTipTapMap;
7
7
  }
8
- declare function mdcToTiptap(body: MDCRoot, options?: MDCToTiptapOptions): JSONContent;
9
- declare function mdcNodeToTiptap(node: MDCRoot | MDCNode, parent?: MDCNode, mdcToTiptapMap?: MDCToTipTapMap): JSONContent;
10
- declare function createMark(node: MDCNode, mark: string, accumulatedMarks?: {
11
- type: string;
12
- attrs?: object;
13
- }[]): JSONContent[];
14
- declare function createTipTapNode(node: MDCElement, type: string, extra?: Record<string, unknown>): Record<string, unknown>;
8
+ declare function createMDCToTiptap(options?: MDCToTiptapOptions): {
9
+ mdcToTiptap: (body: MDCRoot) => JSONContent;
10
+ createMark: (node: MDCNode, mark: string, accumulatedMarks?: {
11
+ type: string;
12
+ attrs?: object;
13
+ }[]) => JSONContent[];
14
+ createTipTapNode: (node: MDCElement, type: string, extra?: Record<string, unknown>) => Record<string, unknown>;
15
+ createTemplateNode: (node: MDCElement) => Record<string, unknown>;
16
+ createPreNode: (node: MDCElement) => Record<string, unknown>;
17
+ createParagraphNode: (node: MDCElement) => JSONContent[] | {
18
+ type: string;
19
+ content: JSONContent[];
20
+ attrs: Record<string, any> | undefined;
21
+ };
22
+ createTextNode: (node: MDCText) => {
23
+ type: string;
24
+ text: string;
25
+ }[] | {
26
+ type: string;
27
+ text: string;
28
+ };
29
+ createSpanStyleNode: (node: MDCElement) => Record<string, unknown>;
30
+ };
15
31
 
16
32
  interface SyntaxHighlightTheme {
17
33
  default: string;
@@ -20,30 +36,35 @@ interface SyntaxHighlightTheme {
20
36
  }
21
37
 
22
38
  type TiptapToMDCMap = Record<string, (node: JSONContent) => MDCRoot | MDCNode | MDCNode[]>;
39
+ interface TiptapToMDCMapOptions {
40
+ customMap?: TiptapToMDCMap;
41
+ }
23
42
  interface TiptapToMDCOptions {
24
43
  highlightTheme?: SyntaxHighlightTheme;
25
- tiptapToMDCMap?: TiptapToMDCMap;
26
44
  }
27
- declare function tiptapToMdc(node: JSONContent, options?: TiptapToMDCOptions): Promise<{
28
- body: MDCRoot;
29
- data: Record<string, unknown>;
30
- }>;
31
- declare function tiptapNodeToMDC(node: JSONContent, tiptapToMDCMap?: TiptapToMDCMap): MDCRoot | MDCNode | MDCNode[];
32
- /***************************************************************
33
- *********************** Create element methods ****************
34
- ***************************************************************/
35
- declare function createElement(node: JSONContent, tag?: string, extra?: unknown): MDCElement;
36
- declare function createParagraphElement(node: JSONContent, propsArray: string[][], rest?: object): MDCElement;
45
+ declare function createTiptapToMDC(options?: TiptapToMDCMapOptions): {
46
+ tiptapToMdc: (node: JSONContent, options?: TiptapToMDCOptions) => Promise<{
47
+ body: MDCRoot;
48
+ data: Record<string, unknown>;
49
+ }>;
50
+ tiptapNodeToMDC: (node: JSONContent) => MDCRoot | MDCNode | MDCNode[];
51
+ createParagraphElement: (node: JSONContent, propsArray: string[][], rest?: object) => MDCElement;
52
+ createHeadingElement: (node: JSONContent) => MDCElement;
53
+ createCodeBlockElement: (node: JSONContent) => MDCElement;
54
+ createImageElement: (node: JSONContent) => MDCElement;
55
+ createLinkElement: (node: JSONContent) => MDCElement;
56
+ createTextElement: (node: JSONContent) => MDCText | MDCText[];
57
+ createListItemElement: (node: JSONContent) => MDCElement;
58
+ };
37
59
 
38
- interface MarkdownToTiptapOptions {
39
- tiptapToMDCMap?: TiptapToMDCMap;
40
- highlightTheme?: SyntaxHighlightTheme;
41
- }
42
- interface TiptapToMarkdownOptions {
43
- mdcToTiptapMap?: MDCToTipTapMap;
60
+ interface MarkdownOptions {
61
+ mdcToTiptap?: MDCToTiptapOptions;
62
+ tiptapToMDC?: TiptapToMDCMapOptions;
44
63
  }
45
- declare function tiptapToMarkdown(node: JSONContent, options?: MarkdownToTiptapOptions): Promise<string | null>;
46
- declare function markdownToTiptap(markdown: string, options?: TiptapToMarkdownOptions): Promise<JSONContent>;
64
+ declare function createMarkdown(options?: MarkdownOptions): {
65
+ tiptapToMarkdown: (node: JSONContent) => Promise<string | null>;
66
+ markdownToTiptap: (markdown: string) => Promise<JSONContent>;
67
+ };
47
68
 
48
- export { createElement, createMark, createParagraphElement, createTipTapNode, markdownToTiptap, mdcNodeToTiptap, mdcToTiptap, tiptapNodeToMDC, tiptapToMarkdown, tiptapToMdc };
49
- export type { MDCToTipTapMap, MDCToTiptapOptions, TiptapToMDCMap };
69
+ export { createMDCToTiptap, createMarkdown, createTiptapToMDC };
70
+ export type { MDCToTipTapMap, MDCToTiptapOptions, MarkdownOptions, TiptapToMDCMap, TiptapToMDCMapOptions };