@docen/export-docx 0.0.8 → 0.0.9
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/index.cjs +1 -1
- package/dist/index.d.cts +811 -266
- package/dist/index.d.mts +811 -266
- package/dist/index.d.ts +811 -266
- package/dist/index.mjs +1 -1
- package/package.json +3 -2
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { OutputType, ISectionOptions, IPropertiesOptions, ITableOfContentsOptions, IParagraphStyleOptions, IImageOptions as IImageOptions$1, ITableOptions, IParagraphOptions, ITableRowOptions, ITableCellOptions, OutputByType, FileChild, TextRun, ExternalHyperlink, PositiveUniversalMeasure, Paragraph, ImageRun, Table, TableRow, TableCell } from 'docx';
|
|
2
|
+
import { OutputType, ISectionOptions, IPropertiesOptions, ITableOfContentsOptions, IParagraphStyleOptions, IImageOptions as IImageOptions$1, ITableOptions, IParagraphOptions, ITableRowOptions, ITableCellOptions, OutputByType, FileChild, TextRun, ExternalHyperlink, PositiveUniversalMeasure as PositiveUniversalMeasure$1, Paragraph, ImageRun, Table, TableRow, TableCell } from 'docx';
|
|
3
3
|
import { ImageMeta } from 'image-meta';
|
|
4
4
|
|
|
5
5
|
declare class OrderedMap$1<T = any> {
|
|
@@ -129,7 +129,7 @@ declare class DOMSerializer$1 {
|
|
|
129
129
|
The node serialization functions.
|
|
130
130
|
*/
|
|
131
131
|
readonly nodes: {
|
|
132
|
-
[node: string]: (node: Node$
|
|
132
|
+
[node: string]: (node: Node$4) => DOMOutputSpec$1;
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
135
|
The mark serialization functions.
|
|
@@ -151,7 +151,7 @@ declare class DOMSerializer$1 {
|
|
|
151
151
|
The node serialization functions.
|
|
152
152
|
*/
|
|
153
153
|
nodes: {
|
|
154
|
-
[node: string]: (node: Node$
|
|
154
|
+
[node: string]: (node: Node$4) => DOMOutputSpec$1;
|
|
155
155
|
},
|
|
156
156
|
/**
|
|
157
157
|
The mark serialization functions.
|
|
@@ -175,7 +175,7 @@ declare class DOMSerializer$1 {
|
|
|
175
175
|
[`serializeFragment`](https://prosemirror.net/docs/ref/#model.DOMSerializer.serializeFragment) on
|
|
176
176
|
its [content](https://prosemirror.net/docs/ref/#model.Node.content).
|
|
177
177
|
*/
|
|
178
|
-
serializeNode(node: Node$
|
|
178
|
+
serializeNode(node: Node$4, options?: {
|
|
179
179
|
document?: Document;
|
|
180
180
|
}): globalThis.Node;
|
|
181
181
|
/**
|
|
@@ -197,7 +197,7 @@ declare class DOMSerializer$1 {
|
|
|
197
197
|
This can be useful as a base to build a custom serializer from.
|
|
198
198
|
*/
|
|
199
199
|
static nodesFromSchema(schema: Schema$1): {
|
|
200
|
-
[node: string]: (node: Node$
|
|
200
|
+
[node: string]: (node: Node$4) => DOMOutputSpec$1;
|
|
201
201
|
};
|
|
202
202
|
/**
|
|
203
203
|
Gather the serializers in a schema's mark specs into an object.
|
|
@@ -237,16 +237,16 @@ declare class ResolvedPos$1 {
|
|
|
237
237
|
a position points into a text node, that node is not considered
|
|
238
238
|
the parent—text nodes are ‘flat’ in this model, and have no content.
|
|
239
239
|
*/
|
|
240
|
-
get parent(): Node$
|
|
240
|
+
get parent(): Node$4;
|
|
241
241
|
/**
|
|
242
242
|
The root node in which the position was resolved.
|
|
243
243
|
*/
|
|
244
|
-
get doc(): Node$
|
|
244
|
+
get doc(): Node$4;
|
|
245
245
|
/**
|
|
246
246
|
The ancestor node at the given level. `p.node(p.depth)` is the
|
|
247
247
|
same as `p.parent`.
|
|
248
248
|
*/
|
|
249
|
-
node(depth?: number | null): Node$
|
|
249
|
+
node(depth?: number | null): Node$4;
|
|
250
250
|
/**
|
|
251
251
|
The index into the ancestor at the given level. If this points
|
|
252
252
|
at the 3rd node in the 2nd paragraph on the top level, for
|
|
@@ -290,13 +290,13 @@ declare class ResolvedPos$1 {
|
|
|
290
290
|
points into a text node, only the part of that node after the
|
|
291
291
|
position is returned.
|
|
292
292
|
*/
|
|
293
|
-
get nodeAfter(): Node$
|
|
293
|
+
get nodeAfter(): Node$4 | null;
|
|
294
294
|
/**
|
|
295
295
|
Get the node directly before the position, if any. If the
|
|
296
296
|
position points into a text node, only the part of that node
|
|
297
297
|
before the position is returned.
|
|
298
298
|
*/
|
|
299
|
-
get nodeBefore(): Node$
|
|
299
|
+
get nodeBefore(): Node$4 | null;
|
|
300
300
|
/**
|
|
301
301
|
Get the position at the given index in the parent node at the
|
|
302
302
|
given depth (which defaults to `this.depth`).
|
|
@@ -332,7 +332,7 @@ declare class ResolvedPos$1 {
|
|
|
332
332
|
pass in an optional predicate that will be called with a parent
|
|
333
333
|
node to see if a range into that parent is acceptable.
|
|
334
334
|
*/
|
|
335
|
-
blockRange(other?: ResolvedPos$1, pred?: (node: Node$
|
|
335
|
+
blockRange(other?: ResolvedPos$1, pred?: (node: Node$4) => boolean): NodeRange$1 | null;
|
|
336
336
|
/**
|
|
337
337
|
Query whether the given position shares the same parent node.
|
|
338
338
|
*/
|
|
@@ -400,7 +400,7 @@ declare class NodeRange$1 {
|
|
|
400
400
|
/**
|
|
401
401
|
The parent node that the range points into.
|
|
402
402
|
*/
|
|
403
|
-
get parent(): Node$
|
|
403
|
+
get parent(): Node$4;
|
|
404
404
|
/**
|
|
405
405
|
The start index of the range in the parent node.
|
|
406
406
|
*/
|
|
@@ -519,7 +519,7 @@ interface ParseOptions$1 {
|
|
|
519
519
|
option to use the type and attributes from a different node
|
|
520
520
|
as the top container.
|
|
521
521
|
*/
|
|
522
|
-
topNode?: Node$
|
|
522
|
+
topNode?: Node$4;
|
|
523
523
|
/**
|
|
524
524
|
Provide the starting content match that content parsed into the
|
|
525
525
|
top node is matched against.
|
|
@@ -709,7 +709,7 @@ declare class DOMParser$1 {
|
|
|
709
709
|
/**
|
|
710
710
|
Parse a document from the content of a DOM node.
|
|
711
711
|
*/
|
|
712
|
-
parse(dom: DOMNode$3, options?: ParseOptions$1): Node$
|
|
712
|
+
parse(dom: DOMNode$3, options?: ParseOptions$1): Node$4;
|
|
713
713
|
/**
|
|
714
714
|
Parses the content of the given DOM node, like
|
|
715
715
|
[`parse`](https://prosemirror.net/docs/ref/#model.DOMParser.parse), and takes the same set of
|
|
@@ -817,13 +817,13 @@ declare class NodeType$3 {
|
|
|
817
817
|
`null`. Similarly `marks` may be `null` to default to the empty
|
|
818
818
|
set of marks.
|
|
819
819
|
*/
|
|
820
|
-
create(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$
|
|
820
|
+
create(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$4 | readonly Node$4[] | null, marks?: readonly Mark$4[]): Node$4;
|
|
821
821
|
/**
|
|
822
822
|
Like [`create`](https://prosemirror.net/docs/ref/#model.NodeType.create), but check the given content
|
|
823
823
|
against the node type's content restrictions, and throw an error
|
|
824
824
|
if it doesn't match.
|
|
825
825
|
*/
|
|
826
|
-
createChecked(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$
|
|
826
|
+
createChecked(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$4 | readonly Node$4[] | null, marks?: readonly Mark$4[]): Node$4;
|
|
827
827
|
/**
|
|
828
828
|
Like [`create`](https://prosemirror.net/docs/ref/#model.NodeType.create), but see if it is
|
|
829
829
|
necessary to add nodes to the start or end of the given fragment
|
|
@@ -832,7 +832,7 @@ declare class NodeType$3 {
|
|
|
832
832
|
always be created, this will always succeed if you pass null or
|
|
833
833
|
`Fragment.empty` as content.
|
|
834
834
|
*/
|
|
835
|
-
createAndFill(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$
|
|
835
|
+
createAndFill(attrs?: Attrs$1 | null, content?: Fragment$1 | Node$4 | readonly Node$4[] | null, marks?: readonly Mark$4[]): Node$4 | null;
|
|
836
836
|
/**
|
|
837
837
|
Returns true if the given fragment is valid content for this node
|
|
838
838
|
type.
|
|
@@ -1030,7 +1030,7 @@ interface NodeSpec$1 {
|
|
|
1030
1030
|
differently, this is not supported inside the editor, so you
|
|
1031
1031
|
shouldn't override that in your text node spec.
|
|
1032
1032
|
*/
|
|
1033
|
-
toDOM?: (node: Node$
|
|
1033
|
+
toDOM?: (node: Node$4) => DOMOutputSpec$1;
|
|
1034
1034
|
/**
|
|
1035
1035
|
Associates DOM parser information with this node, which can be
|
|
1036
1036
|
used by [`DOMParser.fromSchema`](https://prosemirror.net/docs/ref/#model.DOMParser^fromSchema) to
|
|
@@ -1044,14 +1044,14 @@ interface NodeSpec$1 {
|
|
|
1044
1044
|
Defines the default way a node of this type should be serialized
|
|
1045
1045
|
to a string representation for debugging (e.g. in error messages).
|
|
1046
1046
|
*/
|
|
1047
|
-
toDebugString?: (node: Node$
|
|
1047
|
+
toDebugString?: (node: Node$4) => string;
|
|
1048
1048
|
/**
|
|
1049
1049
|
Defines the default way a [leaf node](https://prosemirror.net/docs/ref/#model.NodeType.isLeaf) of
|
|
1050
1050
|
this type should be serialized to a string (as used by
|
|
1051
1051
|
[`Node.textBetween`](https://prosemirror.net/docs/ref/#model.Node.textBetween) and
|
|
1052
1052
|
[`Node.textContent`](https://prosemirror.net/docs/ref/#model.Node.textContent)).
|
|
1053
1053
|
*/
|
|
1054
|
-
leafText?: (node: Node$
|
|
1054
|
+
leafText?: (node: Node$4) => string;
|
|
1055
1055
|
/**
|
|
1056
1056
|
A single inline node in a schema can be set to be a linebreak
|
|
1057
1057
|
equivalent. When converting between block types that support the
|
|
@@ -1225,12 +1225,12 @@ declare class Schema$1<Nodes extends string = any, Marks extends string = any> {
|
|
|
1225
1225
|
`content` may be a `Fragment`, `null`, a `Node`, or an array of
|
|
1226
1226
|
nodes.
|
|
1227
1227
|
*/
|
|
1228
|
-
node(type: string | NodeType$3, attrs?: Attrs$1 | null, content?: Fragment$1 | Node$
|
|
1228
|
+
node(type: string | NodeType$3, attrs?: Attrs$1 | null, content?: Fragment$1 | Node$4 | readonly Node$4[], marks?: readonly Mark$4[]): Node$4;
|
|
1229
1229
|
/**
|
|
1230
1230
|
Create a text node in the schema. Empty text nodes are not
|
|
1231
1231
|
allowed.
|
|
1232
1232
|
*/
|
|
1233
|
-
text(text: string, marks?: readonly Mark$4[] | null): Node$
|
|
1233
|
+
text(text: string, marks?: readonly Mark$4[] | null): Node$4;
|
|
1234
1234
|
/**
|
|
1235
1235
|
Create a mark with the given type and attributes.
|
|
1236
1236
|
*/
|
|
@@ -1239,7 +1239,7 @@ declare class Schema$1<Nodes extends string = any, Marks extends string = any> {
|
|
|
1239
1239
|
Deserialize a node from its JSON representation. This method is
|
|
1240
1240
|
bound.
|
|
1241
1241
|
*/
|
|
1242
|
-
nodeFromJSON: (json: any) => Node$
|
|
1242
|
+
nodeFromJSON: (json: any) => Node$4;
|
|
1243
1243
|
/**
|
|
1244
1244
|
Deserialize a mark from its JSON representation. This method is
|
|
1245
1245
|
bound.
|
|
@@ -1258,7 +1258,7 @@ declare class Fragment$1 {
|
|
|
1258
1258
|
/**
|
|
1259
1259
|
The child nodes in this fragment.
|
|
1260
1260
|
*/
|
|
1261
|
-
readonly content: readonly Node$
|
|
1261
|
+
readonly content: readonly Node$4[];
|
|
1262
1262
|
/**
|
|
1263
1263
|
The size of the fragment, which is the total of the size of
|
|
1264
1264
|
its content nodes.
|
|
@@ -1269,18 +1269,18 @@ declare class Fragment$1 {
|
|
|
1269
1269
|
positions (relative to start of this fragment). Doesn't descend
|
|
1270
1270
|
into a node when the callback returns `false`.
|
|
1271
1271
|
*/
|
|
1272
|
-
nodesBetween(from: number, to: number, f: (node: Node$
|
|
1272
|
+
nodesBetween(from: number, to: number, f: (node: Node$4, start: number, parent: Node$4 | null, index: number) => boolean | void, nodeStart?: number, parent?: Node$4): void;
|
|
1273
1273
|
/**
|
|
1274
1274
|
Call the given callback for every descendant node. `pos` will be
|
|
1275
1275
|
relative to the start of the fragment. The callback may return
|
|
1276
1276
|
`false` to prevent traversal of a given node's children.
|
|
1277
1277
|
*/
|
|
1278
|
-
descendants(f: (node: Node$
|
|
1278
|
+
descendants(f: (node: Node$4, pos: number, parent: Node$4 | null, index: number) => boolean | void): void;
|
|
1279
1279
|
/**
|
|
1280
1280
|
Extract the text between `from` and `to`. See the same method on
|
|
1281
1281
|
[`Node`](https://prosemirror.net/docs/ref/#model.Node.textBetween).
|
|
1282
1282
|
*/
|
|
1283
|
-
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: string | null | ((leafNode: Node$
|
|
1283
|
+
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: string | null | ((leafNode: Node$4) => string)): string;
|
|
1284
1284
|
/**
|
|
1285
1285
|
Create a new fragment containing the combined content of this
|
|
1286
1286
|
fragment and the other.
|
|
@@ -1294,17 +1294,17 @@ declare class Fragment$1 {
|
|
|
1294
1294
|
Create a new fragment in which the node at the given index is
|
|
1295
1295
|
replaced by the given node.
|
|
1296
1296
|
*/
|
|
1297
|
-
replaceChild(index: number, node: Node$
|
|
1297
|
+
replaceChild(index: number, node: Node$4): Fragment$1;
|
|
1298
1298
|
/**
|
|
1299
1299
|
Create a new fragment by prepending the given node to this
|
|
1300
1300
|
fragment.
|
|
1301
1301
|
*/
|
|
1302
|
-
addToStart(node: Node$
|
|
1302
|
+
addToStart(node: Node$4): Fragment$1;
|
|
1303
1303
|
/**
|
|
1304
1304
|
Create a new fragment by appending the given node to this
|
|
1305
1305
|
fragment.
|
|
1306
1306
|
*/
|
|
1307
|
-
addToEnd(node: Node$
|
|
1307
|
+
addToEnd(node: Node$4): Fragment$1;
|
|
1308
1308
|
/**
|
|
1309
1309
|
Compare this fragment to another one.
|
|
1310
1310
|
*/
|
|
@@ -1312,11 +1312,11 @@ declare class Fragment$1 {
|
|
|
1312
1312
|
/**
|
|
1313
1313
|
The first child of the fragment, or `null` if it is empty.
|
|
1314
1314
|
*/
|
|
1315
|
-
get firstChild(): Node$
|
|
1315
|
+
get firstChild(): Node$4 | null;
|
|
1316
1316
|
/**
|
|
1317
1317
|
The last child of the fragment, or `null` if it is empty.
|
|
1318
1318
|
*/
|
|
1319
|
-
get lastChild(): Node$
|
|
1319
|
+
get lastChild(): Node$4 | null;
|
|
1320
1320
|
/**
|
|
1321
1321
|
The number of child nodes in this fragment.
|
|
1322
1322
|
*/
|
|
@@ -1325,16 +1325,16 @@ declare class Fragment$1 {
|
|
|
1325
1325
|
Get the child node at the given index. Raise an error when the
|
|
1326
1326
|
index is out of range.
|
|
1327
1327
|
*/
|
|
1328
|
-
child(index: number): Node$
|
|
1328
|
+
child(index: number): Node$4;
|
|
1329
1329
|
/**
|
|
1330
1330
|
Get the child node at the given index, if it exists.
|
|
1331
1331
|
*/
|
|
1332
|
-
maybeChild(index: number): Node$
|
|
1332
|
+
maybeChild(index: number): Node$4 | null;
|
|
1333
1333
|
/**
|
|
1334
1334
|
Call `f` for every child node, passing the node, its offset
|
|
1335
1335
|
into this parent node, and its index.
|
|
1336
1336
|
*/
|
|
1337
|
-
forEach(f: (node: Node$
|
|
1337
|
+
forEach(f: (node: Node$4, offset: number, index: number) => void): void;
|
|
1338
1338
|
/**
|
|
1339
1339
|
Find the first position at which this fragment and another
|
|
1340
1340
|
fragment differ, or `null` if they are the same.
|
|
@@ -1366,14 +1366,14 @@ declare class Fragment$1 {
|
|
|
1366
1366
|
Build a fragment from an array of nodes. Ensures that adjacent
|
|
1367
1367
|
text nodes with the same marks are joined together.
|
|
1368
1368
|
*/
|
|
1369
|
-
static fromArray(array: readonly Node$
|
|
1369
|
+
static fromArray(array: readonly Node$4[]): Fragment$1;
|
|
1370
1370
|
/**
|
|
1371
1371
|
Create a fragment from something that can be interpreted as a
|
|
1372
1372
|
set of nodes. For `null`, it returns the empty fragment. For a
|
|
1373
1373
|
fragment, the fragment itself. For a node or array of nodes, a
|
|
1374
1374
|
fragment containing those nodes.
|
|
1375
1375
|
*/
|
|
1376
|
-
static from(nodes?: Fragment$1 | Node$
|
|
1376
|
+
static from(nodes?: Fragment$1 | Node$4 | readonly Node$4[] | null): Fragment$1;
|
|
1377
1377
|
/**
|
|
1378
1378
|
An empty fragment. Intended to be reused whenever a node doesn't
|
|
1379
1379
|
contain anything (rather than allocating a new empty fragment for
|
|
@@ -1454,7 +1454,7 @@ tree shape like this (without back pointers) makes easy.
|
|
|
1454
1454
|
**Do not** directly mutate the properties of a `Node` object. See
|
|
1455
1455
|
[the guide](https://prosemirror.net/docs/guide/#doc) for more information.
|
|
1456
1456
|
*/
|
|
1457
|
-
declare class Node$
|
|
1457
|
+
declare class Node$4 {
|
|
1458
1458
|
/**
|
|
1459
1459
|
The type of node that this is.
|
|
1460
1460
|
*/
|
|
@@ -1477,7 +1477,7 @@ declare class Node$3 {
|
|
|
1477
1477
|
/**
|
|
1478
1478
|
The array of this node's child nodes.
|
|
1479
1479
|
*/
|
|
1480
|
-
get children(): readonly Node$
|
|
1480
|
+
get children(): readonly Node$4[];
|
|
1481
1481
|
/**
|
|
1482
1482
|
For text nodes, this contains the node's text content.
|
|
1483
1483
|
*/
|
|
@@ -1498,16 +1498,16 @@ declare class Node$3 {
|
|
|
1498
1498
|
Get the child node at the given index. Raises an error when the
|
|
1499
1499
|
index is out of range.
|
|
1500
1500
|
*/
|
|
1501
|
-
child(index: number): Node$
|
|
1501
|
+
child(index: number): Node$4;
|
|
1502
1502
|
/**
|
|
1503
1503
|
Get the child node at the given index, if it exists.
|
|
1504
1504
|
*/
|
|
1505
|
-
maybeChild(index: number): Node$
|
|
1505
|
+
maybeChild(index: number): Node$4 | null;
|
|
1506
1506
|
/**
|
|
1507
1507
|
Call `f` for every child node, passing the node, its offset
|
|
1508
1508
|
into this parent node, and its index.
|
|
1509
1509
|
*/
|
|
1510
|
-
forEach(f: (node: Node$
|
|
1510
|
+
forEach(f: (node: Node$4, offset: number, index: number) => void): void;
|
|
1511
1511
|
/**
|
|
1512
1512
|
Invoke a callback for all descendant nodes recursively between
|
|
1513
1513
|
the given two positions that are relative to start of this
|
|
@@ -1518,12 +1518,12 @@ declare class Node$3 {
|
|
|
1518
1518
|
recursed over. The last parameter can be used to specify a
|
|
1519
1519
|
starting position to count from.
|
|
1520
1520
|
*/
|
|
1521
|
-
nodesBetween(from: number, to: number, f: (node: Node$
|
|
1521
|
+
nodesBetween(from: number, to: number, f: (node: Node$4, pos: number, parent: Node$4 | null, index: number) => void | boolean, startPos?: number): void;
|
|
1522
1522
|
/**
|
|
1523
1523
|
Call the given callback for every descendant node. Doesn't
|
|
1524
1524
|
descend into a node when the callback returns `false`.
|
|
1525
1525
|
*/
|
|
1526
|
-
descendants(f: (node: Node$
|
|
1526
|
+
descendants(f: (node: Node$4, pos: number, parent: Node$4 | null, index: number) => void | boolean): void;
|
|
1527
1527
|
/**
|
|
1528
1528
|
Concatenates all the text nodes found in this fragment and its
|
|
1529
1529
|
children.
|
|
@@ -1536,26 +1536,26 @@ declare class Node$3 {
|
|
|
1536
1536
|
inserted for every non-text leaf node encountered, otherwise
|
|
1537
1537
|
[`leafText`](https://prosemirror.net/docs/ref/#model.NodeSpec.leafText) will be used.
|
|
1538
1538
|
*/
|
|
1539
|
-
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: null | string | ((leafNode: Node$
|
|
1539
|
+
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: null | string | ((leafNode: Node$4) => string)): string;
|
|
1540
1540
|
/**
|
|
1541
1541
|
Returns this node's first child, or `null` if there are no
|
|
1542
1542
|
children.
|
|
1543
1543
|
*/
|
|
1544
|
-
get firstChild(): Node$
|
|
1544
|
+
get firstChild(): Node$4 | null;
|
|
1545
1545
|
/**
|
|
1546
1546
|
Returns this node's last child, or `null` if there are no
|
|
1547
1547
|
children.
|
|
1548
1548
|
*/
|
|
1549
|
-
get lastChild(): Node$
|
|
1549
|
+
get lastChild(): Node$4 | null;
|
|
1550
1550
|
/**
|
|
1551
1551
|
Test whether two nodes represent the same piece of document.
|
|
1552
1552
|
*/
|
|
1553
|
-
eq(other: Node$
|
|
1553
|
+
eq(other: Node$4): boolean;
|
|
1554
1554
|
/**
|
|
1555
1555
|
Compare the markup (type, attributes, and marks) of this node to
|
|
1556
1556
|
those of another. Returns `true` if both have the same markup.
|
|
1557
1557
|
*/
|
|
1558
|
-
sameMarkup(other: Node$
|
|
1558
|
+
sameMarkup(other: Node$4): boolean;
|
|
1559
1559
|
/**
|
|
1560
1560
|
Check whether this node's markup correspond to the given type,
|
|
1561
1561
|
attributes, and marks.
|
|
@@ -1565,18 +1565,18 @@ declare class Node$3 {
|
|
|
1565
1565
|
Create a new node with the same markup as this node, containing
|
|
1566
1566
|
the given content (or empty, if no content is given).
|
|
1567
1567
|
*/
|
|
1568
|
-
copy(content?: Fragment$1 | null): Node$
|
|
1568
|
+
copy(content?: Fragment$1 | null): Node$4;
|
|
1569
1569
|
/**
|
|
1570
1570
|
Create a copy of this node, with the given set of marks instead
|
|
1571
1571
|
of the node's own marks.
|
|
1572
1572
|
*/
|
|
1573
|
-
mark(marks: readonly Mark$4[]): Node$
|
|
1573
|
+
mark(marks: readonly Mark$4[]): Node$4;
|
|
1574
1574
|
/**
|
|
1575
1575
|
Create a copy of this node with only the content between the
|
|
1576
1576
|
given positions. If `to` is not given, it defaults to the end of
|
|
1577
1577
|
the node.
|
|
1578
1578
|
*/
|
|
1579
|
-
cut(from: number, to?: number): Node$
|
|
1579
|
+
cut(from: number, to?: number): Node$4;
|
|
1580
1580
|
/**
|
|
1581
1581
|
Cut out the part of the document between the given positions, and
|
|
1582
1582
|
return it as a `Slice` object.
|
|
@@ -1590,18 +1590,18 @@ declare class Node$3 {
|
|
|
1590
1590
|
into. If any of this is violated, an error of type
|
|
1591
1591
|
[`ReplaceError`](https://prosemirror.net/docs/ref/#model.ReplaceError) is thrown.
|
|
1592
1592
|
*/
|
|
1593
|
-
replace(from: number, to: number, slice: Slice$1): Node$
|
|
1593
|
+
replace(from: number, to: number, slice: Slice$1): Node$4;
|
|
1594
1594
|
/**
|
|
1595
1595
|
Find the node directly after the given position.
|
|
1596
1596
|
*/
|
|
1597
|
-
nodeAt(pos: number): Node$
|
|
1597
|
+
nodeAt(pos: number): Node$4 | null;
|
|
1598
1598
|
/**
|
|
1599
1599
|
Find the (direct) child node after the given offset, if any,
|
|
1600
1600
|
and return it along with its index and offset relative to this
|
|
1601
1601
|
node.
|
|
1602
1602
|
*/
|
|
1603
1603
|
childAfter(pos: number): {
|
|
1604
|
-
node: Node$
|
|
1604
|
+
node: Node$4 | null;
|
|
1605
1605
|
index: number;
|
|
1606
1606
|
offset: number;
|
|
1607
1607
|
};
|
|
@@ -1611,7 +1611,7 @@ declare class Node$3 {
|
|
|
1611
1611
|
node.
|
|
1612
1612
|
*/
|
|
1613
1613
|
childBefore(pos: number): {
|
|
1614
|
-
node: Node$
|
|
1614
|
+
node: Node$4 | null;
|
|
1615
1615
|
index: number;
|
|
1616
1616
|
offset: number;
|
|
1617
1617
|
};
|
|
@@ -1687,7 +1687,7 @@ declare class Node$3 {
|
|
|
1687
1687
|
is at least one node type that can appear in both nodes (to avoid
|
|
1688
1688
|
merging completely incompatible nodes).
|
|
1689
1689
|
*/
|
|
1690
|
-
canAppend(other: Node$
|
|
1690
|
+
canAppend(other: Node$4): boolean;
|
|
1691
1691
|
/**
|
|
1692
1692
|
Check whether this node and its descendants conform to the
|
|
1693
1693
|
schema, and raise an exception when they do not.
|
|
@@ -1700,7 +1700,7 @@ declare class Node$3 {
|
|
|
1700
1700
|
/**
|
|
1701
1701
|
Deserialize a node from its JSON representation.
|
|
1702
1702
|
*/
|
|
1703
|
-
static fromJSON(schema: Schema$1, json: any): Node$
|
|
1703
|
+
static fromJSON(schema: Schema$1, json: any): Node$4;
|
|
1704
1704
|
}
|
|
1705
1705
|
|
|
1706
1706
|
/**
|
|
@@ -1898,7 +1898,7 @@ declare abstract class Step$1 {
|
|
|
1898
1898
|
applied to this document, or indicates success by containing a
|
|
1899
1899
|
transformed document.
|
|
1900
1900
|
*/
|
|
1901
|
-
abstract apply(doc: Node$
|
|
1901
|
+
abstract apply(doc: Node$4): StepResult$1;
|
|
1902
1902
|
/**
|
|
1903
1903
|
Get the step map that represents the changes made by this step,
|
|
1904
1904
|
and which can be used to transform between positions in the old
|
|
@@ -1909,7 +1909,7 @@ declare abstract class Step$1 {
|
|
|
1909
1909
|
Create an inverted version of this step. Needs the document as it
|
|
1910
1910
|
was before the step as argument.
|
|
1911
1911
|
*/
|
|
1912
|
-
abstract invert(doc: Node$
|
|
1912
|
+
abstract invert(doc: Node$4): Step$1;
|
|
1913
1913
|
/**
|
|
1914
1914
|
Map this step through a mappable thing, returning either a
|
|
1915
1915
|
version of that step with its positions adjusted, or `null` if
|
|
@@ -1954,7 +1954,7 @@ declare class StepResult$1 {
|
|
|
1954
1954
|
/**
|
|
1955
1955
|
The transformed document, if successful.
|
|
1956
1956
|
*/
|
|
1957
|
-
readonly doc: Node$
|
|
1957
|
+
readonly doc: Node$4 | null;
|
|
1958
1958
|
/**
|
|
1959
1959
|
The failure message, if unsuccessful.
|
|
1960
1960
|
*/
|
|
@@ -1962,7 +1962,7 @@ declare class StepResult$1 {
|
|
|
1962
1962
|
/**
|
|
1963
1963
|
Create a successful step result.
|
|
1964
1964
|
*/
|
|
1965
|
-
static ok(doc: Node$
|
|
1965
|
+
static ok(doc: Node$4): StepResult$1;
|
|
1966
1966
|
/**
|
|
1967
1967
|
Create a failed step result.
|
|
1968
1968
|
*/
|
|
@@ -1972,7 +1972,7 @@ declare class StepResult$1 {
|
|
|
1972
1972
|
arguments. Create a successful result if it succeeds, and a
|
|
1973
1973
|
failed one if it throws a `ReplaceError`.
|
|
1974
1974
|
*/
|
|
1975
|
-
static fromReplace(doc: Node$
|
|
1975
|
+
static fromReplace(doc: Node$4, from: number, to: number, slice: Slice$1): StepResult$1;
|
|
1976
1976
|
}
|
|
1977
1977
|
|
|
1978
1978
|
/**
|
|
@@ -1987,7 +1987,7 @@ declare class Transform$1 {
|
|
|
1987
1987
|
The current document (the result of applying the steps in the
|
|
1988
1988
|
transform).
|
|
1989
1989
|
*/
|
|
1990
|
-
doc: Node$
|
|
1990
|
+
doc: Node$4;
|
|
1991
1991
|
/**
|
|
1992
1992
|
The steps in this transform.
|
|
1993
1993
|
*/
|
|
@@ -1995,7 +1995,7 @@ declare class Transform$1 {
|
|
|
1995
1995
|
/**
|
|
1996
1996
|
The documents before each of the steps.
|
|
1997
1997
|
*/
|
|
1998
|
-
readonly docs: Node$
|
|
1998
|
+
readonly docs: Node$4[];
|
|
1999
1999
|
/**
|
|
2000
2000
|
A mapping with the maps for each of the steps in this transform.
|
|
2001
2001
|
*/
|
|
@@ -2008,11 +2008,11 @@ declare class Transform$1 {
|
|
|
2008
2008
|
The current document (the result of applying the steps in the
|
|
2009
2009
|
transform).
|
|
2010
2010
|
*/
|
|
2011
|
-
doc: Node$
|
|
2011
|
+
doc: Node$4);
|
|
2012
2012
|
/**
|
|
2013
2013
|
The starting document.
|
|
2014
2014
|
*/
|
|
2015
|
-
get before(): Node$
|
|
2015
|
+
get before(): Node$4;
|
|
2016
2016
|
/**
|
|
2017
2017
|
Apply a new step in this transform, saving the result. Throws an
|
|
2018
2018
|
error when the step fails.
|
|
@@ -2037,7 +2037,7 @@ declare class Transform$1 {
|
|
|
2037
2037
|
Replace the given range with the given content, which may be a
|
|
2038
2038
|
fragment, node, or array of nodes.
|
|
2039
2039
|
*/
|
|
2040
|
-
replaceWith(from: number, to: number, content: Fragment$1 | Node$
|
|
2040
|
+
replaceWith(from: number, to: number, content: Fragment$1 | Node$4 | readonly Node$4[]): this;
|
|
2041
2041
|
/**
|
|
2042
2042
|
Delete the content between the given positions.
|
|
2043
2043
|
*/
|
|
@@ -2045,7 +2045,7 @@ declare class Transform$1 {
|
|
|
2045
2045
|
/**
|
|
2046
2046
|
Insert the given content at the given position.
|
|
2047
2047
|
*/
|
|
2048
|
-
insert(pos: number, content: Fragment$1 | Node$
|
|
2048
|
+
insert(pos: number, content: Fragment$1 | Node$4 | readonly Node$4[]): this;
|
|
2049
2049
|
/**
|
|
2050
2050
|
Replace a range of the document with a given slice, using
|
|
2051
2051
|
`from`, `to`, and the slice's
|
|
@@ -2075,7 +2075,7 @@ declare class Transform$1 {
|
|
|
2075
2075
|
completely covers a parent node, this method may completely replace
|
|
2076
2076
|
that parent node.
|
|
2077
2077
|
*/
|
|
2078
|
-
replaceRangeWith(from: number, to: number, node: Node$
|
|
2078
|
+
replaceRangeWith(from: number, to: number, node: Node$4): this;
|
|
2079
2079
|
/**
|
|
2080
2080
|
Delete the given range, expanding it to cover fully covered
|
|
2081
2081
|
parent nodes until a valid replace is found.
|
|
@@ -2107,7 +2107,7 @@ declare class Transform$1 {
|
|
|
2107
2107
|
Set the type of all textblocks (partly) between `from` and `to` to
|
|
2108
2108
|
the given node type with the given attributes.
|
|
2109
2109
|
*/
|
|
2110
|
-
setBlockType(from: number, to: number | undefined, type: NodeType$3, attrs?: Attrs$1 | null | ((oldNode: Node$
|
|
2110
|
+
setBlockType(from: number, to: number | undefined, type: NodeType$3, attrs?: Attrs$1 | null | ((oldNode: Node$4) => Attrs$1)): this;
|
|
2111
2111
|
/**
|
|
2112
2112
|
Change the type, attributes, and/or marks of the node at `pos`.
|
|
2113
2113
|
When `type` isn't given, the existing node type is preserved,
|
|
@@ -2330,11 +2330,11 @@ interface DecorationSource$1 {
|
|
|
2330
2330
|
Map the set of decorations in response to a change in the
|
|
2331
2331
|
document.
|
|
2332
2332
|
*/
|
|
2333
|
-
map: (mapping: Mapping$1, node: Node$
|
|
2333
|
+
map: (mapping: Mapping$1, node: Node$4) => DecorationSource$1;
|
|
2334
2334
|
/**
|
|
2335
2335
|
Extract a DecorationSource containing decorations for the given child node at the given offset.
|
|
2336
2336
|
*/
|
|
2337
|
-
forChild(offset: number, child: Node$
|
|
2337
|
+
forChild(offset: number, child: Node$4): DecorationSource$1;
|
|
2338
2338
|
/**
|
|
2339
2339
|
Call the given function for each decoration set in the group.
|
|
2340
2340
|
*/
|
|
@@ -2352,7 +2352,7 @@ declare class DecorationSet$1 implements DecorationSource$1 {
|
|
|
2352
2352
|
document. This will consume (modify) the `decorations` array, so
|
|
2353
2353
|
you must make a copy if you want need to preserve that.
|
|
2354
2354
|
*/
|
|
2355
|
-
static create(doc: Node$
|
|
2355
|
+
static create(doc: Node$4, decorations: Decoration$1[]): DecorationSet$1;
|
|
2356
2356
|
/**
|
|
2357
2357
|
Find all decorations in this set which touch the given range
|
|
2358
2358
|
(including decorations that start or end directly at the
|
|
@@ -2367,7 +2367,7 @@ declare class DecorationSet$1 implements DecorationSource$1 {
|
|
|
2367
2367
|
Map the set of decorations in response to a change in the
|
|
2368
2368
|
document.
|
|
2369
2369
|
*/
|
|
2370
|
-
map(mapping: Mapping$1, doc: Node$
|
|
2370
|
+
map(mapping: Mapping$1, doc: Node$4, options?: {
|
|
2371
2371
|
/**
|
|
2372
2372
|
When given, this function will be called for each decoration
|
|
2373
2373
|
that gets dropped as a result of the mapping, passing the
|
|
@@ -2381,7 +2381,7 @@ declare class DecorationSet$1 implements DecorationSource$1 {
|
|
|
2381
2381
|
access to the current document to create the appropriate tree
|
|
2382
2382
|
structure.
|
|
2383
2383
|
*/
|
|
2384
|
-
add(doc: Node$
|
|
2384
|
+
add(doc: Node$4, decorations: Decoration$1[]): DecorationSet$1;
|
|
2385
2385
|
private addInner;
|
|
2386
2386
|
/**
|
|
2387
2387
|
Create a new set that contains the decorations in this set, minus
|
|
@@ -2389,7 +2389,7 @@ declare class DecorationSet$1 implements DecorationSource$1 {
|
|
|
2389
2389
|
*/
|
|
2390
2390
|
remove(decorations: Decoration$1[]): DecorationSet$1;
|
|
2391
2391
|
private removeInner;
|
|
2392
|
-
forChild(offset: number, node: Node$
|
|
2392
|
+
forChild(offset: number, node: Node$4): DecorationSet$1 | DecorationGroup$1;
|
|
2393
2393
|
/**
|
|
2394
2394
|
The empty set of decorations.
|
|
2395
2395
|
*/
|
|
@@ -2399,10 +2399,10 @@ declare class DecorationSet$1 implements DecorationSource$1 {
|
|
|
2399
2399
|
declare class DecorationGroup$1 implements DecorationSource$1 {
|
|
2400
2400
|
readonly members: readonly DecorationSet$1[];
|
|
2401
2401
|
constructor(members: readonly DecorationSet$1[]);
|
|
2402
|
-
map(mapping: Mapping$1, doc: Node$
|
|
2403
|
-
forChild(offset: number, child: Node$
|
|
2402
|
+
map(mapping: Mapping$1, doc: Node$4): DecorationSource$1;
|
|
2403
|
+
forChild(offset: number, child: Node$4): DecorationSource$1 | DecorationSet$1;
|
|
2404
2404
|
eq(other: DecorationGroup$1): boolean;
|
|
2405
|
-
locals(node: Node$
|
|
2405
|
+
locals(node: Node$4): readonly any[];
|
|
2406
2406
|
static from(members: readonly DecorationSource$1[]): DecorationSource$1;
|
|
2407
2407
|
forEachSet(f: (set: DecorationSet$1) => void): void;
|
|
2408
2408
|
}
|
|
@@ -2458,7 +2458,7 @@ interface NodeView$1 {
|
|
|
2458
2458
|
`contentDOM` property (or no `dom` property), updating its child
|
|
2459
2459
|
nodes will be handled by ProseMirror.
|
|
2460
2460
|
*/
|
|
2461
|
-
update?: (node: Node$
|
|
2461
|
+
update?: (node: Node$4, decorations: readonly Decoration$1[], innerDecorations: DecorationSource$1) => boolean;
|
|
2462
2462
|
/**
|
|
2463
2463
|
By default, `update` will only be called when a node of the same
|
|
2464
2464
|
node type appears in this view's position. When you set this to
|
|
@@ -2767,7 +2767,7 @@ declare class EditorView$1 {
|
|
|
2767
2767
|
The type of function [provided](https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews) to
|
|
2768
2768
|
create [node views](https://prosemirror.net/docs/ref/#view.NodeView).
|
|
2769
2769
|
*/
|
|
2770
|
-
type NodeViewConstructor$1 = (node: Node$
|
|
2770
|
+
type NodeViewConstructor$1 = (node: Node$4, view: EditorView$1, getPos: () => number | undefined, decorations: readonly Decoration$1[], innerDecorations: DecorationSource$1) => NodeView$1;
|
|
2771
2771
|
/**
|
|
2772
2772
|
The function types [used](https://prosemirror.net/docs/ref/#view.EditorProps.markViews) to create
|
|
2773
2773
|
mark views.
|
|
@@ -2831,7 +2831,7 @@ interface EditorProps$1<P = any> {
|
|
|
2831
2831
|
Called for each node around a click, from the inside out. The
|
|
2832
2832
|
`direct` flag will be true for the inner node.
|
|
2833
2833
|
*/
|
|
2834
|
-
handleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$
|
|
2834
|
+
handleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$4, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
2835
2835
|
/**
|
|
2836
2836
|
Called when the editor is clicked, after `handleClickOn` handlers
|
|
2837
2837
|
have been called.
|
|
@@ -2840,7 +2840,7 @@ interface EditorProps$1<P = any> {
|
|
|
2840
2840
|
/**
|
|
2841
2841
|
Called for each node around a double click.
|
|
2842
2842
|
*/
|
|
2843
|
-
handleDoubleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$
|
|
2843
|
+
handleDoubleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$4, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
2844
2844
|
/**
|
|
2845
2845
|
Called when the editor is double-clicked, after `handleDoubleClickOn`.
|
|
2846
2846
|
*/
|
|
@@ -2848,7 +2848,7 @@ interface EditorProps$1<P = any> {
|
|
|
2848
2848
|
/**
|
|
2849
2849
|
Called for each node around a triple click.
|
|
2850
2850
|
*/
|
|
2851
|
-
handleTripleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$
|
|
2851
|
+
handleTripleClickOn?: (this: P, view: EditorView$1, pos: number, node: Node$4, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
2852
2852
|
/**
|
|
2853
2853
|
Called when the editor is triple-clicked, after `handleTripleClickOn`.
|
|
2854
2854
|
*/
|
|
@@ -3075,7 +3075,7 @@ interface EditorStateConfig$1 {
|
|
|
3075
3075
|
The starting document. Either this or `schema` _must_ be
|
|
3076
3076
|
provided.
|
|
3077
3077
|
*/
|
|
3078
|
-
doc?: Node$
|
|
3078
|
+
doc?: Node$4;
|
|
3079
3079
|
/**
|
|
3080
3080
|
A valid selection in the document.
|
|
3081
3081
|
*/
|
|
@@ -3102,7 +3102,7 @@ declare class EditorState$1 {
|
|
|
3102
3102
|
/**
|
|
3103
3103
|
The current document.
|
|
3104
3104
|
*/
|
|
3105
|
-
doc: Node$
|
|
3105
|
+
doc: Node$4;
|
|
3106
3106
|
/**
|
|
3107
3107
|
The selection.
|
|
3108
3108
|
*/
|
|
@@ -3421,7 +3421,7 @@ declare class Transaction$1 extends Transform$1 {
|
|
|
3421
3421
|
true and the content is inline, it inherits the marks from the
|
|
3422
3422
|
place where it is inserted.
|
|
3423
3423
|
*/
|
|
3424
|
-
replaceSelectionWith(node: Node$
|
|
3424
|
+
replaceSelectionWith(node: Node$4, inheritMarks?: boolean): this;
|
|
3425
3425
|
/**
|
|
3426
3426
|
Delete the selection.
|
|
3427
3427
|
*/
|
|
@@ -3527,7 +3527,7 @@ declare abstract class Selection$1 {
|
|
|
3527
3527
|
Map this selection through a [mappable](https://prosemirror.net/docs/ref/#transform.Mappable)
|
|
3528
3528
|
thing. `doc` should be the new document to which we are mapping.
|
|
3529
3529
|
*/
|
|
3530
|
-
abstract map(doc: Node$
|
|
3530
|
+
abstract map(doc: Node$4, mapping: Mappable$1): Selection$1;
|
|
3531
3531
|
/**
|
|
3532
3532
|
Get the content of this selection as a slice.
|
|
3533
3533
|
*/
|
|
@@ -3541,7 +3541,7 @@ declare abstract class Selection$1 {
|
|
|
3541
3541
|
Replace the selection with the given node, appending the changes
|
|
3542
3542
|
to the given transaction.
|
|
3543
3543
|
*/
|
|
3544
|
-
replaceWith(tr: Transaction$1, node: Node$
|
|
3544
|
+
replaceWith(tr: Transaction$1, node: Node$4): void;
|
|
3545
3545
|
/**
|
|
3546
3546
|
Convert the selection to a JSON representation. When implementing
|
|
3547
3547
|
this for a custom selection class, make sure to give the object a
|
|
@@ -3569,17 +3569,17 @@ declare abstract class Selection$1 {
|
|
|
3569
3569
|
[`AllSelection`](https://prosemirror.net/docs/ref/#state.AllSelection) if no valid position
|
|
3570
3570
|
exists.
|
|
3571
3571
|
*/
|
|
3572
|
-
static atStart(doc: Node$
|
|
3572
|
+
static atStart(doc: Node$4): Selection$1;
|
|
3573
3573
|
/**
|
|
3574
3574
|
Find the cursor or leaf node selection closest to the end of the
|
|
3575
3575
|
given document.
|
|
3576
3576
|
*/
|
|
3577
|
-
static atEnd(doc: Node$
|
|
3577
|
+
static atEnd(doc: Node$4): Selection$1;
|
|
3578
3578
|
/**
|
|
3579
3579
|
Deserialize the JSON representation of a selection. Must be
|
|
3580
3580
|
implemented for custom classes (as a static class method).
|
|
3581
3581
|
*/
|
|
3582
|
-
static fromJSON(doc: Node$
|
|
3582
|
+
static fromJSON(doc: Node$4, json: any): Selection$1;
|
|
3583
3583
|
/**
|
|
3584
3584
|
To be able to deserialize selections from JSON, custom selection
|
|
3585
3585
|
classes must register themselves with an ID string, so that they
|
|
@@ -3587,9 +3587,9 @@ declare abstract class Selection$1 {
|
|
|
3587
3587
|
clash with classes from other modules.
|
|
3588
3588
|
*/
|
|
3589
3589
|
static jsonID(id: string, selectionClass: {
|
|
3590
|
-
fromJSON: (doc: Node$
|
|
3590
|
+
fromJSON: (doc: Node$4, json: any) => Selection$1;
|
|
3591
3591
|
}): {
|
|
3592
|
-
fromJSON: (doc: Node$
|
|
3592
|
+
fromJSON: (doc: Node$4, json: any) => Selection$1;
|
|
3593
3593
|
};
|
|
3594
3594
|
/**
|
|
3595
3595
|
Get a [bookmark](https://prosemirror.net/docs/ref/#state.SelectionBookmark) for this selection,
|
|
@@ -3624,7 +3624,7 @@ interface SelectionBookmark$1 {
|
|
|
3624
3624
|
[`TextSelection.between`](https://prosemirror.net/docs/ref/#state.TextSelection^between)) if
|
|
3625
3625
|
mapping made the bookmark invalid.
|
|
3626
3626
|
*/
|
|
3627
|
-
resolve: (doc: Node$
|
|
3627
|
+
resolve: (doc: Node$4) => Selection$1;
|
|
3628
3628
|
}
|
|
3629
3629
|
/**
|
|
3630
3630
|
Represents a selected range in a document.
|
|
@@ -4067,7 +4067,7 @@ interface NodeConfig$1<Options = any, Storage = any> extends ExtendableConfig$1<
|
|
|
4067
4067
|
parent: ParentConfig$1<NodeConfig$1<Options, Storage>>['renderHTML'];
|
|
4068
4068
|
editor?: Editor$1;
|
|
4069
4069
|
}, props: {
|
|
4070
|
-
node: Node$
|
|
4070
|
+
node: Node$4;
|
|
4071
4071
|
HTMLAttributes: Record<string, any>;
|
|
4072
4072
|
}) => DOMOutputSpec$1) | null;
|
|
4073
4073
|
/**
|
|
@@ -4081,9 +4081,9 @@ interface NodeConfig$1<Options = any, Storage = any> extends ExtendableConfig$1<
|
|
|
4081
4081
|
parent: ParentConfig$1<NodeConfig$1<Options, Storage>>['renderText'];
|
|
4082
4082
|
editor?: Editor$1;
|
|
4083
4083
|
}, props: {
|
|
4084
|
-
node: Node$
|
|
4084
|
+
node: Node$4;
|
|
4085
4085
|
pos: number;
|
|
4086
|
-
parent: Node$
|
|
4086
|
+
parent: Node$4;
|
|
4087
4087
|
index: number;
|
|
4088
4088
|
}) => string) | null;
|
|
4089
4089
|
/**
|
|
@@ -4102,21 +4102,21 @@ interface NodeConfig$1<Options = any, Storage = any> extends ExtendableConfig$1<
|
|
|
4102
4102
|
* The Node class is used to create custom node extensions.
|
|
4103
4103
|
* @see https://tiptap.dev/api/extensions#create-a-new-extension
|
|
4104
4104
|
*/
|
|
4105
|
-
declare class Node$
|
|
4105
|
+
declare class Node$3<Options = any, Storage = any> extends Extendable$1<Options, Storage, NodeConfig$1<Options, Storage>> {
|
|
4106
4106
|
type: string;
|
|
4107
4107
|
/**
|
|
4108
4108
|
* Create a new Node instance
|
|
4109
4109
|
* @param config - Node configuration object or a function that returns a configuration object
|
|
4110
4110
|
*/
|
|
4111
|
-
static create<O = any, S = any>(config?: Partial<NodeConfig$1<O, S>> | (() => Partial<NodeConfig$1<O, S>>)): Node$
|
|
4112
|
-
configure(options?: Partial<Options>): Node$
|
|
4111
|
+
static create<O = any, S = any>(config?: Partial<NodeConfig$1<O, S>> | (() => Partial<NodeConfig$1<O, S>>)): Node$3<O, S>;
|
|
4112
|
+
configure(options?: Partial<Options>): Node$3<Options, Storage>;
|
|
4113
4113
|
extend<ExtendedOptions = Options, ExtendedStorage = Storage, ExtendedConfig extends NodeConfig$1<ExtendedOptions, ExtendedStorage> = NodeConfig$1<ExtendedOptions, ExtendedStorage>>(extendedConfig?: (() => Partial<ExtendedConfig>) | (Partial<ExtendedConfig> & ThisType<{
|
|
4114
4114
|
name: string;
|
|
4115
4115
|
options: ExtendedOptions;
|
|
4116
4116
|
storage: ExtendedStorage;
|
|
4117
4117
|
editor: Editor$1;
|
|
4118
4118
|
type: NodeType$3;
|
|
4119
|
-
}>)): Node$
|
|
4119
|
+
}>)): Node$3<ExtendedOptions, ExtendedStorage>;
|
|
4120
4120
|
}
|
|
4121
4121
|
|
|
4122
4122
|
type PasteRuleMatch$1 = {
|
|
@@ -4231,7 +4231,7 @@ interface ExtendableConfig$1<Options = any, Storage = any, Config extends Extens
|
|
|
4231
4231
|
name: string;
|
|
4232
4232
|
options: Options;
|
|
4233
4233
|
storage: Storage;
|
|
4234
|
-
extensions: (Node$
|
|
4234
|
+
extensions: (Node$3 | Mark$3)[];
|
|
4235
4235
|
parent: ParentConfig$1<Config>['addGlobalAttributes'];
|
|
4236
4236
|
}) => GlobalAttributes$1;
|
|
4237
4237
|
/**
|
|
@@ -4397,7 +4397,7 @@ interface ExtendableConfig$1<Options = any, Storage = any, Config extends Extens
|
|
|
4397
4397
|
options: Options;
|
|
4398
4398
|
storage: Storage;
|
|
4399
4399
|
parent: ParentConfig$1<Config>['extendNodeSchema'];
|
|
4400
|
-
}, extension: Node$
|
|
4400
|
+
}, extension: Node$3) => Record<string, any>) | null;
|
|
4401
4401
|
/**
|
|
4402
4402
|
* This function extends the schema of the mark.
|
|
4403
4403
|
* @example
|
|
@@ -4736,7 +4736,7 @@ interface EditorEvents$1 {
|
|
|
4736
4736
|
* The node which the deletion occurred in
|
|
4737
4737
|
* @note This can be a parent node of the deleted content
|
|
4738
4738
|
*/
|
|
4739
|
-
node: Node$
|
|
4739
|
+
node: Node$4;
|
|
4740
4740
|
/**
|
|
4741
4741
|
* The new start position of the node in the document (after the deletion)
|
|
4742
4742
|
*/
|
|
@@ -5139,7 +5139,7 @@ interface NodeViewRendererProps$1 {
|
|
|
5139
5139
|
/**
|
|
5140
5140
|
* The extension that is responsible for the node.
|
|
5141
5141
|
*/
|
|
5142
|
-
extension: Node$
|
|
5142
|
+
extension: Node$3;
|
|
5143
5143
|
/**
|
|
5144
5144
|
* The HTML attributes that should be added to the node's DOM element.
|
|
5145
5145
|
*/
|
|
@@ -5195,9 +5195,9 @@ type Range$1 = {
|
|
|
5195
5195
|
to: number;
|
|
5196
5196
|
};
|
|
5197
5197
|
type TextSerializer$1 = (props: {
|
|
5198
|
-
node: Node$
|
|
5198
|
+
node: Node$4;
|
|
5199
5199
|
pos: number;
|
|
5200
|
-
parent: Node$
|
|
5200
|
+
parent: Node$4;
|
|
5201
5201
|
index: number;
|
|
5202
5202
|
range: Range$1;
|
|
5203
5203
|
}) => string;
|
|
@@ -5438,9 +5438,9 @@ declare class NodePos$1 {
|
|
|
5438
5438
|
private isBlock;
|
|
5439
5439
|
private editor;
|
|
5440
5440
|
private get name();
|
|
5441
|
-
constructor(pos: ResolvedPos$1, editor: Editor$1, isBlock?: boolean, node?: Node$
|
|
5441
|
+
constructor(pos: ResolvedPos$1, editor: Editor$1, isBlock?: boolean, node?: Node$4 | null);
|
|
5442
5442
|
private currentNode;
|
|
5443
|
-
get node(): Node$
|
|
5443
|
+
get node(): Node$4;
|
|
5444
5444
|
get element(): HTMLElement;
|
|
5445
5445
|
actualDepth: number | null;
|
|
5446
5446
|
get depth(): number;
|
|
@@ -5777,7 +5777,7 @@ declare module '@tiptap/core' {
|
|
|
5777
5777
|
/**
|
|
5778
5778
|
* The ProseMirror content to insert.
|
|
5779
5779
|
*/
|
|
5780
|
-
value: Content$1 | Node$
|
|
5780
|
+
value: Content$1 | Node$4 | Fragment$1,
|
|
5781
5781
|
/**
|
|
5782
5782
|
* Optional options
|
|
5783
5783
|
*/
|
|
@@ -5800,7 +5800,7 @@ declare module '@tiptap/core' {
|
|
|
5800
5800
|
/**
|
|
5801
5801
|
* The ProseMirror content to insert.
|
|
5802
5802
|
*/
|
|
5803
|
-
value: Content$1 | Node$
|
|
5803
|
+
value: Content$1 | Node$4 | Fragment$1,
|
|
5804
5804
|
/**
|
|
5805
5805
|
* Optional options
|
|
5806
5806
|
*/
|
|
@@ -6068,7 +6068,7 @@ declare module '@tiptap/core' {
|
|
|
6068
6068
|
/**
|
|
6069
6069
|
* The new content.
|
|
6070
6070
|
*/
|
|
6071
|
-
content: Content$1 | Fragment$1 | Node$
|
|
6071
|
+
content: Content$1 | Fragment$1 | Node$4,
|
|
6072
6072
|
/**
|
|
6073
6073
|
* Options for `setContent`.
|
|
6074
6074
|
*/
|
|
@@ -6642,7 +6642,9 @@ declare function generateDOCX<T extends OutputType>(docJson: JSONContent$1, opti
|
|
|
6642
6642
|
/**
|
|
6643
6643
|
* Convert document content to DOCX elements
|
|
6644
6644
|
*/
|
|
6645
|
-
declare function
|
|
6645
|
+
declare function convertDocument(node: JSONContent$1, params: {
|
|
6646
|
+
options: DocxExportOptions;
|
|
6647
|
+
}): Promise<FileChild[]>;
|
|
6646
6648
|
/**
|
|
6647
6649
|
* Convert a single node to DOCX element(s)
|
|
6648
6650
|
*/
|
|
@@ -6775,7 +6777,7 @@ declare class DOMSerializer {
|
|
|
6775
6777
|
The node serialization functions.
|
|
6776
6778
|
*/
|
|
6777
6779
|
readonly nodes: {
|
|
6778
|
-
[node: string]: (node: Node$1) => DOMOutputSpec;
|
|
6780
|
+
[node: string]: (node: Node$1$1) => DOMOutputSpec;
|
|
6779
6781
|
};
|
|
6780
6782
|
/**
|
|
6781
6783
|
The mark serialization functions.
|
|
@@ -6797,7 +6799,7 @@ declare class DOMSerializer {
|
|
|
6797
6799
|
The node serialization functions.
|
|
6798
6800
|
*/
|
|
6799
6801
|
nodes: {
|
|
6800
|
-
[node: string]: (node: Node$1) => DOMOutputSpec;
|
|
6802
|
+
[node: string]: (node: Node$1$1) => DOMOutputSpec;
|
|
6801
6803
|
},
|
|
6802
6804
|
/**
|
|
6803
6805
|
The mark serialization functions.
|
|
@@ -6821,7 +6823,7 @@ declare class DOMSerializer {
|
|
|
6821
6823
|
[`serializeFragment`](https://prosemirror.net/docs/ref/#model.DOMSerializer.serializeFragment) on
|
|
6822
6824
|
its [content](https://prosemirror.net/docs/ref/#model.Node.content).
|
|
6823
6825
|
*/
|
|
6824
|
-
serializeNode(node: Node$1, options?: {
|
|
6826
|
+
serializeNode(node: Node$1$1, options?: {
|
|
6825
6827
|
document?: Document;
|
|
6826
6828
|
}): globalThis.Node;
|
|
6827
6829
|
/**
|
|
@@ -6843,7 +6845,7 @@ declare class DOMSerializer {
|
|
|
6843
6845
|
This can be useful as a base to build a custom serializer from.
|
|
6844
6846
|
*/
|
|
6845
6847
|
static nodesFromSchema(schema: Schema): {
|
|
6846
|
-
[node: string]: (node: Node$1) => DOMOutputSpec;
|
|
6848
|
+
[node: string]: (node: Node$1$1) => DOMOutputSpec;
|
|
6847
6849
|
};
|
|
6848
6850
|
/**
|
|
6849
6851
|
Gather the serializers in a schema's mark specs into an object.
|
|
@@ -6883,16 +6885,16 @@ declare class ResolvedPos {
|
|
|
6883
6885
|
a position points into a text node, that node is not considered
|
|
6884
6886
|
the parent—text nodes are ‘flat’ in this model, and have no content.
|
|
6885
6887
|
*/
|
|
6886
|
-
get parent(): Node$1;
|
|
6888
|
+
get parent(): Node$1$1;
|
|
6887
6889
|
/**
|
|
6888
6890
|
The root node in which the position was resolved.
|
|
6889
6891
|
*/
|
|
6890
|
-
get doc(): Node$1;
|
|
6892
|
+
get doc(): Node$1$1;
|
|
6891
6893
|
/**
|
|
6892
6894
|
The ancestor node at the given level. `p.node(p.depth)` is the
|
|
6893
6895
|
same as `p.parent`.
|
|
6894
6896
|
*/
|
|
6895
|
-
node(depth?: number | null): Node$1;
|
|
6897
|
+
node(depth?: number | null): Node$1$1;
|
|
6896
6898
|
/**
|
|
6897
6899
|
The index into the ancestor at the given level. If this points
|
|
6898
6900
|
at the 3rd node in the 2nd paragraph on the top level, for
|
|
@@ -6936,13 +6938,13 @@ declare class ResolvedPos {
|
|
|
6936
6938
|
points into a text node, only the part of that node after the
|
|
6937
6939
|
position is returned.
|
|
6938
6940
|
*/
|
|
6939
|
-
get nodeAfter(): Node$1 | null;
|
|
6941
|
+
get nodeAfter(): Node$1$1 | null;
|
|
6940
6942
|
/**
|
|
6941
6943
|
Get the node directly before the position, if any. If the
|
|
6942
6944
|
position points into a text node, only the part of that node
|
|
6943
6945
|
before the position is returned.
|
|
6944
6946
|
*/
|
|
6945
|
-
get nodeBefore(): Node$1 | null;
|
|
6947
|
+
get nodeBefore(): Node$1$1 | null;
|
|
6946
6948
|
/**
|
|
6947
6949
|
Get the position at the given index in the parent node at the
|
|
6948
6950
|
given depth (which defaults to `this.depth`).
|
|
@@ -6978,7 +6980,7 @@ declare class ResolvedPos {
|
|
|
6978
6980
|
pass in an optional predicate that will be called with a parent
|
|
6979
6981
|
node to see if a range into that parent is acceptable.
|
|
6980
6982
|
*/
|
|
6981
|
-
blockRange(other?: ResolvedPos, pred?: (node: Node$1) => boolean): NodeRange | null;
|
|
6983
|
+
blockRange(other?: ResolvedPos, pred?: (node: Node$1$1) => boolean): NodeRange | null;
|
|
6982
6984
|
/**
|
|
6983
6985
|
Query whether the given position shares the same parent node.
|
|
6984
6986
|
*/
|
|
@@ -7046,7 +7048,7 @@ declare class NodeRange {
|
|
|
7046
7048
|
/**
|
|
7047
7049
|
The parent node that the range points into.
|
|
7048
7050
|
*/
|
|
7049
|
-
get parent(): Node$1;
|
|
7051
|
+
get parent(): Node$1$1;
|
|
7050
7052
|
/**
|
|
7051
7053
|
The start index of the range in the parent node.
|
|
7052
7054
|
*/
|
|
@@ -7165,7 +7167,7 @@ interface ParseOptions {
|
|
|
7165
7167
|
option to use the type and attributes from a different node
|
|
7166
7168
|
as the top container.
|
|
7167
7169
|
*/
|
|
7168
|
-
topNode?: Node$1;
|
|
7170
|
+
topNode?: Node$1$1;
|
|
7169
7171
|
/**
|
|
7170
7172
|
Provide the starting content match that content parsed into the
|
|
7171
7173
|
top node is matched against.
|
|
@@ -7355,7 +7357,7 @@ declare class DOMParser {
|
|
|
7355
7357
|
/**
|
|
7356
7358
|
Parse a document from the content of a DOM node.
|
|
7357
7359
|
*/
|
|
7358
|
-
parse(dom: DOMNode$1, options?: ParseOptions): Node$1;
|
|
7360
|
+
parse(dom: DOMNode$1, options?: ParseOptions): Node$1$1;
|
|
7359
7361
|
/**
|
|
7360
7362
|
Parses the content of the given DOM node, like
|
|
7361
7363
|
[`parse`](https://prosemirror.net/docs/ref/#model.DOMParser.parse), and takes the same set of
|
|
@@ -7463,13 +7465,13 @@ declare class NodeType$1 {
|
|
|
7463
7465
|
`null`. Similarly `marks` may be `null` to default to the empty
|
|
7464
7466
|
set of marks.
|
|
7465
7467
|
*/
|
|
7466
|
-
create(attrs?: Attrs | null, content?: Fragment | Node$1 | readonly Node$1[] | null, marks?: readonly Mark$1[]): Node$1;
|
|
7468
|
+
create(attrs?: Attrs | null, content?: Fragment | Node$1$1 | readonly Node$1$1[] | null, marks?: readonly Mark$1[]): Node$1$1;
|
|
7467
7469
|
/**
|
|
7468
7470
|
Like [`create`](https://prosemirror.net/docs/ref/#model.NodeType.create), but check the given content
|
|
7469
7471
|
against the node type's content restrictions, and throw an error
|
|
7470
7472
|
if it doesn't match.
|
|
7471
7473
|
*/
|
|
7472
|
-
createChecked(attrs?: Attrs | null, content?: Fragment | Node$1 | readonly Node$1[] | null, marks?: readonly Mark$1[]): Node$1;
|
|
7474
|
+
createChecked(attrs?: Attrs | null, content?: Fragment | Node$1$1 | readonly Node$1$1[] | null, marks?: readonly Mark$1[]): Node$1$1;
|
|
7473
7475
|
/**
|
|
7474
7476
|
Like [`create`](https://prosemirror.net/docs/ref/#model.NodeType.create), but see if it is
|
|
7475
7477
|
necessary to add nodes to the start or end of the given fragment
|
|
@@ -7478,7 +7480,7 @@ declare class NodeType$1 {
|
|
|
7478
7480
|
always be created, this will always succeed if you pass null or
|
|
7479
7481
|
`Fragment.empty` as content.
|
|
7480
7482
|
*/
|
|
7481
|
-
createAndFill(attrs?: Attrs | null, content?: Fragment | Node$1 | readonly Node$1[] | null, marks?: readonly Mark$1[]): Node$1 | null;
|
|
7483
|
+
createAndFill(attrs?: Attrs | null, content?: Fragment | Node$1$1 | readonly Node$1$1[] | null, marks?: readonly Mark$1[]): Node$1$1 | null;
|
|
7482
7484
|
/**
|
|
7483
7485
|
Returns true if the given fragment is valid content for this node
|
|
7484
7486
|
type.
|
|
@@ -7676,7 +7678,7 @@ interface NodeSpec {
|
|
|
7676
7678
|
differently, this is not supported inside the editor, so you
|
|
7677
7679
|
shouldn't override that in your text node spec.
|
|
7678
7680
|
*/
|
|
7679
|
-
toDOM?: (node: Node$1) => DOMOutputSpec;
|
|
7681
|
+
toDOM?: (node: Node$1$1) => DOMOutputSpec;
|
|
7680
7682
|
/**
|
|
7681
7683
|
Associates DOM parser information with this node, which can be
|
|
7682
7684
|
used by [`DOMParser.fromSchema`](https://prosemirror.net/docs/ref/#model.DOMParser^fromSchema) to
|
|
@@ -7690,14 +7692,14 @@ interface NodeSpec {
|
|
|
7690
7692
|
Defines the default way a node of this type should be serialized
|
|
7691
7693
|
to a string representation for debugging (e.g. in error messages).
|
|
7692
7694
|
*/
|
|
7693
|
-
toDebugString?: (node: Node$1) => string;
|
|
7695
|
+
toDebugString?: (node: Node$1$1) => string;
|
|
7694
7696
|
/**
|
|
7695
7697
|
Defines the default way a [leaf node](https://prosemirror.net/docs/ref/#model.NodeType.isLeaf) of
|
|
7696
7698
|
this type should be serialized to a string (as used by
|
|
7697
7699
|
[`Node.textBetween`](https://prosemirror.net/docs/ref/#model.Node.textBetween) and
|
|
7698
7700
|
[`Node.textContent`](https://prosemirror.net/docs/ref/#model.Node.textContent)).
|
|
7699
7701
|
*/
|
|
7700
|
-
leafText?: (node: Node$1) => string;
|
|
7702
|
+
leafText?: (node: Node$1$1) => string;
|
|
7701
7703
|
/**
|
|
7702
7704
|
A single inline node in a schema can be set to be a linebreak
|
|
7703
7705
|
equivalent. When converting between block types that support the
|
|
@@ -7871,12 +7873,12 @@ declare class Schema<Nodes extends string = any, Marks extends string = any> {
|
|
|
7871
7873
|
`content` may be a `Fragment`, `null`, a `Node`, or an array of
|
|
7872
7874
|
nodes.
|
|
7873
7875
|
*/
|
|
7874
|
-
node(type: string | NodeType$1, attrs?: Attrs | null, content?: Fragment | Node$1 | readonly Node$1[], marks?: readonly Mark$1[]): Node$1;
|
|
7876
|
+
node(type: string | NodeType$1, attrs?: Attrs | null, content?: Fragment | Node$1$1 | readonly Node$1$1[], marks?: readonly Mark$1[]): Node$1$1;
|
|
7875
7877
|
/**
|
|
7876
7878
|
Create a text node in the schema. Empty text nodes are not
|
|
7877
7879
|
allowed.
|
|
7878
7880
|
*/
|
|
7879
|
-
text(text: string, marks?: readonly Mark$1[] | null): Node$1;
|
|
7881
|
+
text(text: string, marks?: readonly Mark$1[] | null): Node$1$1;
|
|
7880
7882
|
/**
|
|
7881
7883
|
Create a mark with the given type and attributes.
|
|
7882
7884
|
*/
|
|
@@ -7885,7 +7887,7 @@ declare class Schema<Nodes extends string = any, Marks extends string = any> {
|
|
|
7885
7887
|
Deserialize a node from its JSON representation. This method is
|
|
7886
7888
|
bound.
|
|
7887
7889
|
*/
|
|
7888
|
-
nodeFromJSON: (json: any) => Node$1;
|
|
7890
|
+
nodeFromJSON: (json: any) => Node$1$1;
|
|
7889
7891
|
/**
|
|
7890
7892
|
Deserialize a mark from its JSON representation. This method is
|
|
7891
7893
|
bound.
|
|
@@ -7904,7 +7906,7 @@ declare class Fragment {
|
|
|
7904
7906
|
/**
|
|
7905
7907
|
The child nodes in this fragment.
|
|
7906
7908
|
*/
|
|
7907
|
-
readonly content: readonly Node$1[];
|
|
7909
|
+
readonly content: readonly Node$1$1[];
|
|
7908
7910
|
/**
|
|
7909
7911
|
The size of the fragment, which is the total of the size of
|
|
7910
7912
|
its content nodes.
|
|
@@ -7915,18 +7917,18 @@ declare class Fragment {
|
|
|
7915
7917
|
positions (relative to start of this fragment). Doesn't descend
|
|
7916
7918
|
into a node when the callback returns `false`.
|
|
7917
7919
|
*/
|
|
7918
|
-
nodesBetween(from: number, to: number, f: (node: Node$1, start: number, parent: Node$1 | null, index: number) => boolean | void, nodeStart?: number, parent?: Node$1): void;
|
|
7920
|
+
nodesBetween(from: number, to: number, f: (node: Node$1$1, start: number, parent: Node$1$1 | null, index: number) => boolean | void, nodeStart?: number, parent?: Node$1$1): void;
|
|
7919
7921
|
/**
|
|
7920
7922
|
Call the given callback for every descendant node. `pos` will be
|
|
7921
7923
|
relative to the start of the fragment. The callback may return
|
|
7922
7924
|
`false` to prevent traversal of a given node's children.
|
|
7923
7925
|
*/
|
|
7924
|
-
descendants(f: (node: Node$1, pos: number, parent: Node$1 | null, index: number) => boolean | void): void;
|
|
7926
|
+
descendants(f: (node: Node$1$1, pos: number, parent: Node$1$1 | null, index: number) => boolean | void): void;
|
|
7925
7927
|
/**
|
|
7926
7928
|
Extract the text between `from` and `to`. See the same method on
|
|
7927
7929
|
[`Node`](https://prosemirror.net/docs/ref/#model.Node.textBetween).
|
|
7928
7930
|
*/
|
|
7929
|
-
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: string | null | ((leafNode: Node$1) => string)): string;
|
|
7931
|
+
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: string | null | ((leafNode: Node$1$1) => string)): string;
|
|
7930
7932
|
/**
|
|
7931
7933
|
Create a new fragment containing the combined content of this
|
|
7932
7934
|
fragment and the other.
|
|
@@ -7940,17 +7942,17 @@ declare class Fragment {
|
|
|
7940
7942
|
Create a new fragment in which the node at the given index is
|
|
7941
7943
|
replaced by the given node.
|
|
7942
7944
|
*/
|
|
7943
|
-
replaceChild(index: number, node: Node$1): Fragment;
|
|
7945
|
+
replaceChild(index: number, node: Node$1$1): Fragment;
|
|
7944
7946
|
/**
|
|
7945
7947
|
Create a new fragment by prepending the given node to this
|
|
7946
7948
|
fragment.
|
|
7947
7949
|
*/
|
|
7948
|
-
addToStart(node: Node$1): Fragment;
|
|
7950
|
+
addToStart(node: Node$1$1): Fragment;
|
|
7949
7951
|
/**
|
|
7950
7952
|
Create a new fragment by appending the given node to this
|
|
7951
7953
|
fragment.
|
|
7952
7954
|
*/
|
|
7953
|
-
addToEnd(node: Node$1): Fragment;
|
|
7955
|
+
addToEnd(node: Node$1$1): Fragment;
|
|
7954
7956
|
/**
|
|
7955
7957
|
Compare this fragment to another one.
|
|
7956
7958
|
*/
|
|
@@ -7958,11 +7960,11 @@ declare class Fragment {
|
|
|
7958
7960
|
/**
|
|
7959
7961
|
The first child of the fragment, or `null` if it is empty.
|
|
7960
7962
|
*/
|
|
7961
|
-
get firstChild(): Node$1 | null;
|
|
7963
|
+
get firstChild(): Node$1$1 | null;
|
|
7962
7964
|
/**
|
|
7963
7965
|
The last child of the fragment, or `null` if it is empty.
|
|
7964
7966
|
*/
|
|
7965
|
-
get lastChild(): Node$1 | null;
|
|
7967
|
+
get lastChild(): Node$1$1 | null;
|
|
7966
7968
|
/**
|
|
7967
7969
|
The number of child nodes in this fragment.
|
|
7968
7970
|
*/
|
|
@@ -7971,16 +7973,16 @@ declare class Fragment {
|
|
|
7971
7973
|
Get the child node at the given index. Raise an error when the
|
|
7972
7974
|
index is out of range.
|
|
7973
7975
|
*/
|
|
7974
|
-
child(index: number): Node$1;
|
|
7976
|
+
child(index: number): Node$1$1;
|
|
7975
7977
|
/**
|
|
7976
7978
|
Get the child node at the given index, if it exists.
|
|
7977
7979
|
*/
|
|
7978
|
-
maybeChild(index: number): Node$1 | null;
|
|
7980
|
+
maybeChild(index: number): Node$1$1 | null;
|
|
7979
7981
|
/**
|
|
7980
7982
|
Call `f` for every child node, passing the node, its offset
|
|
7981
7983
|
into this parent node, and its index.
|
|
7982
7984
|
*/
|
|
7983
|
-
forEach(f: (node: Node$1, offset: number, index: number) => void): void;
|
|
7985
|
+
forEach(f: (node: Node$1$1, offset: number, index: number) => void): void;
|
|
7984
7986
|
/**
|
|
7985
7987
|
Find the first position at which this fragment and another
|
|
7986
7988
|
fragment differ, or `null` if they are the same.
|
|
@@ -8012,14 +8014,14 @@ declare class Fragment {
|
|
|
8012
8014
|
Build a fragment from an array of nodes. Ensures that adjacent
|
|
8013
8015
|
text nodes with the same marks are joined together.
|
|
8014
8016
|
*/
|
|
8015
|
-
static fromArray(array: readonly Node$1[]): Fragment;
|
|
8017
|
+
static fromArray(array: readonly Node$1$1[]): Fragment;
|
|
8016
8018
|
/**
|
|
8017
8019
|
Create a fragment from something that can be interpreted as a
|
|
8018
8020
|
set of nodes. For `null`, it returns the empty fragment. For a
|
|
8019
8021
|
fragment, the fragment itself. For a node or array of nodes, a
|
|
8020
8022
|
fragment containing those nodes.
|
|
8021
8023
|
*/
|
|
8022
|
-
static from(nodes?: Fragment | Node$1 | readonly Node$1[] | null): Fragment;
|
|
8024
|
+
static from(nodes?: Fragment | Node$1$1 | readonly Node$1$1[] | null): Fragment;
|
|
8023
8025
|
/**
|
|
8024
8026
|
An empty fragment. Intended to be reused whenever a node doesn't
|
|
8025
8027
|
contain anything (rather than allocating a new empty fragment for
|
|
@@ -8100,7 +8102,7 @@ tree shape like this (without back pointers) makes easy.
|
|
|
8100
8102
|
**Do not** directly mutate the properties of a `Node` object. See
|
|
8101
8103
|
[the guide](https://prosemirror.net/docs/guide/#doc) for more information.
|
|
8102
8104
|
*/
|
|
8103
|
-
declare class Node$1 {
|
|
8105
|
+
declare class Node$1$1 {
|
|
8104
8106
|
/**
|
|
8105
8107
|
The type of node that this is.
|
|
8106
8108
|
*/
|
|
@@ -8123,7 +8125,7 @@ declare class Node$1 {
|
|
|
8123
8125
|
/**
|
|
8124
8126
|
The array of this node's child nodes.
|
|
8125
8127
|
*/
|
|
8126
|
-
get children(): readonly Node$1[];
|
|
8128
|
+
get children(): readonly Node$1$1[];
|
|
8127
8129
|
/**
|
|
8128
8130
|
For text nodes, this contains the node's text content.
|
|
8129
8131
|
*/
|
|
@@ -8144,16 +8146,16 @@ declare class Node$1 {
|
|
|
8144
8146
|
Get the child node at the given index. Raises an error when the
|
|
8145
8147
|
index is out of range.
|
|
8146
8148
|
*/
|
|
8147
|
-
child(index: number): Node$1;
|
|
8149
|
+
child(index: number): Node$1$1;
|
|
8148
8150
|
/**
|
|
8149
8151
|
Get the child node at the given index, if it exists.
|
|
8150
8152
|
*/
|
|
8151
|
-
maybeChild(index: number): Node$1 | null;
|
|
8153
|
+
maybeChild(index: number): Node$1$1 | null;
|
|
8152
8154
|
/**
|
|
8153
8155
|
Call `f` for every child node, passing the node, its offset
|
|
8154
8156
|
into this parent node, and its index.
|
|
8155
8157
|
*/
|
|
8156
|
-
forEach(f: (node: Node$1, offset: number, index: number) => void): void;
|
|
8158
|
+
forEach(f: (node: Node$1$1, offset: number, index: number) => void): void;
|
|
8157
8159
|
/**
|
|
8158
8160
|
Invoke a callback for all descendant nodes recursively between
|
|
8159
8161
|
the given two positions that are relative to start of this
|
|
@@ -8164,12 +8166,12 @@ declare class Node$1 {
|
|
|
8164
8166
|
recursed over. The last parameter can be used to specify a
|
|
8165
8167
|
starting position to count from.
|
|
8166
8168
|
*/
|
|
8167
|
-
nodesBetween(from: number, to: number, f: (node: Node$1, pos: number, parent: Node$1 | null, index: number) => void | boolean, startPos?: number): void;
|
|
8169
|
+
nodesBetween(from: number, to: number, f: (node: Node$1$1, pos: number, parent: Node$1$1 | null, index: number) => void | boolean, startPos?: number): void;
|
|
8168
8170
|
/**
|
|
8169
8171
|
Call the given callback for every descendant node. Doesn't
|
|
8170
8172
|
descend into a node when the callback returns `false`.
|
|
8171
8173
|
*/
|
|
8172
|
-
descendants(f: (node: Node$1, pos: number, parent: Node$1 | null, index: number) => void | boolean): void;
|
|
8174
|
+
descendants(f: (node: Node$1$1, pos: number, parent: Node$1$1 | null, index: number) => void | boolean): void;
|
|
8173
8175
|
/**
|
|
8174
8176
|
Concatenates all the text nodes found in this fragment and its
|
|
8175
8177
|
children.
|
|
@@ -8182,26 +8184,26 @@ declare class Node$1 {
|
|
|
8182
8184
|
inserted for every non-text leaf node encountered, otherwise
|
|
8183
8185
|
[`leafText`](https://prosemirror.net/docs/ref/#model.NodeSpec.leafText) will be used.
|
|
8184
8186
|
*/
|
|
8185
|
-
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: null | string | ((leafNode: Node$1) => string)): string;
|
|
8187
|
+
textBetween(from: number, to: number, blockSeparator?: string | null, leafText?: null | string | ((leafNode: Node$1$1) => string)): string;
|
|
8186
8188
|
/**
|
|
8187
8189
|
Returns this node's first child, or `null` if there are no
|
|
8188
8190
|
children.
|
|
8189
8191
|
*/
|
|
8190
|
-
get firstChild(): Node$1 | null;
|
|
8192
|
+
get firstChild(): Node$1$1 | null;
|
|
8191
8193
|
/**
|
|
8192
8194
|
Returns this node's last child, or `null` if there are no
|
|
8193
8195
|
children.
|
|
8194
8196
|
*/
|
|
8195
|
-
get lastChild(): Node$1 | null;
|
|
8197
|
+
get lastChild(): Node$1$1 | null;
|
|
8196
8198
|
/**
|
|
8197
8199
|
Test whether two nodes represent the same piece of document.
|
|
8198
8200
|
*/
|
|
8199
|
-
eq(other: Node$1): boolean;
|
|
8201
|
+
eq(other: Node$1$1): boolean;
|
|
8200
8202
|
/**
|
|
8201
8203
|
Compare the markup (type, attributes, and marks) of this node to
|
|
8202
8204
|
those of another. Returns `true` if both have the same markup.
|
|
8203
8205
|
*/
|
|
8204
|
-
sameMarkup(other: Node$1): boolean;
|
|
8206
|
+
sameMarkup(other: Node$1$1): boolean;
|
|
8205
8207
|
/**
|
|
8206
8208
|
Check whether this node's markup correspond to the given type,
|
|
8207
8209
|
attributes, and marks.
|
|
@@ -8211,18 +8213,18 @@ declare class Node$1 {
|
|
|
8211
8213
|
Create a new node with the same markup as this node, containing
|
|
8212
8214
|
the given content (or empty, if no content is given).
|
|
8213
8215
|
*/
|
|
8214
|
-
copy(content?: Fragment | null): Node$1;
|
|
8216
|
+
copy(content?: Fragment | null): Node$1$1;
|
|
8215
8217
|
/**
|
|
8216
8218
|
Create a copy of this node, with the given set of marks instead
|
|
8217
8219
|
of the node's own marks.
|
|
8218
8220
|
*/
|
|
8219
|
-
mark(marks: readonly Mark$1[]): Node$1;
|
|
8221
|
+
mark(marks: readonly Mark$1[]): Node$1$1;
|
|
8220
8222
|
/**
|
|
8221
8223
|
Create a copy of this node with only the content between the
|
|
8222
8224
|
given positions. If `to` is not given, it defaults to the end of
|
|
8223
8225
|
the node.
|
|
8224
8226
|
*/
|
|
8225
|
-
cut(from: number, to?: number): Node$1;
|
|
8227
|
+
cut(from: number, to?: number): Node$1$1;
|
|
8226
8228
|
/**
|
|
8227
8229
|
Cut out the part of the document between the given positions, and
|
|
8228
8230
|
return it as a `Slice` object.
|
|
@@ -8236,18 +8238,18 @@ declare class Node$1 {
|
|
|
8236
8238
|
into. If any of this is violated, an error of type
|
|
8237
8239
|
[`ReplaceError`](https://prosemirror.net/docs/ref/#model.ReplaceError) is thrown.
|
|
8238
8240
|
*/
|
|
8239
|
-
replace(from: number, to: number, slice: Slice): Node$1;
|
|
8241
|
+
replace(from: number, to: number, slice: Slice): Node$1$1;
|
|
8240
8242
|
/**
|
|
8241
8243
|
Find the node directly after the given position.
|
|
8242
8244
|
*/
|
|
8243
|
-
nodeAt(pos: number): Node$1 | null;
|
|
8245
|
+
nodeAt(pos: number): Node$1$1 | null;
|
|
8244
8246
|
/**
|
|
8245
8247
|
Find the (direct) child node after the given offset, if any,
|
|
8246
8248
|
and return it along with its index and offset relative to this
|
|
8247
8249
|
node.
|
|
8248
8250
|
*/
|
|
8249
8251
|
childAfter(pos: number): {
|
|
8250
|
-
node: Node$1 | null;
|
|
8252
|
+
node: Node$1$1 | null;
|
|
8251
8253
|
index: number;
|
|
8252
8254
|
offset: number;
|
|
8253
8255
|
};
|
|
@@ -8257,7 +8259,7 @@ declare class Node$1 {
|
|
|
8257
8259
|
node.
|
|
8258
8260
|
*/
|
|
8259
8261
|
childBefore(pos: number): {
|
|
8260
|
-
node: Node$1 | null;
|
|
8262
|
+
node: Node$1$1 | null;
|
|
8261
8263
|
index: number;
|
|
8262
8264
|
offset: number;
|
|
8263
8265
|
};
|
|
@@ -8333,7 +8335,7 @@ declare class Node$1 {
|
|
|
8333
8335
|
is at least one node type that can appear in both nodes (to avoid
|
|
8334
8336
|
merging completely incompatible nodes).
|
|
8335
8337
|
*/
|
|
8336
|
-
canAppend(other: Node$1): boolean;
|
|
8338
|
+
canAppend(other: Node$1$1): boolean;
|
|
8337
8339
|
/**
|
|
8338
8340
|
Check whether this node and its descendants conform to the
|
|
8339
8341
|
schema, and raise an exception when they do not.
|
|
@@ -8346,7 +8348,7 @@ declare class Node$1 {
|
|
|
8346
8348
|
/**
|
|
8347
8349
|
Deserialize a node from its JSON representation.
|
|
8348
8350
|
*/
|
|
8349
|
-
static fromJSON(schema: Schema, json: any): Node$1;
|
|
8351
|
+
static fromJSON(schema: Schema, json: any): Node$1$1;
|
|
8350
8352
|
}
|
|
8351
8353
|
|
|
8352
8354
|
/**
|
|
@@ -8544,7 +8546,7 @@ declare abstract class Step {
|
|
|
8544
8546
|
applied to this document, or indicates success by containing a
|
|
8545
8547
|
transformed document.
|
|
8546
8548
|
*/
|
|
8547
|
-
abstract apply(doc: Node$1): StepResult;
|
|
8549
|
+
abstract apply(doc: Node$1$1): StepResult;
|
|
8548
8550
|
/**
|
|
8549
8551
|
Get the step map that represents the changes made by this step,
|
|
8550
8552
|
and which can be used to transform between positions in the old
|
|
@@ -8555,7 +8557,7 @@ declare abstract class Step {
|
|
|
8555
8557
|
Create an inverted version of this step. Needs the document as it
|
|
8556
8558
|
was before the step as argument.
|
|
8557
8559
|
*/
|
|
8558
|
-
abstract invert(doc: Node$1): Step;
|
|
8560
|
+
abstract invert(doc: Node$1$1): Step;
|
|
8559
8561
|
/**
|
|
8560
8562
|
Map this step through a mappable thing, returning either a
|
|
8561
8563
|
version of that step with its positions adjusted, or `null` if
|
|
@@ -8600,7 +8602,7 @@ declare class StepResult {
|
|
|
8600
8602
|
/**
|
|
8601
8603
|
The transformed document, if successful.
|
|
8602
8604
|
*/
|
|
8603
|
-
readonly doc: Node$1 | null;
|
|
8605
|
+
readonly doc: Node$1$1 | null;
|
|
8604
8606
|
/**
|
|
8605
8607
|
The failure message, if unsuccessful.
|
|
8606
8608
|
*/
|
|
@@ -8608,7 +8610,7 @@ declare class StepResult {
|
|
|
8608
8610
|
/**
|
|
8609
8611
|
Create a successful step result.
|
|
8610
8612
|
*/
|
|
8611
|
-
static ok(doc: Node$1): StepResult;
|
|
8613
|
+
static ok(doc: Node$1$1): StepResult;
|
|
8612
8614
|
/**
|
|
8613
8615
|
Create a failed step result.
|
|
8614
8616
|
*/
|
|
@@ -8618,7 +8620,7 @@ declare class StepResult {
|
|
|
8618
8620
|
arguments. Create a successful result if it succeeds, and a
|
|
8619
8621
|
failed one if it throws a `ReplaceError`.
|
|
8620
8622
|
*/
|
|
8621
|
-
static fromReplace(doc: Node$1, from: number, to: number, slice: Slice): StepResult;
|
|
8623
|
+
static fromReplace(doc: Node$1$1, from: number, to: number, slice: Slice): StepResult;
|
|
8622
8624
|
}
|
|
8623
8625
|
|
|
8624
8626
|
/**
|
|
@@ -8633,7 +8635,7 @@ declare class Transform {
|
|
|
8633
8635
|
The current document (the result of applying the steps in the
|
|
8634
8636
|
transform).
|
|
8635
8637
|
*/
|
|
8636
|
-
doc: Node$1;
|
|
8638
|
+
doc: Node$1$1;
|
|
8637
8639
|
/**
|
|
8638
8640
|
The steps in this transform.
|
|
8639
8641
|
*/
|
|
@@ -8641,7 +8643,7 @@ declare class Transform {
|
|
|
8641
8643
|
/**
|
|
8642
8644
|
The documents before each of the steps.
|
|
8643
8645
|
*/
|
|
8644
|
-
readonly docs: Node$1[];
|
|
8646
|
+
readonly docs: Node$1$1[];
|
|
8645
8647
|
/**
|
|
8646
8648
|
A mapping with the maps for each of the steps in this transform.
|
|
8647
8649
|
*/
|
|
@@ -8654,11 +8656,11 @@ declare class Transform {
|
|
|
8654
8656
|
The current document (the result of applying the steps in the
|
|
8655
8657
|
transform).
|
|
8656
8658
|
*/
|
|
8657
|
-
doc: Node$1);
|
|
8659
|
+
doc: Node$1$1);
|
|
8658
8660
|
/**
|
|
8659
8661
|
The starting document.
|
|
8660
8662
|
*/
|
|
8661
|
-
get before(): Node$1;
|
|
8663
|
+
get before(): Node$1$1;
|
|
8662
8664
|
/**
|
|
8663
8665
|
Apply a new step in this transform, saving the result. Throws an
|
|
8664
8666
|
error when the step fails.
|
|
@@ -8683,7 +8685,7 @@ declare class Transform {
|
|
|
8683
8685
|
Replace the given range with the given content, which may be a
|
|
8684
8686
|
fragment, node, or array of nodes.
|
|
8685
8687
|
*/
|
|
8686
|
-
replaceWith(from: number, to: number, content: Fragment | Node$1 | readonly Node$1[]): this;
|
|
8688
|
+
replaceWith(from: number, to: number, content: Fragment | Node$1$1 | readonly Node$1$1[]): this;
|
|
8687
8689
|
/**
|
|
8688
8690
|
Delete the content between the given positions.
|
|
8689
8691
|
*/
|
|
@@ -8691,7 +8693,7 @@ declare class Transform {
|
|
|
8691
8693
|
/**
|
|
8692
8694
|
Insert the given content at the given position.
|
|
8693
8695
|
*/
|
|
8694
|
-
insert(pos: number, content: Fragment | Node$1 | readonly Node$1[]): this;
|
|
8696
|
+
insert(pos: number, content: Fragment | Node$1$1 | readonly Node$1$1[]): this;
|
|
8695
8697
|
/**
|
|
8696
8698
|
Replace a range of the document with a given slice, using
|
|
8697
8699
|
`from`, `to`, and the slice's
|
|
@@ -8721,7 +8723,7 @@ declare class Transform {
|
|
|
8721
8723
|
completely covers a parent node, this method may completely replace
|
|
8722
8724
|
that parent node.
|
|
8723
8725
|
*/
|
|
8724
|
-
replaceRangeWith(from: number, to: number, node: Node$1): this;
|
|
8726
|
+
replaceRangeWith(from: number, to: number, node: Node$1$1): this;
|
|
8725
8727
|
/**
|
|
8726
8728
|
Delete the given range, expanding it to cover fully covered
|
|
8727
8729
|
parent nodes until a valid replace is found.
|
|
@@ -8753,7 +8755,7 @@ declare class Transform {
|
|
|
8753
8755
|
Set the type of all textblocks (partly) between `from` and `to` to
|
|
8754
8756
|
the given node type with the given attributes.
|
|
8755
8757
|
*/
|
|
8756
|
-
setBlockType(from: number, to: number | undefined, type: NodeType$1, attrs?: Attrs | null | ((oldNode: Node$1) => Attrs)): this;
|
|
8758
|
+
setBlockType(from: number, to: number | undefined, type: NodeType$1, attrs?: Attrs | null | ((oldNode: Node$1$1) => Attrs)): this;
|
|
8757
8759
|
/**
|
|
8758
8760
|
Change the type, attributes, and/or marks of the node at `pos`.
|
|
8759
8761
|
When `type` isn't given, the existing node type is preserved,
|
|
@@ -8976,11 +8978,11 @@ interface DecorationSource {
|
|
|
8976
8978
|
Map the set of decorations in response to a change in the
|
|
8977
8979
|
document.
|
|
8978
8980
|
*/
|
|
8979
|
-
map: (mapping: Mapping, node: Node$1) => DecorationSource;
|
|
8981
|
+
map: (mapping: Mapping, node: Node$1$1) => DecorationSource;
|
|
8980
8982
|
/**
|
|
8981
8983
|
Extract a DecorationSource containing decorations for the given child node at the given offset.
|
|
8982
8984
|
*/
|
|
8983
|
-
forChild(offset: number, child: Node$1): DecorationSource;
|
|
8985
|
+
forChild(offset: number, child: Node$1$1): DecorationSource;
|
|
8984
8986
|
/**
|
|
8985
8987
|
Call the given function for each decoration set in the group.
|
|
8986
8988
|
*/
|
|
@@ -8998,7 +9000,7 @@ declare class DecorationSet implements DecorationSource {
|
|
|
8998
9000
|
document. This will consume (modify) the `decorations` array, so
|
|
8999
9001
|
you must make a copy if you want need to preserve that.
|
|
9000
9002
|
*/
|
|
9001
|
-
static create(doc: Node$1, decorations: Decoration[]): DecorationSet;
|
|
9003
|
+
static create(doc: Node$1$1, decorations: Decoration[]): DecorationSet;
|
|
9002
9004
|
/**
|
|
9003
9005
|
Find all decorations in this set which touch the given range
|
|
9004
9006
|
(including decorations that start or end directly at the
|
|
@@ -9013,7 +9015,7 @@ declare class DecorationSet implements DecorationSource {
|
|
|
9013
9015
|
Map the set of decorations in response to a change in the
|
|
9014
9016
|
document.
|
|
9015
9017
|
*/
|
|
9016
|
-
map(mapping: Mapping, doc: Node$1, options?: {
|
|
9018
|
+
map(mapping: Mapping, doc: Node$1$1, options?: {
|
|
9017
9019
|
/**
|
|
9018
9020
|
When given, this function will be called for each decoration
|
|
9019
9021
|
that gets dropped as a result of the mapping, passing the
|
|
@@ -9027,7 +9029,7 @@ declare class DecorationSet implements DecorationSource {
|
|
|
9027
9029
|
access to the current document to create the appropriate tree
|
|
9028
9030
|
structure.
|
|
9029
9031
|
*/
|
|
9030
|
-
add(doc: Node$1, decorations: Decoration[]): DecorationSet;
|
|
9032
|
+
add(doc: Node$1$1, decorations: Decoration[]): DecorationSet;
|
|
9031
9033
|
private addInner;
|
|
9032
9034
|
/**
|
|
9033
9035
|
Create a new set that contains the decorations in this set, minus
|
|
@@ -9035,7 +9037,7 @@ declare class DecorationSet implements DecorationSource {
|
|
|
9035
9037
|
*/
|
|
9036
9038
|
remove(decorations: Decoration[]): DecorationSet;
|
|
9037
9039
|
private removeInner;
|
|
9038
|
-
forChild(offset: number, node: Node$1): DecorationSet | DecorationGroup;
|
|
9040
|
+
forChild(offset: number, node: Node$1$1): DecorationSet | DecorationGroup;
|
|
9039
9041
|
/**
|
|
9040
9042
|
The empty set of decorations.
|
|
9041
9043
|
*/
|
|
@@ -9045,10 +9047,10 @@ declare class DecorationSet implements DecorationSource {
|
|
|
9045
9047
|
declare class DecorationGroup implements DecorationSource {
|
|
9046
9048
|
readonly members: readonly DecorationSet[];
|
|
9047
9049
|
constructor(members: readonly DecorationSet[]);
|
|
9048
|
-
map(mapping: Mapping, doc: Node$1): DecorationSource;
|
|
9049
|
-
forChild(offset: number, child: Node$1): DecorationSource | DecorationSet;
|
|
9050
|
+
map(mapping: Mapping, doc: Node$1$1): DecorationSource;
|
|
9051
|
+
forChild(offset: number, child: Node$1$1): DecorationSource | DecorationSet;
|
|
9050
9052
|
eq(other: DecorationGroup): boolean;
|
|
9051
|
-
locals(node: Node$1): readonly any[];
|
|
9053
|
+
locals(node: Node$1$1): readonly any[];
|
|
9052
9054
|
static from(members: readonly DecorationSource[]): DecorationSource;
|
|
9053
9055
|
forEachSet(f: (set: DecorationSet) => void): void;
|
|
9054
9056
|
}
|
|
@@ -9104,7 +9106,7 @@ interface NodeView {
|
|
|
9104
9106
|
`contentDOM` property (or no `dom` property), updating its child
|
|
9105
9107
|
nodes will be handled by ProseMirror.
|
|
9106
9108
|
*/
|
|
9107
|
-
update?: (node: Node$1, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean;
|
|
9109
|
+
update?: (node: Node$1$1, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean;
|
|
9108
9110
|
/**
|
|
9109
9111
|
By default, `update` will only be called when a node of the same
|
|
9110
9112
|
node type appears in this view's position. When you set this to
|
|
@@ -9413,7 +9415,7 @@ declare class EditorView {
|
|
|
9413
9415
|
The type of function [provided](https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews) to
|
|
9414
9416
|
create [node views](https://prosemirror.net/docs/ref/#view.NodeView).
|
|
9415
9417
|
*/
|
|
9416
|
-
type NodeViewConstructor = (node: Node$1, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
|
|
9418
|
+
type NodeViewConstructor = (node: Node$1$1, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
|
|
9417
9419
|
/**
|
|
9418
9420
|
The function types [used](https://prosemirror.net/docs/ref/#view.EditorProps.markViews) to create
|
|
9419
9421
|
mark views.
|
|
@@ -9477,7 +9479,7 @@ interface EditorProps<P = any> {
|
|
|
9477
9479
|
Called for each node around a click, from the inside out. The
|
|
9478
9480
|
`direct` flag will be true for the inner node.
|
|
9479
9481
|
*/
|
|
9480
|
-
handleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9482
|
+
handleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9481
9483
|
/**
|
|
9482
9484
|
Called when the editor is clicked, after `handleClickOn` handlers
|
|
9483
9485
|
have been called.
|
|
@@ -9486,7 +9488,7 @@ interface EditorProps<P = any> {
|
|
|
9486
9488
|
/**
|
|
9487
9489
|
Called for each node around a double click.
|
|
9488
9490
|
*/
|
|
9489
|
-
handleDoubleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9491
|
+
handleDoubleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9490
9492
|
/**
|
|
9491
9493
|
Called when the editor is double-clicked, after `handleDoubleClickOn`.
|
|
9492
9494
|
*/
|
|
@@ -9494,7 +9496,7 @@ interface EditorProps<P = any> {
|
|
|
9494
9496
|
/**
|
|
9495
9497
|
Called for each node around a triple click.
|
|
9496
9498
|
*/
|
|
9497
|
-
handleTripleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9499
|
+
handleTripleClickOn?: (this: P, view: EditorView, pos: number, node: Node$1$1, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
|
|
9498
9500
|
/**
|
|
9499
9501
|
Called when the editor is triple-clicked, after `handleTripleClickOn`.
|
|
9500
9502
|
*/
|
|
@@ -9721,7 +9723,7 @@ interface EditorStateConfig {
|
|
|
9721
9723
|
The starting document. Either this or `schema` _must_ be
|
|
9722
9724
|
provided.
|
|
9723
9725
|
*/
|
|
9724
|
-
doc?: Node$1;
|
|
9726
|
+
doc?: Node$1$1;
|
|
9725
9727
|
/**
|
|
9726
9728
|
A valid selection in the document.
|
|
9727
9729
|
*/
|
|
@@ -9748,7 +9750,7 @@ declare class EditorState {
|
|
|
9748
9750
|
/**
|
|
9749
9751
|
The current document.
|
|
9750
9752
|
*/
|
|
9751
|
-
doc: Node$1;
|
|
9753
|
+
doc: Node$1$1;
|
|
9752
9754
|
/**
|
|
9753
9755
|
The selection.
|
|
9754
9756
|
*/
|
|
@@ -10067,7 +10069,7 @@ declare class Transaction extends Transform {
|
|
|
10067
10069
|
true and the content is inline, it inherits the marks from the
|
|
10068
10070
|
place where it is inserted.
|
|
10069
10071
|
*/
|
|
10070
|
-
replaceSelectionWith(node: Node$1, inheritMarks?: boolean): this;
|
|
10072
|
+
replaceSelectionWith(node: Node$1$1, inheritMarks?: boolean): this;
|
|
10071
10073
|
/**
|
|
10072
10074
|
Delete the selection.
|
|
10073
10075
|
*/
|
|
@@ -10173,7 +10175,7 @@ declare abstract class Selection {
|
|
|
10173
10175
|
Map this selection through a [mappable](https://prosemirror.net/docs/ref/#transform.Mappable)
|
|
10174
10176
|
thing. `doc` should be the new document to which we are mapping.
|
|
10175
10177
|
*/
|
|
10176
|
-
abstract map(doc: Node$1, mapping: Mappable): Selection;
|
|
10178
|
+
abstract map(doc: Node$1$1, mapping: Mappable): Selection;
|
|
10177
10179
|
/**
|
|
10178
10180
|
Get the content of this selection as a slice.
|
|
10179
10181
|
*/
|
|
@@ -10187,7 +10189,7 @@ declare abstract class Selection {
|
|
|
10187
10189
|
Replace the selection with the given node, appending the changes
|
|
10188
10190
|
to the given transaction.
|
|
10189
10191
|
*/
|
|
10190
|
-
replaceWith(tr: Transaction, node: Node$1): void;
|
|
10192
|
+
replaceWith(tr: Transaction, node: Node$1$1): void;
|
|
10191
10193
|
/**
|
|
10192
10194
|
Convert the selection to a JSON representation. When implementing
|
|
10193
10195
|
this for a custom selection class, make sure to give the object a
|
|
@@ -10215,17 +10217,17 @@ declare abstract class Selection {
|
|
|
10215
10217
|
[`AllSelection`](https://prosemirror.net/docs/ref/#state.AllSelection) if no valid position
|
|
10216
10218
|
exists.
|
|
10217
10219
|
*/
|
|
10218
|
-
static atStart(doc: Node$1): Selection;
|
|
10220
|
+
static atStart(doc: Node$1$1): Selection;
|
|
10219
10221
|
/**
|
|
10220
10222
|
Find the cursor or leaf node selection closest to the end of the
|
|
10221
10223
|
given document.
|
|
10222
10224
|
*/
|
|
10223
|
-
static atEnd(doc: Node$1): Selection;
|
|
10225
|
+
static atEnd(doc: Node$1$1): Selection;
|
|
10224
10226
|
/**
|
|
10225
10227
|
Deserialize the JSON representation of a selection. Must be
|
|
10226
10228
|
implemented for custom classes (as a static class method).
|
|
10227
10229
|
*/
|
|
10228
|
-
static fromJSON(doc: Node$1, json: any): Selection;
|
|
10230
|
+
static fromJSON(doc: Node$1$1, json: any): Selection;
|
|
10229
10231
|
/**
|
|
10230
10232
|
To be able to deserialize selections from JSON, custom selection
|
|
10231
10233
|
classes must register themselves with an ID string, so that they
|
|
@@ -10233,9 +10235,9 @@ declare abstract class Selection {
|
|
|
10233
10235
|
clash with classes from other modules.
|
|
10234
10236
|
*/
|
|
10235
10237
|
static jsonID(id: string, selectionClass: {
|
|
10236
|
-
fromJSON: (doc: Node$1, json: any) => Selection;
|
|
10238
|
+
fromJSON: (doc: Node$1$1, json: any) => Selection;
|
|
10237
10239
|
}): {
|
|
10238
|
-
fromJSON: (doc: Node$1, json: any) => Selection;
|
|
10240
|
+
fromJSON: (doc: Node$1$1, json: any) => Selection;
|
|
10239
10241
|
};
|
|
10240
10242
|
/**
|
|
10241
10243
|
Get a [bookmark](https://prosemirror.net/docs/ref/#state.SelectionBookmark) for this selection,
|
|
@@ -10270,7 +10272,7 @@ interface SelectionBookmark {
|
|
|
10270
10272
|
[`TextSelection.between`](https://prosemirror.net/docs/ref/#state.TextSelection^between)) if
|
|
10271
10273
|
mapping made the bookmark invalid.
|
|
10272
10274
|
*/
|
|
10273
|
-
resolve: (doc: Node$1) => Selection;
|
|
10275
|
+
resolve: (doc: Node$1$1) => Selection;
|
|
10274
10276
|
}
|
|
10275
10277
|
/**
|
|
10276
10278
|
Represents a selected range in a document.
|
|
@@ -10713,7 +10715,7 @@ interface NodeConfig<Options = any, Storage = any> extends ExtendableConfig<Opti
|
|
|
10713
10715
|
parent: ParentConfig<NodeConfig<Options, Storage>>['renderHTML'];
|
|
10714
10716
|
editor?: Editor;
|
|
10715
10717
|
}, props: {
|
|
10716
|
-
node: Node$1;
|
|
10718
|
+
node: Node$1$1;
|
|
10717
10719
|
HTMLAttributes: Record<string, any>;
|
|
10718
10720
|
}) => DOMOutputSpec) | null;
|
|
10719
10721
|
/**
|
|
@@ -10727,9 +10729,9 @@ interface NodeConfig<Options = any, Storage = any> extends ExtendableConfig<Opti
|
|
|
10727
10729
|
parent: ParentConfig<NodeConfig<Options, Storage>>['renderText'];
|
|
10728
10730
|
editor?: Editor;
|
|
10729
10731
|
}, props: {
|
|
10730
|
-
node: Node$1;
|
|
10732
|
+
node: Node$1$1;
|
|
10731
10733
|
pos: number;
|
|
10732
|
-
parent: Node$1;
|
|
10734
|
+
parent: Node$1$1;
|
|
10733
10735
|
index: number;
|
|
10734
10736
|
}) => string) | null;
|
|
10735
10737
|
/**
|
|
@@ -10748,21 +10750,21 @@ interface NodeConfig<Options = any, Storage = any> extends ExtendableConfig<Opti
|
|
|
10748
10750
|
* The Node class is used to create custom node extensions.
|
|
10749
10751
|
* @see https://tiptap.dev/api/extensions#create-a-new-extension
|
|
10750
10752
|
*/
|
|
10751
|
-
declare class Node<Options = any, Storage = any> extends Extendable<Options, Storage, NodeConfig<Options, Storage>> {
|
|
10753
|
+
declare class Node$2<Options = any, Storage = any> extends Extendable<Options, Storage, NodeConfig<Options, Storage>> {
|
|
10752
10754
|
type: string;
|
|
10753
10755
|
/**
|
|
10754
10756
|
* Create a new Node instance
|
|
10755
10757
|
* @param config - Node configuration object or a function that returns a configuration object
|
|
10756
10758
|
*/
|
|
10757
|
-
static create<O = any, S = any>(config?: Partial<NodeConfig<O, S>> | (() => Partial<NodeConfig<O, S>>)): Node<O, S>;
|
|
10758
|
-
configure(options?: Partial<Options>): Node<Options, Storage>;
|
|
10759
|
+
static create<O = any, S = any>(config?: Partial<NodeConfig<O, S>> | (() => Partial<NodeConfig<O, S>>)): Node$2<O, S>;
|
|
10760
|
+
configure(options?: Partial<Options>): Node$2<Options, Storage>;
|
|
10759
10761
|
extend<ExtendedOptions = Options, ExtendedStorage = Storage, ExtendedConfig extends NodeConfig<ExtendedOptions, ExtendedStorage> = NodeConfig<ExtendedOptions, ExtendedStorage>>(extendedConfig?: (() => Partial<ExtendedConfig>) | (Partial<ExtendedConfig> & ThisType<{
|
|
10760
10762
|
name: string;
|
|
10761
10763
|
options: ExtendedOptions;
|
|
10762
10764
|
storage: ExtendedStorage;
|
|
10763
10765
|
editor: Editor;
|
|
10764
10766
|
type: NodeType$1;
|
|
10765
|
-
}>)): Node<ExtendedOptions, ExtendedStorage>;
|
|
10767
|
+
}>)): Node$2<ExtendedOptions, ExtendedStorage>;
|
|
10766
10768
|
}
|
|
10767
10769
|
|
|
10768
10770
|
type PasteRuleMatch = {
|
|
@@ -10877,7 +10879,7 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
|
|
|
10877
10879
|
name: string;
|
|
10878
10880
|
options: Options;
|
|
10879
10881
|
storage: Storage;
|
|
10880
|
-
extensions: (Node | Mark$2)[];
|
|
10882
|
+
extensions: (Node$2 | Mark$2)[];
|
|
10881
10883
|
parent: ParentConfig<Config>['addGlobalAttributes'];
|
|
10882
10884
|
}) => GlobalAttributes;
|
|
10883
10885
|
/**
|
|
@@ -11043,7 +11045,7 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
|
|
|
11043
11045
|
options: Options;
|
|
11044
11046
|
storage: Storage;
|
|
11045
11047
|
parent: ParentConfig<Config>['extendNodeSchema'];
|
|
11046
|
-
}, extension: Node) => Record<string, any>) | null;
|
|
11048
|
+
}, extension: Node$2) => Record<string, any>) | null;
|
|
11047
11049
|
/**
|
|
11048
11050
|
* This function extends the schema of the mark.
|
|
11049
11051
|
* @example
|
|
@@ -11382,7 +11384,7 @@ interface EditorEvents {
|
|
|
11382
11384
|
* The node which the deletion occurred in
|
|
11383
11385
|
* @note This can be a parent node of the deleted content
|
|
11384
11386
|
*/
|
|
11385
|
-
node: Node$1;
|
|
11387
|
+
node: Node$1$1;
|
|
11386
11388
|
/**
|
|
11387
11389
|
* The new start position of the node in the document (after the deletion)
|
|
11388
11390
|
*/
|
|
@@ -11785,7 +11787,7 @@ interface NodeViewRendererProps {
|
|
|
11785
11787
|
/**
|
|
11786
11788
|
* The extension that is responsible for the node.
|
|
11787
11789
|
*/
|
|
11788
|
-
extension: Node;
|
|
11790
|
+
extension: Node$2;
|
|
11789
11791
|
/**
|
|
11790
11792
|
* The HTML attributes that should be added to the node's DOM element.
|
|
11791
11793
|
*/
|
|
@@ -11841,9 +11843,9 @@ type Range = {
|
|
|
11841
11843
|
to: number;
|
|
11842
11844
|
};
|
|
11843
11845
|
type TextSerializer = (props: {
|
|
11844
|
-
node: Node$1;
|
|
11846
|
+
node: Node$1$1;
|
|
11845
11847
|
pos: number;
|
|
11846
|
-
parent: Node$1;
|
|
11848
|
+
parent: Node$1$1;
|
|
11847
11849
|
index: number;
|
|
11848
11850
|
range: Range;
|
|
11849
11851
|
}) => string;
|
|
@@ -12084,9 +12086,9 @@ declare class NodePos {
|
|
|
12084
12086
|
private isBlock;
|
|
12085
12087
|
private editor;
|
|
12086
12088
|
private get name();
|
|
12087
|
-
constructor(pos: ResolvedPos, editor: Editor, isBlock?: boolean, node?: Node$1 | null);
|
|
12089
|
+
constructor(pos: ResolvedPos, editor: Editor, isBlock?: boolean, node?: Node$1$1 | null);
|
|
12088
12090
|
private currentNode;
|
|
12089
|
-
get node(): Node$1;
|
|
12091
|
+
get node(): Node$1$1;
|
|
12090
12092
|
get element(): HTMLElement;
|
|
12091
12093
|
actualDepth: number | null;
|
|
12092
12094
|
get depth(): number;
|
|
@@ -12423,7 +12425,7 @@ declare module '@tiptap/core' {
|
|
|
12423
12425
|
/**
|
|
12424
12426
|
* The ProseMirror content to insert.
|
|
12425
12427
|
*/
|
|
12426
|
-
value: Content | Node$1 | Fragment,
|
|
12428
|
+
value: Content | Node$1$1 | Fragment,
|
|
12427
12429
|
/**
|
|
12428
12430
|
* Optional options
|
|
12429
12431
|
*/
|
|
@@ -12446,7 +12448,7 @@ declare module '@tiptap/core' {
|
|
|
12446
12448
|
/**
|
|
12447
12449
|
* The ProseMirror content to insert.
|
|
12448
12450
|
*/
|
|
12449
|
-
value: Content | Node$1 | Fragment,
|
|
12451
|
+
value: Content | Node$1$1 | Fragment,
|
|
12450
12452
|
/**
|
|
12451
12453
|
* Optional options
|
|
12452
12454
|
*/
|
|
@@ -12714,7 +12716,7 @@ declare module '@tiptap/core' {
|
|
|
12714
12716
|
/**
|
|
12715
12717
|
* The new content.
|
|
12716
12718
|
*/
|
|
12717
|
-
content: Content | Fragment | Node$1,
|
|
12719
|
+
content: Content | Fragment | Node$1$1,
|
|
12718
12720
|
/**
|
|
12719
12721
|
* Options for `setContent`.
|
|
12720
12722
|
*/
|
|
@@ -13538,9 +13540,9 @@ interface TableRowNode extends JSONContent {
|
|
|
13538
13540
|
interface TableCellNode extends JSONContent {
|
|
13539
13541
|
type: "tableCell";
|
|
13540
13542
|
attrs?: {
|
|
13541
|
-
|
|
13542
|
-
|
|
13543
|
-
|
|
13543
|
+
colspan?: number;
|
|
13544
|
+
rowspan?: number;
|
|
13545
|
+
colwidth?: number[] | null;
|
|
13544
13546
|
backgroundColor?: string | null;
|
|
13545
13547
|
verticalAlign?: "top" | "middle" | "bottom" | null;
|
|
13546
13548
|
borderTop?: TableCellBorder | null;
|
|
@@ -13553,9 +13555,9 @@ interface TableCellNode extends JSONContent {
|
|
|
13553
13555
|
interface TableHeaderNode extends JSONContent {
|
|
13554
13556
|
type: "tableHeader";
|
|
13555
13557
|
attrs?: {
|
|
13556
|
-
|
|
13557
|
-
|
|
13558
|
-
|
|
13558
|
+
colspan?: number;
|
|
13559
|
+
rowspan?: number;
|
|
13560
|
+
colwidth?: number[] | null;
|
|
13559
13561
|
backgroundColor?: string | null;
|
|
13560
13562
|
verticalAlign?: "top" | "middle" | "bottom" | null;
|
|
13561
13563
|
borderTop?: TableCellBorder | null;
|
|
@@ -13608,7 +13610,7 @@ declare function convertHardBreak(marks?: Array<{
|
|
|
13608
13610
|
* Convert array of text nodes (text, hardBreak) to DOCX elements
|
|
13609
13611
|
* Returns flattened array of TextRun or ExternalHyperlink
|
|
13610
13612
|
*/
|
|
13611
|
-
declare
|
|
13613
|
+
declare function convertTextNodes(nodes?: JSONContent$1[]): Array<TextRun | ExternalHyperlink | undefined>;
|
|
13612
13614
|
|
|
13613
13615
|
/**
|
|
13614
13616
|
* Convert TipTap paragraph node to DOCX Paragraph
|
|
@@ -13622,7 +13624,7 @@ declare function convertParagraph(node: ParagraphNode, params?: {
|
|
|
13622
13624
|
/** Image conversion parameters */
|
|
13623
13625
|
image?: {
|
|
13624
13626
|
/** Maximum available width for inline images (number = pixels, or string like "6in", "152.4mm") */
|
|
13625
|
-
maxWidth?: number | PositiveUniversalMeasure;
|
|
13627
|
+
maxWidth?: number | PositiveUniversalMeasure$1;
|
|
13626
13628
|
};
|
|
13627
13629
|
}): Promise<Paragraph>;
|
|
13628
13630
|
|
|
@@ -13652,7 +13654,7 @@ declare function convertBlockquote(node: BlockquoteNode): Paragraph[];
|
|
|
13652
13654
|
*/
|
|
13653
13655
|
declare function convertImage(node: ImageNode, params?: {
|
|
13654
13656
|
/** Maximum available width (number = pixels, or string like "6in", "152.4mm") */
|
|
13655
|
-
maxWidth?: number | PositiveUniversalMeasure;
|
|
13657
|
+
maxWidth?: number | PositiveUniversalMeasure$1;
|
|
13656
13658
|
/** Additional image options to apply */
|
|
13657
13659
|
options?: Partial<IImageOptions$1>;
|
|
13658
13660
|
}): Promise<ImageRun>;
|
|
@@ -13770,68 +13772,611 @@ declare function convertHorizontalRule(node: HorizontalRuleNode, params: {
|
|
|
13770
13772
|
}): Paragraph;
|
|
13771
13773
|
|
|
13772
13774
|
/**
|
|
13773
|
-
* Convert TipTap
|
|
13774
|
-
* Simulates collapsible content using indentation and borders
|
|
13775
|
+
* Convert TipTap detailsSummary node to DOCX Paragraph
|
|
13775
13776
|
*
|
|
13776
|
-
* @param node - TipTap
|
|
13777
|
+
* @param node - TipTap detailsSummary node
|
|
13777
13778
|
* @param params - Conversion parameters
|
|
13778
|
-
* @returns
|
|
13779
|
+
* @returns DOCX Paragraph with summary styling
|
|
13779
13780
|
*/
|
|
13780
|
-
declare function
|
|
13781
|
+
declare function convertDetailsSummary(node: DetailsSummaryNode, params: {
|
|
13781
13782
|
/** Export options for details styling */
|
|
13782
13783
|
options?: DocxExportOptions["details"];
|
|
13783
|
-
|
|
13784
|
-
|
|
13785
|
-
|
|
13784
|
+
}): Paragraph;
|
|
13785
|
+
|
|
13786
|
+
// ## Interfaces
|
|
13787
|
+
|
|
13788
|
+
/**
|
|
13789
|
+
* Info associated with nodes by the ecosystem.
|
|
13790
|
+
*
|
|
13791
|
+
* This space is guaranteed to never be specified by unist or specifications
|
|
13792
|
+
* implementing unist.
|
|
13793
|
+
* But you can use it in utilities and plugins to store data.
|
|
13794
|
+
*
|
|
13795
|
+
* This type can be augmented to register custom data.
|
|
13796
|
+
* For example:
|
|
13797
|
+
*
|
|
13798
|
+
* ```ts
|
|
13799
|
+
* declare module 'unist' {
|
|
13800
|
+
* interface Data {
|
|
13801
|
+
* // `someNode.data.myId` is typed as `number | undefined`
|
|
13802
|
+
* myId?: number | undefined
|
|
13803
|
+
* }
|
|
13804
|
+
* }
|
|
13805
|
+
* ```
|
|
13806
|
+
*/
|
|
13807
|
+
interface Data$1 {}
|
|
13808
|
+
|
|
13809
|
+
/**
|
|
13810
|
+
* One place in a source file.
|
|
13811
|
+
*/
|
|
13812
|
+
interface Point {
|
|
13813
|
+
/**
|
|
13814
|
+
* Line in a source file (1-indexed integer).
|
|
13815
|
+
*/
|
|
13816
|
+
line: number;
|
|
13817
|
+
|
|
13818
|
+
/**
|
|
13819
|
+
* Column in a source file (1-indexed integer).
|
|
13820
|
+
*/
|
|
13821
|
+
column: number;
|
|
13822
|
+
/**
|
|
13823
|
+
* Character in a source file (0-indexed integer).
|
|
13824
|
+
*/
|
|
13825
|
+
offset?: number | undefined;
|
|
13826
|
+
}
|
|
13827
|
+
|
|
13828
|
+
/**
|
|
13829
|
+
* Position of a node in a source document.
|
|
13830
|
+
*
|
|
13831
|
+
* A position is a range between two points.
|
|
13832
|
+
*/
|
|
13833
|
+
interface Position {
|
|
13834
|
+
/**
|
|
13835
|
+
* Place of the first character of the parsed source region.
|
|
13836
|
+
*/
|
|
13837
|
+
start: Point;
|
|
13838
|
+
|
|
13839
|
+
/**
|
|
13840
|
+
* Place of the first character after the parsed source region.
|
|
13841
|
+
*/
|
|
13842
|
+
end: Point;
|
|
13843
|
+
}
|
|
13844
|
+
|
|
13845
|
+
/**
|
|
13846
|
+
* Abstract unist node.
|
|
13847
|
+
*
|
|
13848
|
+
* The syntactic unit in unist syntax trees are called nodes.
|
|
13849
|
+
*
|
|
13850
|
+
* This interface is supposed to be extended.
|
|
13851
|
+
* If you can use {@link Literal} or {@link Parent}, you should.
|
|
13852
|
+
* But for example in markdown, a `thematicBreak` (`***`), is neither literal
|
|
13853
|
+
* nor parent, but still a node.
|
|
13854
|
+
*/
|
|
13855
|
+
interface Node$1 {
|
|
13856
|
+
/**
|
|
13857
|
+
* Node type.
|
|
13858
|
+
*/
|
|
13859
|
+
type: string;
|
|
13860
|
+
|
|
13861
|
+
/**
|
|
13862
|
+
* Info from the ecosystem.
|
|
13863
|
+
*/
|
|
13864
|
+
data?: Data$1 | undefined;
|
|
13865
|
+
|
|
13866
|
+
/**
|
|
13867
|
+
* Position of a node in a source document.
|
|
13868
|
+
*
|
|
13869
|
+
* Nodes that are generated (not in the original source document) must not
|
|
13870
|
+
* have a position.
|
|
13871
|
+
*/
|
|
13872
|
+
position?: Position | undefined;
|
|
13873
|
+
}
|
|
13874
|
+
|
|
13875
|
+
// ## Interfaces
|
|
13876
|
+
|
|
13877
|
+
/**
|
|
13878
|
+
* Info associated with an element.
|
|
13879
|
+
*/
|
|
13880
|
+
interface Attributes {
|
|
13881
|
+
[name: string]: string | null | undefined;
|
|
13882
|
+
}
|
|
13883
|
+
|
|
13884
|
+
/**
|
|
13885
|
+
* Info associated with xast nodes by the ecosystem.
|
|
13886
|
+
*
|
|
13887
|
+
* This space is guaranteed to never be specified by unist or xast.
|
|
13888
|
+
* But you can use it in utilities and plugins to store data.
|
|
13889
|
+
*
|
|
13890
|
+
* This type can be augmented to register custom data.
|
|
13891
|
+
* For example:
|
|
13892
|
+
*
|
|
13893
|
+
* ```ts
|
|
13894
|
+
* declare module 'xast' {
|
|
13895
|
+
* interface Data {
|
|
13896
|
+
* // `someNode.data.myId` is typed as `number | undefined`
|
|
13897
|
+
* myId?: number | undefined
|
|
13898
|
+
* }
|
|
13899
|
+
* }
|
|
13900
|
+
* ```
|
|
13901
|
+
*/
|
|
13902
|
+
interface Data extends Data$1 {}
|
|
13903
|
+
|
|
13904
|
+
// ## Content maps
|
|
13905
|
+
|
|
13906
|
+
/**
|
|
13907
|
+
* Union of registered xast nodes that can occur in {@link Element}.
|
|
13908
|
+
*
|
|
13909
|
+
* To register more custom xast nodes, add them to {@link ElementContentMap}.
|
|
13910
|
+
* They will be automatically added here.
|
|
13911
|
+
*/
|
|
13912
|
+
type ElementContent = ElementContentMap[keyof ElementContentMap];
|
|
13913
|
+
|
|
13914
|
+
/**
|
|
13915
|
+
* Registry of all xast nodes that can occur as children of {@link Element}.
|
|
13916
|
+
*
|
|
13917
|
+
* For a union of all {@link Element} children, see {@link ElementContent}.
|
|
13918
|
+
*/
|
|
13919
|
+
interface ElementContentMap {
|
|
13920
|
+
cdata: Cdata;
|
|
13921
|
+
comment: Comment;
|
|
13922
|
+
element: Element$1;
|
|
13923
|
+
instruction: Instruction;
|
|
13924
|
+
text: Text;
|
|
13925
|
+
}
|
|
13926
|
+
|
|
13927
|
+
/**
|
|
13928
|
+
* Union of registered xast nodes that can occur in {@link Root}.
|
|
13929
|
+
*
|
|
13930
|
+
* To register custom xast nodes, add them to {@link RootContentMap}.
|
|
13931
|
+
* They will be automatically added here.
|
|
13932
|
+
*/
|
|
13933
|
+
type RootContent = RootContentMap[keyof RootContentMap];
|
|
13934
|
+
|
|
13935
|
+
/**
|
|
13936
|
+
* Registry of all xast nodes that can occur as children of {@link Root}.
|
|
13937
|
+
*
|
|
13938
|
+
* > 👉 **Note**: {@link Root} does not need to be an entire document.
|
|
13939
|
+
* > it can also be a fragment.
|
|
13940
|
+
*
|
|
13941
|
+
* For a union of all {@link Root} children, see {@link RootContent}.
|
|
13942
|
+
*/
|
|
13943
|
+
interface RootContentMap {
|
|
13944
|
+
cdata: Cdata;
|
|
13945
|
+
comment: Comment;
|
|
13946
|
+
doctype: Doctype;
|
|
13947
|
+
element: Element$1;
|
|
13948
|
+
instruction: Instruction;
|
|
13949
|
+
text: Text;
|
|
13950
|
+
}
|
|
13951
|
+
|
|
13952
|
+
// ## Abstract nodes
|
|
13953
|
+
|
|
13954
|
+
/**
|
|
13955
|
+
* Abstract xast node that contains the smallest possible value.
|
|
13956
|
+
*
|
|
13957
|
+
* This interface is supposed to be extended if you make custom xast nodes.
|
|
13958
|
+
*
|
|
13959
|
+
* For a union of all registered xast literals, see {@link Literals}.
|
|
13960
|
+
*/
|
|
13961
|
+
interface Literal extends Node {
|
|
13962
|
+
/**
|
|
13963
|
+
* Plain-text value.
|
|
13964
|
+
*/
|
|
13965
|
+
value: string;
|
|
13966
|
+
}
|
|
13786
13967
|
|
|
13787
13968
|
/**
|
|
13788
|
-
*
|
|
13969
|
+
* Abstract xast node.
|
|
13970
|
+
*
|
|
13971
|
+
* This interface is supposed to be extended.
|
|
13972
|
+
* If you can use {@link Literal} or {@link Parent}, you should.
|
|
13973
|
+
* But for example in XML, a `Doctype` is neither literal nor parent, but
|
|
13974
|
+
* still a node.
|
|
13975
|
+
*
|
|
13976
|
+
* To register custom xast nodes, add them to {@link RootContentMap} and other
|
|
13977
|
+
* places where relevant (such as {@link ElementContentMap}).
|
|
13978
|
+
*
|
|
13979
|
+
* For a union of all registered xast nodes, see {@link Nodes}.
|
|
13980
|
+
*/
|
|
13981
|
+
interface Node extends Node$1 {
|
|
13982
|
+
/**
|
|
13983
|
+
* Info from the ecosystem.
|
|
13984
|
+
*/
|
|
13985
|
+
data?: Data | undefined;
|
|
13986
|
+
}
|
|
13987
|
+
|
|
13988
|
+
/**
|
|
13989
|
+
* Abstract xast node that contains other xast nodes (*children*).
|
|
13990
|
+
*
|
|
13991
|
+
* This interface is supposed to be extended if you make custom xast nodes.
|
|
13992
|
+
*
|
|
13993
|
+
* For a union of all registered xast parents, see {@link Parents}.
|
|
13994
|
+
*/
|
|
13995
|
+
interface Parent extends Node {
|
|
13996
|
+
/**
|
|
13997
|
+
* List of children.
|
|
13998
|
+
*/
|
|
13999
|
+
children: RootContent[];
|
|
14000
|
+
}
|
|
14001
|
+
|
|
14002
|
+
// ## Concrete nodes
|
|
14003
|
+
|
|
14004
|
+
/**
|
|
14005
|
+
* XML CDATA section.
|
|
14006
|
+
*/
|
|
14007
|
+
interface Cdata extends Literal {
|
|
14008
|
+
/**
|
|
14009
|
+
* Node type of XML CDATA sections in xast.
|
|
14010
|
+
*/
|
|
14011
|
+
type: "cdata";
|
|
14012
|
+
/**
|
|
14013
|
+
* Data associated with the cdata.
|
|
14014
|
+
*/
|
|
14015
|
+
data?: CdataData | undefined;
|
|
14016
|
+
}
|
|
14017
|
+
|
|
14018
|
+
/**
|
|
14019
|
+
* Info associated with xast instructions by the ecosystem.
|
|
14020
|
+
*/
|
|
14021
|
+
interface CdataData extends Data {}
|
|
14022
|
+
|
|
14023
|
+
/**
|
|
14024
|
+
* XML comment.
|
|
14025
|
+
*/
|
|
14026
|
+
interface Comment extends Literal {
|
|
14027
|
+
/**
|
|
14028
|
+
* Node type of XML comments in xast.
|
|
14029
|
+
*/
|
|
14030
|
+
type: "comment";
|
|
14031
|
+
/**
|
|
14032
|
+
* Data associated with the comment.
|
|
14033
|
+
*/
|
|
14034
|
+
data?: CommentData | undefined;
|
|
14035
|
+
}
|
|
14036
|
+
|
|
14037
|
+
/**
|
|
14038
|
+
* Info associated with xast comments by the ecosystem.
|
|
14039
|
+
*/
|
|
14040
|
+
interface CommentData extends Data {}
|
|
14041
|
+
|
|
14042
|
+
/**
|
|
14043
|
+
* XML document type.
|
|
14044
|
+
*/
|
|
14045
|
+
interface Doctype extends Node {
|
|
14046
|
+
/**
|
|
14047
|
+
* Node type of XML document types in xast.
|
|
14048
|
+
*/
|
|
14049
|
+
type: "doctype";
|
|
14050
|
+
/**
|
|
14051
|
+
* Name of the root element.
|
|
14052
|
+
*
|
|
14053
|
+
* To illustrate, for `<!DOCTYPE html>`, `name` is `'html'`.
|
|
14054
|
+
*/
|
|
14055
|
+
name: string;
|
|
14056
|
+
/**
|
|
14057
|
+
* Public identifier of the document.
|
|
14058
|
+
*/
|
|
14059
|
+
public?: string | undefined;
|
|
14060
|
+
/**
|
|
14061
|
+
* System identifier of the document.
|
|
14062
|
+
*/
|
|
14063
|
+
system?: string | undefined;
|
|
14064
|
+
/**
|
|
14065
|
+
* Data associated with the doctype.
|
|
14066
|
+
*/
|
|
14067
|
+
data?: DoctypeData | undefined;
|
|
14068
|
+
}
|
|
14069
|
+
|
|
14070
|
+
/**
|
|
14071
|
+
* Info associated with xast doctypes by the ecosystem.
|
|
14072
|
+
*/
|
|
14073
|
+
interface DoctypeData extends Data {}
|
|
14074
|
+
|
|
14075
|
+
/**
|
|
14076
|
+
* XML processing instruction.
|
|
14077
|
+
*/
|
|
14078
|
+
interface Instruction extends Literal {
|
|
14079
|
+
/**
|
|
14080
|
+
* Node type of XML processing instructions in xast.
|
|
14081
|
+
*/
|
|
14082
|
+
type: "instruction";
|
|
14083
|
+
/**
|
|
14084
|
+
* Name of the instruction.
|
|
14085
|
+
*
|
|
14086
|
+
* To illustrate, for `<?php?>`, `name` is `'php'`.
|
|
14087
|
+
*/
|
|
14088
|
+
name: string;
|
|
14089
|
+
/**
|
|
14090
|
+
* Data associated with the instruction.
|
|
14091
|
+
*/
|
|
14092
|
+
data?: InstructionData | undefined;
|
|
14093
|
+
}
|
|
14094
|
+
|
|
14095
|
+
/**
|
|
14096
|
+
* Info associated with xast instructions by the ecosystem.
|
|
14097
|
+
*/
|
|
14098
|
+
interface InstructionData extends Data {}
|
|
14099
|
+
|
|
14100
|
+
/**
|
|
14101
|
+
* XML element.
|
|
14102
|
+
*/
|
|
14103
|
+
interface Element$1 extends Parent {
|
|
14104
|
+
/**
|
|
14105
|
+
* Node type of elements.
|
|
14106
|
+
*/
|
|
14107
|
+
type: "element";
|
|
14108
|
+
/**
|
|
14109
|
+
* Qualified name (such as `'artist'` or `'svg:rect'`) of the element.
|
|
14110
|
+
*/
|
|
14111
|
+
name: string;
|
|
14112
|
+
/**
|
|
14113
|
+
* Info associated with the element.
|
|
14114
|
+
*/
|
|
14115
|
+
attributes: Attributes;
|
|
14116
|
+
/**
|
|
14117
|
+
* Children of element.
|
|
14118
|
+
*/
|
|
14119
|
+
children: ElementContent[];
|
|
14120
|
+
/**
|
|
14121
|
+
* Data associated with the element.
|
|
14122
|
+
*/
|
|
14123
|
+
data?: ElementData | undefined;
|
|
14124
|
+
}
|
|
14125
|
+
|
|
14126
|
+
/**
|
|
14127
|
+
* Info associated with xast elements by the ecosystem.
|
|
14128
|
+
*/
|
|
14129
|
+
interface ElementData extends Data {}
|
|
14130
|
+
|
|
14131
|
+
/**
|
|
14132
|
+
* Document fragment or a whole document.
|
|
14133
|
+
*
|
|
14134
|
+
* Should be used as the root of a tree and must not be used as a child.
|
|
14135
|
+
*
|
|
14136
|
+
* XML specifies that documents should have exactly one element child, so a
|
|
14137
|
+
* root should have exactly one element child when representing a whole
|
|
14138
|
+
* document.
|
|
14139
|
+
*/
|
|
14140
|
+
interface Root extends Parent {
|
|
14141
|
+
/**
|
|
14142
|
+
* Node type of xast root.
|
|
14143
|
+
*/
|
|
14144
|
+
type: "root";
|
|
14145
|
+
/**
|
|
14146
|
+
* Data associated with the xast root.
|
|
14147
|
+
*/
|
|
14148
|
+
data?: RootData | undefined;
|
|
14149
|
+
}
|
|
14150
|
+
|
|
14151
|
+
/**
|
|
14152
|
+
* Info associated with xast root nodes by the ecosystem.
|
|
14153
|
+
*/
|
|
14154
|
+
interface RootData extends Data {}
|
|
14155
|
+
|
|
14156
|
+
/**
|
|
14157
|
+
* XML character data (plain text).
|
|
14158
|
+
*/
|
|
14159
|
+
interface Text extends Literal {
|
|
14160
|
+
/**
|
|
14161
|
+
* Node type of XML character data (plain text) in xast.
|
|
14162
|
+
*/
|
|
14163
|
+
type: "text";
|
|
14164
|
+
/**
|
|
14165
|
+
* Data associated with the text.
|
|
14166
|
+
*/
|
|
14167
|
+
data?: TextData | undefined;
|
|
14168
|
+
}
|
|
14169
|
+
|
|
14170
|
+
/**
|
|
14171
|
+
* Info associated with xast texts by the ecosystem.
|
|
14172
|
+
*/
|
|
14173
|
+
interface TextData extends Data {}
|
|
14174
|
+
|
|
14175
|
+
/**
|
|
14176
|
+
* Unit conversion utilities for DOCX processing
|
|
14177
|
+
* Handles conversions between TWIPs, EMUs, pixels, and other units
|
|
14178
|
+
*/
|
|
14179
|
+
/**
|
|
14180
|
+
* DOCX DPI (dots per inch) for pixel conversions
|
|
14181
|
+
* Word uses 96 DPI internally
|
|
13789
14182
|
*/
|
|
13790
14183
|
declare const DOCX_DPI = 96;
|
|
13791
14184
|
/**
|
|
13792
|
-
* Convert TWIPs to pixels
|
|
14185
|
+
* Convert TWIPs to CSS pixels (returns number)
|
|
14186
|
+
* @param twip - Value in TWIPs (1 inch = 1440 TWIPs)
|
|
14187
|
+
* @returns Number value in pixels
|
|
14188
|
+
*
|
|
14189
|
+
* @example
|
|
14190
|
+
* convertTwipToPixels(1440) // returns 96
|
|
14191
|
+
*/
|
|
14192
|
+
declare function convertTwipToPixels(twip: number): number;
|
|
14193
|
+
/**
|
|
14194
|
+
* Convert TWIPs to CSS string (returns "px" string)
|
|
14195
|
+
* @param twip - Value in TWIPs
|
|
14196
|
+
* @returns CSS value string in pixels (e.g., "20px")
|
|
14197
|
+
*
|
|
14198
|
+
* @example
|
|
14199
|
+
* convertTwipToCssString(1440) // returns "96px"
|
|
13793
14200
|
*/
|
|
13794
|
-
declare
|
|
14201
|
+
declare function convertTwipToCssString(twip: number): string;
|
|
14202
|
+
/**
|
|
14203
|
+
* Convert pixels to TWIPs
|
|
14204
|
+
* @param px - Value in pixels
|
|
14205
|
+
* @returns Value in TWIPs
|
|
14206
|
+
*
|
|
14207
|
+
* @example
|
|
14208
|
+
* convertPixelsToTwip(96) // returns 1440
|
|
14209
|
+
*/
|
|
14210
|
+
declare function convertPixelsToTwip(px: number): number;
|
|
14211
|
+
/**
|
|
14212
|
+
* Convert EMUs to pixels
|
|
14213
|
+
* EMU = English Metric Unit (1 inch = 914400 EMUs)
|
|
14214
|
+
* @param emu - Value in EMUs
|
|
14215
|
+
* @returns Value in pixels
|
|
14216
|
+
*
|
|
14217
|
+
* @example
|
|
14218
|
+
* convertEmuToPixels(914400) // returns 96
|
|
14219
|
+
*/
|
|
14220
|
+
declare function convertEmuToPixels(emu: number): number;
|
|
14221
|
+
/**
|
|
14222
|
+
* Convert pixels to EMUs
|
|
14223
|
+
* @param px - Value in pixels
|
|
14224
|
+
* @returns Value in EMUs
|
|
14225
|
+
*
|
|
14226
|
+
* @example
|
|
14227
|
+
* convertPixelsToEmu(96) // returns 914400
|
|
14228
|
+
*/
|
|
14229
|
+
declare function convertPixelsToEmu(px: number): number;
|
|
14230
|
+
/**
|
|
14231
|
+
* Convert EMU string to pixels
|
|
14232
|
+
* @param emuStr - EMU value as string
|
|
14233
|
+
* @returns Pixel value or undefined if invalid
|
|
14234
|
+
*
|
|
14235
|
+
* @example
|
|
14236
|
+
* convertEmuStringToPixels("914400") // returns 96
|
|
14237
|
+
* convertEmuStringToPixels("invalid") // returns undefined
|
|
14238
|
+
*/
|
|
14239
|
+
declare function convertEmuStringToPixels(emuStr: string): number | undefined;
|
|
13795
14240
|
/**
|
|
13796
14241
|
* Parse CSS length value to pixels
|
|
13797
14242
|
* Supports: px, pt, em, rem, %, and unitless values
|
|
14243
|
+
* @param value - CSS length value (e.g., "20px", "1.5em", "100%")
|
|
14244
|
+
* @returns Value in pixels
|
|
14245
|
+
*
|
|
14246
|
+
* @example
|
|
14247
|
+
* convertCssLengthToPixels("20px") // returns 20
|
|
14248
|
+
* convertCssLengthToPixels("1.5em") // returns 24
|
|
14249
|
+
* convertCssLengthToPixels("100%") // returns 16
|
|
13798
14250
|
*/
|
|
13799
|
-
declare
|
|
14251
|
+
declare function convertCssLengthToPixels(value: string): number;
|
|
13800
14252
|
/**
|
|
13801
|
-
*
|
|
14253
|
+
* Type for universal measure values in DOCX
|
|
14254
|
+
* Can be a number (already in inches) or a string with unit suffix
|
|
13802
14255
|
*/
|
|
13803
|
-
|
|
14256
|
+
type PositiveUniversalMeasure = `${number}${"in" | "mm" | "cm" | "pt" | "pc" | "pi"}`;
|
|
13804
14257
|
/**
|
|
13805
14258
|
* Convert universal measure to inches
|
|
13806
14259
|
* Compatible with docx.js UniversalMeasure type
|
|
14260
|
+
* @param value - Value in various units (number or string)
|
|
14261
|
+
* @returns Value in inches
|
|
14262
|
+
*
|
|
14263
|
+
* @example
|
|
14264
|
+
* convertMeasureToInches(6.5) // returns 6.5
|
|
14265
|
+
* convertMeasureToInches("1in") // returns 1
|
|
14266
|
+
* convertMeasureToInches("25.4mm") // returns ~1
|
|
13807
14267
|
*/
|
|
13808
|
-
declare
|
|
14268
|
+
declare function convertMeasureToInches(value: number | PositiveUniversalMeasure): number;
|
|
13809
14269
|
/**
|
|
13810
14270
|
* Convert universal measure to pixels
|
|
13811
14271
|
* Compatible with docx.js UniversalMeasure type
|
|
14272
|
+
* @param value - Value in various units (number or string)
|
|
14273
|
+
* @returns Value in pixels
|
|
14274
|
+
*
|
|
14275
|
+
* @example
|
|
14276
|
+
* convertMeasureToPixels("1in") // returns 96
|
|
14277
|
+
* convertMeasureToPixels(6.5) // returns 624
|
|
13812
14278
|
*/
|
|
13813
|
-
declare
|
|
14279
|
+
declare function convertMeasureToPixels(value: number | PositiveUniversalMeasure): number;
|
|
14280
|
+
|
|
13814
14281
|
/**
|
|
13815
|
-
*
|
|
14282
|
+
* Color conversion utilities for DOCX processing
|
|
14283
|
+
* Handles conversion between color names and hex values
|
|
13816
14284
|
*/
|
|
13817
|
-
declare const calculateEffectiveContentWidth: (options?: DocxExportOptions) => number;
|
|
13818
|
-
|
|
13819
14285
|
/**
|
|
13820
14286
|
* Color name to hex value mapping
|
|
14287
|
+
* Includes common HTML/CSS color names
|
|
13821
14288
|
*/
|
|
14289
|
+
declare const COLOR_NAME_TO_HEX: Record<string, string>;
|
|
13822
14290
|
/**
|
|
13823
14291
|
* Convert color name or hex to normalized hex value
|
|
14292
|
+
* @param color - Color as name (e.g., "red") or hex (e.g., "#FF0000" or "FF0000")
|
|
14293
|
+
* @returns Normalized hex color string (e.g., "#FF0000") or undefined if invalid
|
|
14294
|
+
*
|
|
14295
|
+
* @example
|
|
14296
|
+
* convertColorToHex("red") // returns "#FF0000"
|
|
14297
|
+
* convertColorToHex("#FF0000") // returns "#FF0000"
|
|
14298
|
+
* convertColorToHex("FF0000") // returns "#FF0000"
|
|
14299
|
+
* convertColorToHex("invalid") // returns undefined
|
|
14300
|
+
*/
|
|
14301
|
+
declare function convertColorToHex(color?: string): string | undefined;
|
|
14302
|
+
/**
|
|
14303
|
+
* Normalize hex color to ensure it has a # prefix
|
|
14304
|
+
* @param color - Color value with or without # prefix
|
|
14305
|
+
* @returns Hex color with # prefix
|
|
14306
|
+
*
|
|
14307
|
+
* @example
|
|
14308
|
+
* normalizeHexColor("FF0000") // returns "#FF0000"
|
|
14309
|
+
* normalizeHexColor("#FF0000") // returns "#FF0000"
|
|
13824
14310
|
*/
|
|
13825
|
-
declare
|
|
14311
|
+
declare function normalizeHexColor(color: string): string;
|
|
13826
14312
|
|
|
14313
|
+
/**
|
|
14314
|
+
* XML utility functions for DOCX processing
|
|
14315
|
+
* Provides helper functions for traversing and parsing XML trees (xast)
|
|
14316
|
+
*/
|
|
14317
|
+
|
|
14318
|
+
/**
|
|
14319
|
+
* Find direct child element with specified name
|
|
14320
|
+
* @param node - Parent XML element or root node
|
|
14321
|
+
* @param name - Child element name to find (can include namespace prefix, e.g., "w:p")
|
|
14322
|
+
* @returns Child element if found, null otherwise
|
|
14323
|
+
*
|
|
14324
|
+
* @example
|
|
14325
|
+
* const paragraph = findChild(document, "w:p");
|
|
14326
|
+
*/
|
|
14327
|
+
declare function findChild(node: Root | Element$1, name: string): Element$1 | null;
|
|
14328
|
+
/**
|
|
14329
|
+
* Find deep descendant element with specified name (recursive)
|
|
14330
|
+
* Searches through all descendants, not just direct children
|
|
14331
|
+
* @param node - Root XML element
|
|
14332
|
+
* @param name - Descendant element name to find
|
|
14333
|
+
* @returns Descendant element if found, null otherwise
|
|
14334
|
+
*
|
|
14335
|
+
* @example
|
|
14336
|
+
* const textElement = findDeepChild(run, "w:t");
|
|
14337
|
+
*/
|
|
14338
|
+
declare function findDeepChild(node: Root | Element$1, name: string): Element$1 | null;
|
|
14339
|
+
/**
|
|
14340
|
+
* Find all deep descendant elements with specified name (recursive)
|
|
14341
|
+
* @param node - Root XML element
|
|
14342
|
+
* @param name - Descendant element name to find
|
|
14343
|
+
* @returns Array of matching descendant elements
|
|
14344
|
+
*
|
|
14345
|
+
* @example
|
|
14346
|
+
* const allTextRuns = findDeepChildren(paragraph, "w:r");
|
|
14347
|
+
*/
|
|
14348
|
+
declare function findDeepChildren(node: Root | Element$1, name: string): Element$1[];
|
|
14349
|
+
/**
|
|
14350
|
+
* Parse TWIP attribute value from element attributes
|
|
14351
|
+
* TWIP = Twentieth of a Point (1 inch = 1440 TWIPs)
|
|
14352
|
+
* @param attributes - Element attributes object
|
|
14353
|
+
* @param name - Attribute name to parse
|
|
14354
|
+
* @returns TWIP value as string, or undefined if not found
|
|
14355
|
+
*
|
|
14356
|
+
* @example
|
|
14357
|
+
* const leftIndent = parseTwipAttr(pPr.attributes, "w:left");
|
|
14358
|
+
*/
|
|
14359
|
+
declare function parseTwipAttr(attributes: Record<string, any> | {
|
|
14360
|
+
[key: string]: string | undefined;
|
|
14361
|
+
}, name: string): string | undefined;
|
|
14362
|
+
|
|
14363
|
+
/**
|
|
14364
|
+
* Calculate effective content width from document options
|
|
14365
|
+
*/
|
|
14366
|
+
declare function calculateEffectiveContentWidth(options?: DocxExportOptions): number;
|
|
14367
|
+
|
|
14368
|
+
/**
|
|
14369
|
+
* Convert image MIME type to DOCX type
|
|
14370
|
+
*/
|
|
14371
|
+
declare function convertToDocxImageType(mimeType?: string): "jpg" | "png" | "gif" | "bmp";
|
|
13827
14372
|
/**
|
|
13828
14373
|
* Extract image type from URL or base64 data
|
|
13829
14374
|
*/
|
|
13830
|
-
declare
|
|
14375
|
+
declare function getImageTypeFromSrc(src: string): "png" | "jpeg" | "gif" | "bmp" | "tiff";
|
|
13831
14376
|
/**
|
|
13832
14377
|
* Create floating options for full-width images
|
|
13833
14378
|
*/
|
|
13834
|
-
declare
|
|
14379
|
+
declare function createFloatingOptions(): {
|
|
13835
14380
|
horizontalPosition: {
|
|
13836
14381
|
relative: string;
|
|
13837
14382
|
align: string;
|
|
@@ -13847,29 +14392,29 @@ declare const createFloatingOptions: () => {
|
|
|
13847
14392
|
/**
|
|
13848
14393
|
* Get image width with priority: node attrs > image meta > calculated > default
|
|
13849
14394
|
*/
|
|
13850
|
-
declare
|
|
14395
|
+
declare function getImageWidth(node: {
|
|
13851
14396
|
attrs?: {
|
|
13852
14397
|
width?: number | null;
|
|
13853
14398
|
};
|
|
13854
14399
|
}, imageMeta?: {
|
|
13855
14400
|
width?: number;
|
|
13856
14401
|
height?: number;
|
|
13857
|
-
}, maxWidth?: number | PositiveUniversalMeasure)
|
|
14402
|
+
}, maxWidth?: number | PositiveUniversalMeasure$1): number;
|
|
13858
14403
|
/**
|
|
13859
14404
|
* Get image height with priority: node attrs > image meta > calculated > default
|
|
13860
14405
|
*/
|
|
13861
|
-
declare
|
|
14406
|
+
declare function getImageHeight(node: {
|
|
13862
14407
|
attrs?: {
|
|
13863
14408
|
height?: number | null;
|
|
13864
14409
|
};
|
|
13865
14410
|
}, width: number, imageMeta?: {
|
|
13866
14411
|
width?: number;
|
|
13867
14412
|
height?: number;
|
|
13868
|
-
}, maxWidth?: number | PositiveUniversalMeasure)
|
|
14413
|
+
}, maxWidth?: number | PositiveUniversalMeasure$1): number;
|
|
13869
14414
|
/**
|
|
13870
14415
|
* Fetch image data and metadata from URL
|
|
13871
14416
|
*/
|
|
13872
|
-
declare
|
|
14417
|
+
declare function getImageDataAndMeta(url: string): Promise<{
|
|
13873
14418
|
data: Uint8Array;
|
|
13874
14419
|
meta: ImageMeta;
|
|
13875
14420
|
}>;
|
|
@@ -13879,5 +14424,5 @@ declare const getImageDataAndMeta: (url: string) => Promise<{
|
|
|
13879
14424
|
*/
|
|
13880
14425
|
declare const applyParagraphStyleAttributes: <T extends Record<string, unknown>>(options: T, attrs?: ParagraphNode["attrs"]) => T;
|
|
13881
14426
|
|
|
13882
|
-
export { DOCX_DPI, applyParagraphStyleAttributes, calculateEffectiveContentWidth, convertBlockquote, convertBulletList, convertCodeBlock, convertColorToHex, convertCssLengthToPixels,
|
|
13883
|
-
export type { BlockNode, BlockquoteNode, BulletListNode, CodeBlockNode, DetailsContentNode, DetailsNode, DetailsSummaryNode, DocumentNode, DocxExportOptions, HardBreakNode, HeadingNode, HorizontalRuleNode, ImageFloatingOptions, ImageNode, ImageOutlineOptions, JSONContent, ListItemNode, ListOptions, Mark, OrderedListNode, ParagraphNode, TableCellBorder, TableCellNode, TableHeaderNode, TableNode, TableRowNode, TaskItemNode, TaskListNode, TextContent, TextNode };
|
|
14427
|
+
export { COLOR_NAME_TO_HEX, DOCX_DPI, applyParagraphStyleAttributes, calculateEffectiveContentWidth, convertBlockquote, convertBulletList, convertCodeBlock, convertColorToHex, convertCssLengthToPixels, convertDetailsSummary, convertDocument, convertEmuStringToPixels, convertEmuToPixels, convertHardBreak, convertHeading, convertHorizontalRule, convertImage, convertList, convertListItem, convertMeasureToInches, convertMeasureToPixels, convertNode, convertOrderedList, convertParagraph, convertPixelsToEmu, convertPixelsToTwip, convertTable, convertTableCell, convertTableHeader, convertTableRow, convertTaskItem, convertTaskList, convertText, convertTextNodes, convertToDocxImageType, convertTwipToCssString, convertTwipToPixels, createFloatingOptions, findChild, findDeepChild, findDeepChildren, generateDOCX, getImageDataAndMeta, getImageHeight, getImageTypeFromSrc, getImageWidth, normalizeHexColor, parseTwipAttr };
|
|
14428
|
+
export type { BlockNode, BlockquoteNode, BulletListNode, CodeBlockNode, DetailsContentNode, DetailsNode, DetailsSummaryNode, DocumentNode, DocxExportOptions, HardBreakNode, HeadingNode, HorizontalRuleNode, ImageFloatingOptions, ImageNode, ImageOutlineOptions, JSONContent, ListItemNode, ListOptions, Mark, OrderedListNode, ParagraphNode, PositiveUniversalMeasure, TableCellBorder, TableCellNode, TableHeaderNode, TableNode, TableRowNode, TaskItemNode, TaskListNode, TextContent, TextNode };
|