@atlaskit/editor-slack-transformer 3.1.4 → 3.1.5

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 (9) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/cjs/version.json +1 -1
  3. package/dist/es2019/version.json +1 -1
  4. package/dist/esm/version.json +1 -1
  5. package/dist/types-ts4.0/index.d.ts +11 -0
  6. package/dist/types-ts4.0/serializer.d.ts +117 -0
  7. package/dist/types-ts4.0/util.d.ts +6 -0
  8. package/package.json +16 -9
  9. package/report.api.md +15 -6
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/editor-slack-transformer
2
2
 
3
+ ## 3.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
8
+
3
9
  ## 3.1.4
4
10
 
5
11
  ### Patch Changes
package/dist/cjs/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-slack-transformer",
3
- "version": "3.1.4",
3
+ "version": "3.1.5",
4
4
  "sideEffects": false
5
5
  }
package/dist/es2019/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-slack-transformer",
3
- "version": "3.1.4",
3
+ "version": "3.1.5",
4
4
  "sideEffects": false
5
5
  }
package/dist/esm/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-slack-transformer",
3
- "version": "3.1.4",
3
+ "version": "3.1.5",
4
4
  "sideEffects": false
5
5
  }
package/dist/types-ts4.0/index.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ import { Node as PMNode } from 'prosemirror-model';
2
+ interface Transformer<T> {
3
+ encode(node: PMNode): T;
4
+ parse(content: T): PMNode;
5
+ }
6
+ export declare class SlackTransformer implements Transformer<string> {
7
+ private serializer;
8
+ encode(node: PMNode): string;
9
+ parse(_slackMarkdown: string): PMNode;
10
+ }
11
+ export {};
package/dist/types-ts4.0/serializer.d.ts ADDED
@@ -0,0 +1,117 @@
1
+ import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState } from 'prosemirror-markdown';
2
+ import { Node as PMNode } from 'prosemirror-model';
3
+ export declare class MarkdownSerializerState extends PMMarkdownSerializerState {
4
+ renderContent(parent: PMNode): void;
5
+ }
6
+ export declare class MarkdownSerializer extends PMMarkdownSerializer {
7
+ serialize(content: PMNode, options?: {
8
+ [key: string]: any;
9
+ }): string;
10
+ }
11
+ export declare const nodes: {
12
+ table(state: MarkdownSerializerState, node: PMNode): void;
13
+ blockCard(state: MarkdownSerializerState, node: PMNode): void;
14
+ embedCard(state: MarkdownSerializerState, node: PMNode): void;
15
+ /**
16
+ * Inline cards with url type attributes will be sent as a link
17
+ */
18
+ inlineCard(state: MarkdownSerializerState, node: PMNode): void;
19
+ inlineExtension(state: MarkdownSerializerState): void;
20
+ mediaInline(state: MarkdownSerializerState): void;
21
+ extension(state: MarkdownSerializerState, node: PMNode): void;
22
+ bodiedExtension(state: MarkdownSerializerState, node: PMNode): void;
23
+ taskList(state: MarkdownSerializerState, node: PMNode): void;
24
+ nestedExpand(state: MarkdownSerializerState): void;
25
+ confluenceUnsupportedBlock(state: MarkdownSerializerState): void;
26
+ confluenceUnsupportedInline(state: MarkdownSerializerState): void;
27
+ unsupportedInline(state: MarkdownSerializerState): void;
28
+ unsupportedBlock(state: MarkdownSerializerState): void;
29
+ blockquote(state: MarkdownSerializerState, node: PMNode): void;
30
+ codeBlock(state: MarkdownSerializerState, node: PMNode): void;
31
+ heading(state: MarkdownSerializerState, node: PMNode): void;
32
+ rule(state: MarkdownSerializerState, node: PMNode): void;
33
+ bulletList(state: MarkdownSerializerState, node: PMNode): void;
34
+ orderedList(state: MarkdownSerializerState, node: PMNode): void;
35
+ listItem(state: MarkdownSerializerState, node: PMNode, parent: PMNode, index: number): void;
36
+ caption(state: MarkdownSerializerState, node: PMNode): void;
37
+ paragraph(state: MarkdownSerializerState, node: PMNode): void;
38
+ hardBreak(state: MarkdownSerializerState): void;
39
+ text(state: MarkdownSerializerState, node: PMNode): void;
40
+ empty_line(state: MarkdownSerializerState, node: PMNode): void;
41
+ mention(state: MarkdownSerializerState, node: PMNode, parent: PMNode, index: number): void;
42
+ emoji(state: MarkdownSerializerState, node: PMNode): void;
43
+ mediaGroup(state: MarkdownSerializerState, node: PMNode): void;
44
+ mediaSingle(state: MarkdownSerializerState, node: PMNode): void;
45
+ /**
46
+ * Slack markdown does not have specific syntax for images/files.
47
+ * We just show that there's an image attached as a link and a media just as a text.
48
+ */
49
+ media(state: MarkdownSerializerState): void;
50
+ image(state: MarkdownSerializerState, node: PMNode): void;
51
+ date(state: MarkdownSerializerState, node: PMNode): void;
52
+ decisionList(state: MarkdownSerializerState, node: PMNode): void;
53
+ decisionItem(state: MarkdownSerializerState, node: PMNode, parent: PMNode, index: number): void;
54
+ layoutSection(state: MarkdownSerializerState, node: PMNode): void;
55
+ layoutColumn(state: MarkdownSerializerState, node: PMNode): void;
56
+ status(state: MarkdownSerializerState, node: PMNode): void;
57
+ panel(state: MarkdownSerializerState, node: PMNode): void;
58
+ placeholder(state: MarkdownSerializerState, node: PMNode): void;
59
+ confluenceJiraIssue(state: MarkdownSerializerState, node: PMNode): void;
60
+ };
61
+ export declare const marks: {
62
+ subsup: {
63
+ open: string;
64
+ close: string;
65
+ };
66
+ underline: {
67
+ open: string;
68
+ close: string;
69
+ };
70
+ textColor: {
71
+ open: string;
72
+ close: string;
73
+ };
74
+ typeAheadQuery: {
75
+ open: string;
76
+ close: string;
77
+ };
78
+ confluenceInlineComment: {
79
+ open: string;
80
+ close: string;
81
+ };
82
+ annotation: {
83
+ open: string;
84
+ close: string;
85
+ };
86
+ unsupportedMark: {
87
+ open: string;
88
+ close: string;
89
+ };
90
+ em: {
91
+ open: string;
92
+ close: string;
93
+ mixable: boolean;
94
+ expelEnclosingWhitespace: boolean;
95
+ };
96
+ strong: {
97
+ open: string;
98
+ close: string;
99
+ mixable: boolean;
100
+ expelEnclosingWhitespace: boolean;
101
+ };
102
+ strike: {
103
+ open: string;
104
+ close: string;
105
+ mixable: boolean;
106
+ expelEnclosingWhitespace: boolean;
107
+ };
108
+ link: {
109
+ open(_state: MarkdownSerializerState, mark: any): string;
110
+ close: string;
111
+ };
112
+ code: {
113
+ open: string;
114
+ close: string;
115
+ escape: boolean;
116
+ };
117
+ };
package/dist/types-ts4.0/util.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Slack uses &, <, and > as control characters for special parsing in text objects,
3
+ * so they must be converted to HTML entities.
4
+ *
5
+ */
6
+ export declare const escapeMarkdown: (str: string) => string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-slack-transformer",
3
- "version": "3.1.4",
3
+ "version": "3.1.5",
4
4
  "description": "Editor Slack transformer",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
