@player-ui/markdown-plugin 0.8.0--canary.307.9645 → 0.8.0-next.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.
- package/dist/MarkdownPlugin.native.js +18356 -0
- package/dist/MarkdownPlugin.native.js.map +1 -0
- package/dist/{index.esm.js → cjs/index.cjs} +93 -78
- package/dist/cjs/index.cjs.map +1 -0
- package/dist/{index.cjs.js → index.legacy-esm.js} +69 -83
- package/dist/index.mjs +300 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +27 -60
- package/src/__tests__/helpers/index.ts +159 -0
- package/src/__tests__/index.test.ts +464 -0
- package/src/index.ts +8 -8
- package/src/types.ts +4 -4
- package/src/utils/index.ts +2 -2
- package/src/utils/markdownParser.ts +7 -7
- package/src/utils/transformers.ts +14 -14
- package/types/index.d.ts +13 -0
- package/{dist/index.d.ts → types/types.d.ts} +8 -21
- package/types/utils/index.d.ts +3 -0
- package/types/utils/markdownParser.d.ts +23 -0
- package/types/utils/transformers.d.ts +3 -0
- package/dist/markdown-plugin.dev.js +0 -25640
- package/dist/markdown-plugin.prod.js +0 -2
|
@@ -1,31 +1,29 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
interface BaseArgs {
|
|
1
|
+
import type { Asset } from "@player-ui/types";
|
|
2
|
+
export interface BaseArgs {
|
|
5
3
|
/**
|
|
6
4
|
* Unparsed Asset
|
|
7
5
|
*/
|
|
8
6
|
originalAsset: Asset;
|
|
9
7
|
}
|
|
10
|
-
|
|
8
|
+
export type LiteralMapper<T extends object = object> = (args: {
|
|
11
9
|
/**
|
|
12
10
|
* markdown element value
|
|
13
11
|
*/
|
|
14
12
|
value: string;
|
|
15
13
|
} & BaseArgs & T) => Asset;
|
|
16
|
-
|
|
14
|
+
export type CompositeMapper<T extends object = object> = (args: {
|
|
17
15
|
/**
|
|
18
16
|
* array of assets resulted from the recursion over the AST node children
|
|
19
17
|
*/
|
|
20
18
|
value: Asset[];
|
|
21
19
|
} & BaseArgs & T) => Asset;
|
|
22
|
-
|
|
20
|
+
export type FallbackMapper = (args: {
|
|
23
21
|
/**
|
|
24
22
|
* markdown element value
|
|
25
23
|
*/
|
|
26
24
|
value: string | Asset[];
|
|
27
25
|
} & BaseArgs) => Asset;
|
|
28
|
-
interface Mappers {
|
|
26
|
+
export interface Mappers {
|
|
29
27
|
/**
|
|
30
28
|
* required text Asset
|
|
31
29
|
*/
|
|
@@ -112,7 +110,7 @@ interface Mappers {
|
|
|
112
110
|
*/
|
|
113
111
|
listItem?: CompositeMapper;
|
|
114
112
|
}
|
|
115
|
-
|
|
113
|
+
export type Transformer<T = any> = (args: {
|
|
116
114
|
/**
|
|
117
115
|
* AST Node (e.g. Link)
|
|
118
116
|
*/
|
|
@@ -130,15 +128,4 @@ declare type Transformer<T = any> = (args: {
|
|
|
130
128
|
*/
|
|
131
129
|
transformers: Record<string, Transformer>;
|
|
132
130
|
}) => Asset;
|
|
133
|
-
|
|
134
|
-
/**
|
|
135
|
-
* A plugin that parses markdown written into text assets using the given converters for markdown features into existing assets.
|
|
136
|
-
*/
|
|
137
|
-
declare class MarkdownPlugin implements PlayerPlugin {
|
|
138
|
-
name: string;
|
|
139
|
-
private mappers;
|
|
140
|
-
constructor(mappers: Mappers);
|
|
141
|
-
apply(player: Player): void;
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
export { BaseArgs, CompositeMapper, FallbackMapper, LiteralMapper, Mappers, MarkdownPlugin, Transformer };
|
|
131
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { Node, ParseObjectOptions } from "@player-ui/player";
|
|
2
|
+
import type { Asset } from "@player-ui/types";
|
|
3
|
+
import type { Mappers } from "../types";
|
|
4
|
+
/**
|
|
5
|
+
* Parses markdown content using a provided mappers record.
|
|
6
|
+
*/
|
|
7
|
+
export declare function parseAssetMarkdownContent({ asset, mappers, parser, }: {
|
|
8
|
+
/**
|
|
9
|
+
* Asset to be parsed
|
|
10
|
+
*/
|
|
11
|
+
asset: Asset;
|
|
12
|
+
/**
|
|
13
|
+
* Mappers record of AST Node to Player Content
|
|
14
|
+
*
|
|
15
|
+
* @see {@link Mappers}
|
|
16
|
+
*/
|
|
17
|
+
mappers: Mappers;
|
|
18
|
+
/**
|
|
19
|
+
* Parser object to AST
|
|
20
|
+
*/
|
|
21
|
+
parser?: (obj: object, type?: Node.ChildrenTypes, options?: ParseObjectOptions) => Node.Node | null;
|
|
22
|
+
}): Node.Node | null;
|
|
23
|
+
//# sourceMappingURL=markdownParser.d.ts.map
|