@superdoc-dev/sdk 1.8.0-next.5 → 1.8.0-next.52
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/generated/client.cjs +4 -0
- package/dist/generated/client.d.ts +924 -15
- package/dist/generated/client.d.ts.map +1 -1
- package/dist/generated/client.js +4 -0
- package/dist/generated/contract.cjs +2735 -158
- package/dist/generated/contract.d.ts.map +1 -1
- package/dist/generated/contract.js +2738 -158
- package/dist/generated/intent-dispatch.generated.cjs +5 -0
- package/dist/generated/intent-dispatch.generated.d.ts.map +1 -1
- package/dist/generated/intent-dispatch.generated.js +5 -0
- package/package.json +6 -6
- package/tools/__pycache__/__init__.cpython-312.pyc +0 -0
- package/tools/__pycache__/intent_dispatch_generated.cpython-312.pyc +0 -0
- package/tools/catalog.json +239 -10
- package/tools/intent_dispatch_generated.py +10 -0
- package/tools/prompt-templates/system-prompt-core.md +88 -0
- package/tools/system-prompt-mcp.md +88 -0
- package/tools/system-prompt.md +88 -0
- package/tools/tools-policy.json +1 -1
- package/tools/tools.anthropic.json +201 -10
- package/tools/tools.generic.json +207 -11
- package/tools/tools.openai.json +201 -10
- package/tools/tools.vercel.json +201 -10
|
@@ -209,6 +209,94 @@ Use preset "disc" for bullets, "decimal" for numbered. WARNING: the range conver
|
|
|
209
209
|
|
|
210
210
|
3. To change a bullet list to numbered: `superdoc_list({action: "set_type", target: {kind: "block", nodeType: "listItem", nodeId: "<anyItemId>"}, kind: "ordered"})`
|
|
211
211
|
|
|
212
|
+
### Add items to an existing list
|
|
213
|
+
|
|
214
|
+
To add a new item adjacent to an existing list item, use `superdoc_list({action: "insert"})`, NOT `superdoc_create({action: "paragraph"})` — the latter creates a standalone paragraph that is not part of the list:
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
superdoc_get_content({action: "blocks"}) // find the listItem nodeId you want to insert next to
|
|
218
|
+
superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, position: "after", text: "New item text"})
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
**Level inheritance.** The new item inherits the target's nesting level. Insert after a level-0 item → new item is level 0. Insert after a level-2 item → new item is level 2. To change the level, chain `indent` / `outdent` / `set_level` on the nodeId returned in the insert response.
|
|
222
|
+
|
|
223
|
+
**Use the nodeId from the response directly.** `superdoc_list({action: "insert"})` returns `{item: {nodeId: "<id>"}}` — that id is ready for subsequent `indent`, `outdent`, `set_level`, or text edits. You do NOT need to re-fetch blocks between the insert and the follow-up operation.
|
|
224
|
+
|
|
225
|
+
### Add a sub-point under an existing item
|
|
226
|
+
|
|
227
|
+
Insert a peer, then indent it one level:
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
// 1. Insert a peer item after the parent — new item is at the parent's level
|
|
231
|
+
const resp = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parentItemId>"}, position: "after", text: "Sub-point"})
|
|
232
|
+
|
|
233
|
+
// 2. Indent using the nodeId from resp.item.nodeId
|
|
234
|
+
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<resp.item.nodeId>"}})
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Build a nested list with mixed levels
|
|
238
|
+
|
|
239
|
+
`lists.create` produces a flat list. Add nesting by chaining `insert` + `indent` / `set_level`, using the nodeId returned by each insert to target the next step:
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
// Starting point: a list item at level 0 ("Parent" with nodeId <parent>)
|
|
243
|
+
|
|
244
|
+
// Sibling at level 0
|
|
245
|
+
const r1 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parent>"}, position: "after", text: "Sibling"})
|
|
246
|
+
|
|
247
|
+
// Child at level 1 (insert after r1, then indent)
|
|
248
|
+
const r2 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r1.item.nodeId>"}, position: "after", text: "Child"})
|
|
249
|
+
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}})
|
|
250
|
+
|
|
251
|
+
// Grandchild at level 3 (insert after r2, then jump to level 3 directly)
|
|
252
|
+
const r3 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}, position: "after", text: "Deep"})
|
|
253
|
+
superdoc_list({action: "set_level", target: {kind: "block", nodeType: "listItem", nodeId: "<r3.item.nodeId>"}, level: 3})
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
`indent` bumps the level by one (bounded 0–8). `set_level` jumps directly to any level 0–8. Markers update automatically based on the list's definition for each level (e.g. `1.` / `a.` / `i.` for an ordered list).
|
|
257
|
+
|
|
258
|
+
### Merge two adjacent lists into one
|
|
259
|
+
|
|
260
|
+
Use `merge` — it handles the common case where two ordered or bulleted lists sit next to each other and should become one continuous list. Absorbed items adopt the absorbing sequence's definition, and any empty paragraphs between the two lists are removed so numbering flows continuously.
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
superdoc_get_content({action: "blocks"}) // find a listItem in either sequence
|
|
264
|
+
// To merge with the previous sequence:
|
|
265
|
+
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withPrevious"})
|
|
266
|
+
// Or with the next sequence:
|
|
267
|
+
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withNext"})
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### Split a list into two
|
|
271
|
+
|
|
272
|
+
Use `split` to break one list into two independent lists at a specific item. The target and everything after become a new sequence that restarts numbering at 1:
|
|
273
|
+
|
|
274
|
+
```
|
|
275
|
+
superdoc_list({action: "split", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}})
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
Pass `restartNumbering: false` if you want the new half to keep counting from where the original left off.
|
|
279
|
+
|
|
280
|
+
### Restart numbering at a specific item
|
|
281
|
+
|
|
282
|
+
For ordered lists. To make item N restart from a chosen number (commonly 1):
|
|
283
|
+
|
|
284
|
+
```
|
|
285
|
+
superdoc_list({action: "set_value", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, value: 1})
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
Pass `value: null` to clear a previously-set restart override and let the item resume natural numbering.
|
|
289
|
+
|
|
290
|
+
### Continue numbering across a break
|
|
291
|
+
|
|
292
|
+
For ordered lists. When two sibling sequences should be numbered as one (e.g. numbering jumps back to 1 and you want it to continue from where the previous list left off), target the FIRST item of the second sequence:
|
|
293
|
+
|
|
294
|
+
```
|
|
295
|
+
superdoc_list({action: "continue_previous", target: {kind: "block", nodeType: "listItem", nodeId: "<firstItemOfSecondList>"}})
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
Fails with `NO_COMPATIBLE_PREVIOUS` or `INCOMPATIBLE_DEFINITIONS` if no prior sequence shares the same abstract definition. In that case, use `merge` instead — it handles mismatched definitions, removes empty gap paragraphs, and produces one continuous list.
|
|
299
|
+
|
|
212
300
|
### Insert content into a document (new or existing)
|
|
213
301
|
|
|
214
302
|
Markdown insert creates block structure but uses default formatting. You MUST follow up with formatting so inserted content looks like it belongs in the document.
|
package/tools/system-prompt.md
CHANGED
|
@@ -164,6 +164,94 @@ Use preset "disc" for bullets, "decimal" for numbered. WARNING: the range conver
|
|
|
164
164
|
|
|
165
165
|
3. To change a bullet list to numbered: `superdoc_list({action: "set_type", target: {kind: "block", nodeType: "listItem", nodeId: "<anyItemId>"}, kind: "ordered"})`
|
|
166
166
|
|
|
167
|
+
### Add items to an existing list
|
|
168
|
+
|
|
169
|
+
To add a new item adjacent to an existing list item, use `superdoc_list({action: "insert"})`, NOT `superdoc_create({action: "paragraph"})` — the latter creates a standalone paragraph that is not part of the list:
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
superdoc_get_content({action: "blocks"}) // find the listItem nodeId you want to insert next to
|
|
173
|
+
superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, position: "after", text: "New item text"})
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Level inheritance.** The new item inherits the target's nesting level. Insert after a level-0 item → new item is level 0. Insert after a level-2 item → new item is level 2. To change the level, chain `indent` / `outdent` / `set_level` on the nodeId returned in the insert response.
|
|
177
|
+
|
|
178
|
+
**Use the nodeId from the response directly.** `superdoc_list({action: "insert"})` returns `{item: {nodeId: "<id>"}}` — that id is ready for subsequent `indent`, `outdent`, `set_level`, or text edits. You do NOT need to re-fetch blocks between the insert and the follow-up operation.
|
|
179
|
+
|
|
180
|
+
### Add a sub-point under an existing item
|
|
181
|
+
|
|
182
|
+
Insert a peer, then indent it one level:
|
|
183
|
+
|
|
184
|
+
```
|
|
185
|
+
// 1. Insert a peer item after the parent — new item is at the parent's level
|
|
186
|
+
const resp = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parentItemId>"}, position: "after", text: "Sub-point"})
|
|
187
|
+
|
|
188
|
+
// 2. Indent using the nodeId from resp.item.nodeId
|
|
189
|
+
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<resp.item.nodeId>"}})
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Build a nested list with mixed levels
|
|
193
|
+
|
|
194
|
+
`lists.create` produces a flat list. Add nesting by chaining `insert` + `indent` / `set_level`, using the nodeId returned by each insert to target the next step:
|
|
195
|
+
|
|
196
|
+
```
|
|
197
|
+
// Starting point: a list item at level 0 ("Parent" with nodeId <parent>)
|
|
198
|
+
|
|
199
|
+
// Sibling at level 0
|
|
200
|
+
const r1 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parent>"}, position: "after", text: "Sibling"})
|
|
201
|
+
|
|
202
|
+
// Child at level 1 (insert after r1, then indent)
|
|
203
|
+
const r2 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r1.item.nodeId>"}, position: "after", text: "Child"})
|
|
204
|
+
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}})
|
|
205
|
+
|
|
206
|
+
// Grandchild at level 3 (insert after r2, then jump to level 3 directly)
|
|
207
|
+
const r3 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}, position: "after", text: "Deep"})
|
|
208
|
+
superdoc_list({action: "set_level", target: {kind: "block", nodeType: "listItem", nodeId: "<r3.item.nodeId>"}, level: 3})
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
`indent` bumps the level by one (bounded 0–8). `set_level` jumps directly to any level 0–8. Markers update automatically based on the list's definition for each level (e.g. `1.` / `a.` / `i.` for an ordered list).
|
|
212
|
+
|
|
213
|
+
### Merge two adjacent lists into one
|
|
214
|
+
|
|
215
|
+
Use `merge` — it handles the common case where two ordered or bulleted lists sit next to each other and should become one continuous list. Absorbed items adopt the absorbing sequence's definition, and any empty paragraphs between the two lists are removed so numbering flows continuously.
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
superdoc_get_content({action: "blocks"}) // find a listItem in either sequence
|
|
219
|
+
// To merge with the previous sequence:
|
|
220
|
+
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withPrevious"})
|
|
221
|
+
// Or with the next sequence:
|
|
222
|
+
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withNext"})
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Split a list into two
|
|
226
|
+
|
|
227
|
+
Use `split` to break one list into two independent lists at a specific item. The target and everything after become a new sequence that restarts numbering at 1:
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
superdoc_list({action: "split", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}})
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
Pass `restartNumbering: false` if you want the new half to keep counting from where the original left off.
|
|
234
|
+
|
|
235
|
+
### Restart numbering at a specific item
|
|
236
|
+
|
|
237
|
+
For ordered lists. To make item N restart from a chosen number (commonly 1):
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
superdoc_list({action: "set_value", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, value: 1})
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
Pass `value: null` to clear a previously-set restart override and let the item resume natural numbering.
|
|
244
|
+
|
|
245
|
+
### Continue numbering across a break
|
|
246
|
+
|
|
247
|
+
For ordered lists. When two sibling sequences should be numbered as one (e.g. numbering jumps back to 1 and you want it to continue from where the previous list left off), target the FIRST item of the second sequence:
|
|
248
|
+
|
|
249
|
+
```
|
|
250
|
+
superdoc_list({action: "continue_previous", target: {kind: "block", nodeType: "listItem", nodeId: "<firstItemOfSecondList>"}})
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Fails with `NO_COMPATIBLE_PREVIOUS` or `INCOMPATIBLE_DEFINITIONS` if no prior sequence shares the same abstract definition. In that case, use `merge` instead — it handles mismatched definitions, removes empty gap paragraphs, and produces one continuous list.
|
|
254
|
+
|
|
167
255
|
### Insert content into a document (new or existing)
|
|
168
256
|
|
|
169
257
|
Markdown insert creates block structure but uses default formatting. You MUST follow up with formatting so inserted content looks like it belongs in the document.
|
package/tools/tools-policy.json
CHANGED
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
},
|
|
62
62
|
{
|
|
63
63
|
"name": "superdoc_edit",
|
|
64
|
-
"description": "The primary tool for inserting content into documents. ALWAYS use action \"insert\" with type \"markdown\" to create headings, paragraphs, or any block content
|
|
64
|
+
"description": "The primary tool for inserting content into documents. ALWAYS use action \"insert\" with type \"markdown\" to create headings, paragraphs, or any block content: this is faster and creates proper document structure in one call. Do NOT use superdoc_create for headings or paragraphs. The markdown parser creates headings from # markers (# = Heading1, ## = Heading2), bold from **text**, italic from *text*, and numbered/bullet lists. Position markdown inserts with \"target\" (a BlockNodeAddress like {kind:\"block\", nodeType, nodeId}) and \"placement\" (before, after, insideStart, insideEnd). Without a target, content appends at the end of the document. IMPORTANT: After a markdown insert, analyze the document context (what kind of document, how titles and body text are styled) and follow up with ONE superdoc_mutations call to format inserted blocks so they look like they belong. Each format.apply step accepts \"inline\" (fontFamily, fontSize, bold, underline, color), \"alignment\", and \"scope\" in the same step. Use scope: \"block\" so formatting covers the entire paragraph. Copy the exact property values from the existing get_content blocks (fontFamily, fontSize, color, alignment, bold, underline). Do NOT invent values: use what the blocks show. Also supports replace, delete, and undo/redo. For replace and delete, pass a \"ref\" from superdoc_search or superdoc_get_content blocks. A search ref covers only the matched substring; a block ref covers the entire block text, so use block refs when rewriting or shortening whole paragraphs. For multi-step redlines or whole-clause rewrites, prefer superdoc_mutations with where:{by:\"block\", nodeType, nodeId} from superdoc_get_content action \"blocks\" includeText:true rather than relying on text selectors. Refs expire after any mutation; always re-search before the next edit. For 2+ edits that must succeed or fail atomically, use superdoc_mutations instead. Supports \"dryRun\" to preview changes and \"changeMode: tracked\" to record edits as tracked changes (not supported for markdown/html inserts). Do NOT build \"target\" objects manually when a ref is available; prefer \"ref\" for simpler, more reliable targeting.",
|
|
65
65
|
"input_schema": {
|
|
66
66
|
"type": "object",
|
|
67
67
|
"properties": {
|
|
@@ -906,7 +906,7 @@
|
|
|
906
906
|
},
|
|
907
907
|
{
|
|
908
908
|
"name": "superdoc_create",
|
|
909
|
-
"description": "IMPORTANT: For headings and paragraphs, use superdoc_edit with type \"markdown\" instead
|
|
909
|
+
"description": "IMPORTANT: For headings and paragraphs, use superdoc_edit with type \"markdown\" instead: it is faster, creates proper styles, and handles positioning via target + placement. Only use superdoc_create for tables or when markdown cannot express the content. Creates a single paragraph, heading, or table. Returns nodeId and ref for the created block. After creating, the returned ref is valid for ONE immediate superdoc_format call. For subsequent operations, re-fetch blocks with superdoc_get_content to get fresh refs (refs expire after any mutation). When the user asks for a \"heading\", use action \"heading\" with a level (default 1). Use action \"paragraph\" for regular body text. Position with \"at\": {kind:\"documentEnd\"} (default), {kind:\"documentStart\"}, or {kind:\"after\"/\"before\", target:{kind:\"block\", nodeType, nodeId}} for relative placement. When creating multiple items in sequence, use the previous response nodeId as the next \"at\" target to maintain correct ordering. Do NOT use newlines in \"text\" to create multiple paragraphs; call this tool separately for each one.",
|
|
910
910
|
"input_schema": {
|
|
911
911
|
"type": "object",
|
|
912
912
|
"properties": {
|
|
@@ -1052,7 +1052,7 @@
|
|
|
1052
1052
|
},
|
|
1053
1053
|
"text": {
|
|
1054
1054
|
"type": "string",
|
|
1055
|
-
"description": "Paragraph text content. Each call creates ONE paragraph. For multiple items (e.g. list items), call superdoc_create separately for each item
|
|
1055
|
+
"description": "Paragraph text content. Each call creates ONE paragraph. For multiple items (e.g. list items), call superdoc_create separately for each item: do NOT use newlines to put multiple items in one paragraph."
|
|
1056
1056
|
},
|
|
1057
1057
|
"input": {
|
|
1058
1058
|
"type": "object",
|
|
@@ -1079,22 +1079,27 @@
|
|
|
1079
1079
|
},
|
|
1080
1080
|
{
|
|
1081
1081
|
"name": "superdoc_list",
|
|
1082
|
-
"description": "Create and manipulate bullet and numbered lists.
|
|
1082
|
+
"description": "Create and manipulate bullet and numbered lists. Most actions require a list-item target: {kind:\"block\", nodeType:\"listItem\", nodeId:\"<id>\"}. Exceptions: \"create\" and \"attach\" operate on paragraph targets (they turn paragraphs into list items). Find nodeIds via superdoc_get_content({action:\"blocks\"}): pick listItem blocks for most actions, paragraph blocks for create/attach.\n\nCREATE & CONVERT:\n• \"create\": make a NEW list from paragraphs. Two modes: mode:\"empty\" with at:{kind:\"block\", nodeType:\"paragraph\", nodeId} converts a single paragraph; mode:\"fromParagraphs\" with target:{from:{...paragraph block address}, to:{...paragraph block address}} converts a range: ALL paragraphs between from and to become items, so make sure no other content sits between them. Pass a preset (\"disc\"|\"circle\"|\"square\"|\"dash\" for bullets; \"decimal\"|\"decimalParenthesis\"|\"lowerLetter\"|\"upperLetter\"|\"lowerRoman\"|\"upperRoman\" for ordered) or a custom style. Use \"create\" to start a fresh list: NOT to extend an existing one (use \"attach\" for that).\n• \"attach\": add paragraphs to an EXISTING list, inheriting its numbering definition. Pass target:{paragraph block address} (or {from, to} range of paragraphs) + attachTo:{kind:\"block\", nodeType:\"listItem\", nodeId:\"<any item in destination list>\"} + optional level:0..8. Use this to extend a list or as the second half of a merge workflow (see \"join\" below).\n• \"set_type\": convert an existing list between ordered and bullet. Pass target:{listItem} + kind:\"ordered\" or \"bullet\". Adjacent compatible sequences are merged automatically to preserve continuous numbering.\n• \"detach\": convert a list item back to a plain paragraph. Pass target:{listItem}.\n\nITEMS & NESTING:\n• \"insert\": add a new list item adjacent to an existing item in the same list. Pass target:{listItem} + position:\"before\"|\"after\" + optional text. Use this (NOT superdoc_create) to add items to an existing list.\n• \"indent\" / \"outdent\": bump the target item's nesting level by one (0-8 range). Pass target:{listItem}.\n• \"set_level\": jump the target item to an explicit level. Pass target:{listItem} + level:0..8.\n\nNUMBERING (ordered lists):\n• \"set_value\": restart numbering at the target. Pass target:{listItem} + value:<number> (e.g. value:1 to start over) or value:null to clear a previous override. Mid-sequence targets are atomically split off into their own sequence.\n• \"continue_previous\": make the target's sequence continue numbering from the nearest compatible previous sequence (same abstract definition). Pass target:{listItem of the sequence you want to renumber}. Fails with NO_COMPATIBLE_PREVIOUS or INCOMPATIBLE_DEFINITIONS if no matching prior sequence exists.\n\nSEQUENCE SHAPE (merge / split):\n• \"merge\": merge the target's sequence with an adjacent one into one continuous list. Pass target:{listItem} + direction:\"withPrevious\" or \"withNext\". Absorbed items adopt the absorbing sequence's numbering definition, and empty paragraphs between the two sequences are removed so numbering flows continuously.\n• \"split\": split the target's sequence at the target item into two independent lists. The target and everything after become a new sequence that restarts numbering at 1. Pass target:{listItem}; add restartNumbering:false to keep the count continuing instead of restarting.",
|
|
1083
1083
|
"input_schema": {
|
|
1084
1084
|
"type": "object",
|
|
1085
1085
|
"properties": {
|
|
1086
1086
|
"action": {
|
|
1087
1087
|
"type": "string",
|
|
1088
1088
|
"enum": [
|
|
1089
|
+
"attach",
|
|
1090
|
+
"continue_previous",
|
|
1089
1091
|
"create",
|
|
1090
1092
|
"detach",
|
|
1091
1093
|
"indent",
|
|
1092
1094
|
"insert",
|
|
1095
|
+
"merge",
|
|
1093
1096
|
"outdent",
|
|
1094
1097
|
"set_level",
|
|
1095
|
-
"set_type"
|
|
1098
|
+
"set_type",
|
|
1099
|
+
"set_value",
|
|
1100
|
+
"split"
|
|
1096
1101
|
],
|
|
1097
|
-
"description": "The action to perform. One of: create, detach, indent, insert, outdent, set_level, set_type."
|
|
1102
|
+
"description": "The action to perform. One of: attach, continue_previous, create, detach, indent, insert, merge, outdent, set_level, set_type, set_value, split."
|
|
1098
1103
|
},
|
|
1099
1104
|
"force": {
|
|
1100
1105
|
"type": "boolean",
|
|
@@ -1132,7 +1137,7 @@
|
|
|
1132
1137
|
"nodeType",
|
|
1133
1138
|
"nodeId"
|
|
1134
1139
|
],
|
|
1135
|
-
"description": "The target list item. For 'insert': the item to insert relative to. For 'create' with mode 'fromParagraphs': use nodeType 'paragraph' instead. Format: {kind:'block', nodeType:'listItem', nodeId:'<id>'}. Required for actions 'insert', 'detach', 'indent', 'outdent', 'set_level', 'set_type'."
|
|
1140
|
+
"description": "The target list item. For 'insert': the item to insert relative to. For 'create' with mode 'fromParagraphs': use nodeType 'paragraph' instead. Format: {kind:'block', nodeType:'listItem', nodeId:'<id>'}. Required for actions 'insert', 'attach', 'detach', 'indent', 'outdent', 'merge', 'split', 'set_level', 'set_value', 'continue_previous', 'set_type'."
|
|
1136
1141
|
},
|
|
1137
1142
|
"position": {
|
|
1138
1143
|
"type": "string",
|
|
@@ -1156,7 +1161,7 @@
|
|
|
1156
1161
|
},
|
|
1157
1162
|
"mode": {
|
|
1158
1163
|
"type": "string",
|
|
1159
|
-
"description": "Required. 'fromParagraphs' converts existing paragraphs into list items
|
|
1164
|
+
"description": "Required. 'fromParagraphs' converts existing paragraphs into list items: each paragraph becomes one item, so create one paragraph per item first. 'empty' creates a new empty list at 'at'. Required for action 'create'.",
|
|
1160
1165
|
"enum": [
|
|
1161
1166
|
"empty",
|
|
1162
1167
|
"fromParagraphs"
|
|
@@ -1316,6 +1321,44 @@
|
|
|
1316
1321
|
],
|
|
1317
1322
|
"description": "Only for action 'create'. Omit for other actions."
|
|
1318
1323
|
},
|
|
1324
|
+
"attachTo": {
|
|
1325
|
+
"type": "object",
|
|
1326
|
+
"properties": {
|
|
1327
|
+
"kind": {
|
|
1328
|
+
"const": "block",
|
|
1329
|
+
"type": "string"
|
|
1330
|
+
},
|
|
1331
|
+
"nodeType": {
|
|
1332
|
+
"const": "listItem",
|
|
1333
|
+
"type": "string"
|
|
1334
|
+
},
|
|
1335
|
+
"nodeId": {
|
|
1336
|
+
"type": "string"
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
"required": [
|
|
1340
|
+
"kind",
|
|
1341
|
+
"nodeType",
|
|
1342
|
+
"nodeId"
|
|
1343
|
+
],
|
|
1344
|
+
"description": "Required for action 'attach'."
|
|
1345
|
+
},
|
|
1346
|
+
"direction": {
|
|
1347
|
+
"type": "string",
|
|
1348
|
+
"enum": [
|
|
1349
|
+
"withPrevious",
|
|
1350
|
+
"withNext"
|
|
1351
|
+
],
|
|
1352
|
+
"description": "Required for action 'merge'."
|
|
1353
|
+
},
|
|
1354
|
+
"restartNumbering": {
|
|
1355
|
+
"type": "boolean",
|
|
1356
|
+
"description": "Only for action 'split'. Omit for other actions."
|
|
1357
|
+
},
|
|
1358
|
+
"value": {
|
|
1359
|
+
"type": "object",
|
|
1360
|
+
"description": "Required for action 'set_value'."
|
|
1361
|
+
},
|
|
1319
1362
|
"continuity": {
|
|
1320
1363
|
"type": "string",
|
|
1321
1364
|
"description": "Numbering continuity: 'preserve' keeps numbering; 'none' restarts. Only for action 'set_type'. Omit for other actions.",
|
|
@@ -1434,6 +1477,153 @@
|
|
|
1434
1477
|
"range"
|
|
1435
1478
|
]
|
|
1436
1479
|
}
|
|
1480
|
+
},
|
|
1481
|
+
"story": {
|
|
1482
|
+
"oneOf": [
|
|
1483
|
+
{
|
|
1484
|
+
"type": "object",
|
|
1485
|
+
"properties": {
|
|
1486
|
+
"kind": {
|
|
1487
|
+
"const": "story",
|
|
1488
|
+
"type": "string"
|
|
1489
|
+
},
|
|
1490
|
+
"storyType": {
|
|
1491
|
+
"const": "body",
|
|
1492
|
+
"type": "string"
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"required": [
|
|
1496
|
+
"kind",
|
|
1497
|
+
"storyType"
|
|
1498
|
+
]
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"type": "object",
|
|
1502
|
+
"properties": {
|
|
1503
|
+
"kind": {
|
|
1504
|
+
"const": "story",
|
|
1505
|
+
"type": "string"
|
|
1506
|
+
},
|
|
1507
|
+
"storyType": {
|
|
1508
|
+
"const": "headerFooterSlot",
|
|
1509
|
+
"type": "string"
|
|
1510
|
+
},
|
|
1511
|
+
"section": {
|
|
1512
|
+
"type": "object",
|
|
1513
|
+
"properties": {
|
|
1514
|
+
"kind": {
|
|
1515
|
+
"const": "section",
|
|
1516
|
+
"type": "string"
|
|
1517
|
+
},
|
|
1518
|
+
"sectionId": {
|
|
1519
|
+
"type": "string"
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1522
|
+
"required": [
|
|
1523
|
+
"kind",
|
|
1524
|
+
"sectionId"
|
|
1525
|
+
]
|
|
1526
|
+
},
|
|
1527
|
+
"headerFooterKind": {
|
|
1528
|
+
"enum": [
|
|
1529
|
+
"header",
|
|
1530
|
+
"footer"
|
|
1531
|
+
]
|
|
1532
|
+
},
|
|
1533
|
+
"variant": {
|
|
1534
|
+
"enum": [
|
|
1535
|
+
"default",
|
|
1536
|
+
"first",
|
|
1537
|
+
"even"
|
|
1538
|
+
]
|
|
1539
|
+
},
|
|
1540
|
+
"resolution": {
|
|
1541
|
+
"enum": [
|
|
1542
|
+
"effective",
|
|
1543
|
+
"explicit"
|
|
1544
|
+
]
|
|
1545
|
+
},
|
|
1546
|
+
"onWrite": {
|
|
1547
|
+
"enum": [
|
|
1548
|
+
"materializeIfInherited",
|
|
1549
|
+
"editResolvedPart",
|
|
1550
|
+
"error"
|
|
1551
|
+
]
|
|
1552
|
+
}
|
|
1553
|
+
},
|
|
1554
|
+
"required": [
|
|
1555
|
+
"kind",
|
|
1556
|
+
"storyType",
|
|
1557
|
+
"section",
|
|
1558
|
+
"headerFooterKind",
|
|
1559
|
+
"variant"
|
|
1560
|
+
]
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"type": "object",
|
|
1564
|
+
"properties": {
|
|
1565
|
+
"kind": {
|
|
1566
|
+
"const": "story",
|
|
1567
|
+
"type": "string"
|
|
1568
|
+
},
|
|
1569
|
+
"storyType": {
|
|
1570
|
+
"const": "headerFooterPart",
|
|
1571
|
+
"type": "string"
|
|
1572
|
+
},
|
|
1573
|
+
"refId": {
|
|
1574
|
+
"type": "string"
|
|
1575
|
+
}
|
|
1576
|
+
},
|
|
1577
|
+
"required": [
|
|
1578
|
+
"kind",
|
|
1579
|
+
"storyType",
|
|
1580
|
+
"refId"
|
|
1581
|
+
]
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"type": "object",
|
|
1585
|
+
"properties": {
|
|
1586
|
+
"kind": {
|
|
1587
|
+
"const": "story",
|
|
1588
|
+
"type": "string"
|
|
1589
|
+
},
|
|
1590
|
+
"storyType": {
|
|
1591
|
+
"const": "footnote",
|
|
1592
|
+
"type": "string"
|
|
1593
|
+
},
|
|
1594
|
+
"noteId": {
|
|
1595
|
+
"type": "string"
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
"required": [
|
|
1599
|
+
"kind",
|
|
1600
|
+
"storyType",
|
|
1601
|
+
"noteId"
|
|
1602
|
+
]
|
|
1603
|
+
},
|
|
1604
|
+
{
|
|
1605
|
+
"type": "object",
|
|
1606
|
+
"properties": {
|
|
1607
|
+
"kind": {
|
|
1608
|
+
"const": "story",
|
|
1609
|
+
"type": "string"
|
|
1610
|
+
},
|
|
1611
|
+
"storyType": {
|
|
1612
|
+
"const": "endnote",
|
|
1613
|
+
"type": "string"
|
|
1614
|
+
},
|
|
1615
|
+
"noteId": {
|
|
1616
|
+
"type": "string"
|
|
1617
|
+
}
|
|
1618
|
+
},
|
|
1619
|
+
"required": [
|
|
1620
|
+
"kind",
|
|
1621
|
+
"storyType",
|
|
1622
|
+
"noteId"
|
|
1623
|
+
]
|
|
1624
|
+
}
|
|
1625
|
+
],
|
|
1626
|
+
"description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
|
|
1437
1627
|
}
|
|
1438
1628
|
},
|
|
1439
1629
|
"required": [
|
|
@@ -1454,9 +1644,10 @@
|
|
|
1454
1644
|
},
|
|
1455
1645
|
"status": {
|
|
1456
1646
|
"type": "string",
|
|
1457
|
-
"description": "Set comment status. Use 'resolved' to
|
|
1647
|
+
"description": "Set comment status. Use 'resolved' to resolve a comment, or 'active' to reopen a previously resolved comment (lifecycle inverse). Only for action 'update'. Omit for other actions.",
|
|
1458
1648
|
"enum": [
|
|
1459
|
-
"resolved"
|
|
1649
|
+
"resolved",
|
|
1650
|
+
"active"
|
|
1460
1651
|
]
|
|
1461
1652
|
},
|
|
1462
1653
|
"isInternal": {
|