+ "typesVersions": {
16
+ ">=4.0 <4.5": {
17
+ "*": [
18
+ "dist/types-ts4.0/*"
19
+ ]
20
+ }
21
+ },
15
22
  "sideEffects": false,
16
23
  "atlaskit:src": "src/index.ts",
17
24
  "atlassian": {
@@ -32,19 +39,19 @@
32
39
  },
33
40
  "devDependencies": {
34
41
  "@atlaskit/activity": "^1.0.1",
35
- "@atlaskit/adf-schema": "^23.3.0",
42
+ "@atlaskit/adf-schema": "^24.0.0",
36
43
  "@atlaskit/docs": "*",
37
- "@atlaskit/editor-common": "^69.1.0",
38
- "@atlaskit/editor-core": "^172.0.0",
39
- "@atlaskit/editor-test-helpers": "^17.1.0",
40
- "@atlaskit/emoji": "^65.1.0",
41
- "@atlaskit/smart-card": "^21.1.0",
42
- "@atlaskit/theme": "^12.1.0",
44
+ "@atlaskit/editor-common": "^69.3.0",
45
+ "@atlaskit/editor-core": "^172.2.0",
46
+ "@atlaskit/editor-test-helpers": "^17.2.0",
47
+ "@atlaskit/emoji": "^65.2.0",
48
+ "@atlaskit/smart-card": "^22.2.0",
49
+ "@atlaskit/theme": "^12.2.0",
43
50
  "@atlaskit/util-data-test": "^17.5.0",
44
51
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
45
52
  "@emotion/react": "^11.7.1",
46
53
  "prosemirror-view": "1.23.2",
47
- "typescript": "4.3.5"
54
+ "typescript": "4.5.5"
48
55
  },
49
56
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1",
50
57
  "af:exports": {
package/report.api.md CHANGED
@@ -1,22 +1,31 @@
1
- ## API Report File for "@atlaskit/editor-slack-transformer".
1
+ ## API Report File for "@atlaskit/editor-slack-transformer"
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ <!--
6
+ Generated API Report version: 2.0
7
+ -->
4
8
 
5
9
  [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
6
10
 
7
11
  ```ts
8
12
  import { Node as Node_2 } from 'prosemirror-model';
9
13
 
10
- export declare class SlackTransformer implements Transformer_2<string> {
11
- private serializer;
14
+ // @public (undocumented)
15
+ export class SlackTransformer implements Transformer_2<string> {
16
+ // (undocumented)
12
17
  encode(node: Node_2): string;
18
+ // (undocumented)
13
19
  parse(_slackMarkdown: string): Node_2;
14
20
  }
15
21
 
16
- declare interface Transformer_2<T> {
22
+ // @public (undocumented)
23
+ interface Transformer_2<T> {
24
+ // (undocumented)
17
25
  encode(node: Node_2): T;
26
+ // (undocumented)
18
27
  parse(content: T): Node_2;
19
28
  }
20
29
 
21
- export {};
30
+ // (No @packageDocumentation comment for this package)
22
31
  ```