@voiceflow/slate-serializer 1.1.4 → 1.1.6
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/README.md +55 -1
- package/build/cjs/selectors.d.ts +3 -3
- package/build/cjs/selectors.js.map +1 -1
- package/build/cjs/styles.d.ts +2 -2
- package/build/cjs/styles.js.map +1 -1
- package/build/esm/selectors.d.ts +3 -3
- package/build/esm/selectors.js.map +1 -1
- package/build/esm/styles.d.ts +2 -2
- package/build/esm/styles.js.map +1 -1
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -1 +1,55 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Slate Serializer
|
|
2
|
+
|
|
3
|
+
Utilities for converting slate data into raw text or JSX.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
yarn add @voiceflow/slate-serializer @voiceflow/base-types slate
|
|
9
|
+
# or
|
|
10
|
+
npm install @voiceflow/slate-serializer @voiceflow/base-types slate
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
If you want to use the JSX serializer make sure to install `react`.
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
yarn add react
|
|
17
|
+
# or
|
|
18
|
+
npm install react
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
You can access type guards and other extraction utilities through the main import.
|
|
24
|
+
|
|
25
|
+
```tsx
|
|
26
|
+
import { isLinkElement, getTextCSSProperties } from '@voiceflow/react-chat';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Text Serialization
|
|
30
|
+
|
|
31
|
+
If you need the textual representation you can import the text serializer.
|
|
32
|
+
|
|
33
|
+
```tsx
|
|
34
|
+
import { serializeToText } from '@voiceflow/react-chat/text';
|
|
35
|
+
|
|
36
|
+
const text = serializeToText(slateValue);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
You can turn off `encodeVariables` to avoid encoding variables in the text.
|
|
40
|
+
|
|
41
|
+
```tsx
|
|
42
|
+
import { serializeToText } from '@voiceflow/react-chat/text';
|
|
43
|
+
|
|
44
|
+
const textWithoutVariables = serializeToText(slateValue, { encodeVariables: false });
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### JSX Serialization
|
|
48
|
+
|
|
49
|
+
If you want to render the result in a browser you can serialize to JSX.
|
|
50
|
+
|
|
51
|
+
```tsx
|
|
52
|
+
import { serializeToJSX } from '@voiceflow/react-chat/jsx';
|
|
53
|
+
|
|
54
|
+
const content = <div>{serializeToJSX(slateValue)}</div>;
|
|
55
|
+
```
|
package/build/cjs/selectors.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Text } from '@voiceflow/base-types';
|
|
2
|
-
import
|
|
3
|
-
export declare const getElementCSSProperties: (element: Text.AnyElement) =>
|
|
4
|
-
export declare const getTextCSSProperties: (text: Text.Text) =>
|
|
2
|
+
import CSS from 'csstype';
|
|
3
|
+
export declare const getElementCSSProperties: (element: Text.AnyElement) => CSS.Properties;
|
|
4
|
+
export declare const getTextCSSProperties: (text: Text.Text) => CSS.Properties;
|
|
5
5
|
export declare const getElementStyles: (element: Text.AnyElement) => string;
|
|
6
6
|
export declare const getTextStyles: (text: Text.Text) => string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":";;;AAAA,sDAA6C;AAG7C,qCAAwD;AAEjD,MAAM,uBAAuB,GAAG,CAAC,OAAwB,
|
|
1
|
+
{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":";;;AAAA,sDAA6C;AAG7C,qCAAwD;AAEjD,MAAM,uBAAuB,GAAG,CAAC,OAAwB,EAAkB,EAAE;IAClF,MAAM,SAAS,GAAG,OAAO,CAAC,iBAAI,CAAC,eAAe,CAAC,UAAU,CAAgC,CAAC;IAE1F,MAAM,MAAM,GAAmB,EAAE,CAAC;IAElC,IAAI,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AARW,QAAA,uBAAuB,2BAQlC;AAEK,MAAM,oBAAoB,GAAG,CAAC,IAAe,EAAkB,EAAE;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAmB,EAAE,CAAC;IAElC,IAAI,KAAK;QAAE,MAAM,CAAC,KAAK,GAAG,QAAQ,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC;IAC9E,IAAI,QAAQ;QAAE,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC1C,IAAI,UAAU;QAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACvD,IAAI,UAAU;QAAE,MAAM,CAAC,UAAU,GAAG,IAAI,UAAU,GAAG,CAAC;IAEtD,IAAI,WAAW,IAAI,eAAe,EAAE;QAClC,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,WAAW;YAAE,UAAU,IAAI,WAAW,CAAC;QAC3C,IAAI,eAAe;YAAE,UAAU,IAAI,eAAe,CAAC;QAEnD,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;KAC3C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAzBW,QAAA,oBAAoB,wBAyB/B;AAEK,MAAM,gBAAgB,GAAG,CAAC,OAAwB,EAAU,EAAE,CAAC,IAAA,qCAA4B,EAAC,IAAA,+BAAuB,EAAC,OAAO,CAAC,CAAC,CAAC;AAAxH,QAAA,gBAAgB,oBAAwG;AAE9H,MAAM,aAAa,GAAG,CAAC,IAAe,EAAU,EAAE,CAAC,IAAA,qCAA4B,EAAC,IAAA,4BAAoB,EAAC,IAAI,CAAC,CAAC,CAAC;AAAtG,QAAA,aAAa,iBAAyF"}
|
package/build/cjs/styles.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import
|
|
1
|
+
import CSS from 'csstype';
|
|
2
2
|
export declare const cssPropertyNameToStyleName: (name: string) => string;
|
|
3
|
-
export declare const convertCSSPropertiesToStyles: (properties:
|
|
3
|
+
export declare const convertCSSPropertiesToStyles: (properties: CSS.Properties) => string;
|
package/build/cjs/styles.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"styles.js","sourceRoot":"","sources":["../../src/styles.ts"],"names":[],"mappings":";;;AAEA,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAEhC,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAAjI,QAAA,0BAA0B,8BAAuG;AAEvI,MAAM,4BAA4B,GAAG,CAAC,
|
|
1
|
+
{"version":3,"file":"styles.js","sourceRoot":"","sources":["../../src/styles.ts"],"names":[],"mappings":";;;AAEA,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAEhC,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAAjI,QAAA,0BAA0B,8BAAuG;AAEvI,MAAM,4BAA4B,GAAG,CAAC,UAA0B,EAAU,EAAE,CACjF,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;KACvB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAA,kCAA0B,EAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;KACpE,IAAI,CAAC,GAAG,CAAC,CAAC;AAHF,QAAA,4BAA4B,gCAG1B"}
|
package/build/esm/selectors.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Text } from '@voiceflow/base-types';
|
|
2
|
-
import
|
|
3
|
-
export declare const getElementCSSProperties: (element: Text.AnyElement) =>
|
|
4
|
-
export declare const getTextCSSProperties: (text: Text.Text) =>
|
|
2
|
+
import CSS from 'csstype';
|
|
3
|
+
export declare const getElementCSSProperties: (element: Text.AnyElement) => CSS.Properties;
|
|
4
|
+
export declare const getTextCSSProperties: (text: Text.Text) => CSS.Properties;
|
|
5
5
|
export declare const getElementStyles: (element: Text.AnyElement) => string;
|
|
6
6
|
export declare const getTextStyles: (text: Text.Text) => string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAG7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,OAAwB,
|
|
1
|
+
{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAG7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,OAAwB,EAAkB,EAAE;IAClF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAgC,CAAC;IAE1F,MAAM,MAAM,GAAmB,EAAE,CAAC;IAElC,IAAI,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAe,EAAkB,EAAE;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAmB,EAAE,CAAC;IAElC,IAAI,KAAK;QAAE,MAAM,CAAC,KAAK,GAAG,QAAQ,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC;IAC9E,IAAI,QAAQ;QAAE,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC1C,IAAI,UAAU;QAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACvD,IAAI,UAAU;QAAE,MAAM,CAAC,UAAU,GAAG,IAAI,UAAU,GAAG,CAAC;IAEtD,IAAI,WAAW,IAAI,eAAe,EAAE;QAClC,IAAI,UAAU,GAAG,EAAE,CAAC;QAEpB,IAAI,WAAW;YAAE,UAAU,IAAI,WAAW,CAAC;QAC3C,IAAI,eAAe;YAAE,UAAU,IAAI,eAAe,CAAC;QAEnD,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;KAC3C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAwB,EAAU,EAAE,CAAC,4BAA4B,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;AAErI,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAe,EAAU,EAAE,CAAC,4BAA4B,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC"}
|
package/build/esm/styles.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import
|
|
1
|
+
import CSS from 'csstype';
|
|
2
2
|
export declare const cssPropertyNameToStyleName: (name: string) => string;
|
|
3
|
-
export declare const convertCSSPropertiesToStyles: (properties:
|
|
3
|
+
export declare const convertCSSPropertiesToStyles: (properties: CSS.Properties) => string;
|
package/build/esm/styles.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"styles.js","sourceRoot":"","sources":["../../src/styles.ts"],"names":[],"mappings":"AAEA,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAEvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAE9I,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,
|
|
1
|
+
{"version":3,"file":"styles.js","sourceRoot":"","sources":["../../src/styles.ts"],"names":[],"mappings":"AAEA,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAEvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAE9I,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,UAA0B,EAAU,EAAE,CACjF,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;KACvB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,0BAA0B,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;KACpE,IAAI,CAAC,GAAG,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@voiceflow/slate-serializer",
|
|
3
3
|
"description": "Utilities for serializing slate data",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.6",
|
|
5
5
|
"author": "Ben Teichman",
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/voiceflow/slate-serializer/issues"
|
|
@@ -11,15 +11,13 @@
|
|
|
11
11
|
"path": "./node_modules/cz-conventional-changelog"
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
|
-
"dependencies": {
|
|
15
|
-
"@voiceflow/base-types": "2.68.1"
|
|
16
|
-
},
|
|
17
14
|
"devDependencies": {
|
|
18
|
-
"@types/react": "^17.0.2",
|
|
19
15
|
"@commitlint/cli": "17.1.2",
|
|
20
16
|
"@istanbuljs/nyc-config-typescript": "1.0.2",
|
|
21
17
|
"@types/chai": "4.3.3",
|
|
22
18
|
"@types/mocha": "9.1.1",
|
|
19
|
+
"@types/react": "^17.0.2",
|
|
20
|
+
"@voiceflow/base-types": "^2.67.0",
|
|
23
21
|
"@voiceflow/commitlint-config": "2.0.0",
|
|
24
22
|
"@voiceflow/eslint-config": "7.0.0",
|
|
25
23
|
"@voiceflow/git-branch-check": "1.4.0",
|
|
@@ -72,6 +70,7 @@
|
|
|
72
70
|
"license": "ISC",
|
|
73
71
|
"main": "build/cjs/index.js",
|
|
74
72
|
"peerDependencies": {
|
|
73
|
+
"@voiceflow/base-types": "^2.67.0",
|
|
75
74
|
"react": "^17.0.2",
|
|
76
75
|
"slate": "^0.72.3"
|
|
77
76
|
},
|
|
@@ -108,5 +107,8 @@
|
|
|
108
107
|
"./build/esm/serializers/jsx.d.ts"
|
|
109
108
|
]
|
|
110
109
|
}
|
|
110
|
+
},
|
|
111
|
+
"dependencies": {
|
|
112
|
+
"csstype": "3.1.1"
|
|
111
113
|
}
|
|
112
114
|
}
|