@superdoc-dev/sdk 1.6.0-next.5 → 1.6.0-next.50
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.d.ts +5743 -16
- package/dist/generated/client.d.ts.map +1 -1
- package/dist/generated/contract.cjs +2577 -486
- package/dist/generated/contract.d.ts.map +1 -1
- package/dist/generated/contract.js +2580 -486
- package/dist/index.cjs +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/tools.cjs +53 -5
- package/dist/tools.d.ts +12 -1
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +52 -5
- 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 +584 -79
- package/tools/prompt-templates/system-prompt-core.md +276 -0
- package/tools/prompt-templates/system-prompt-mcp-header.md +50 -0
- package/tools/prompt-templates/system-prompt-sdk-header.md +5 -0
- package/tools/system-prompt-mcp.md +325 -0
- package/tools/system-prompt.md +101 -15
- package/tools/tools-policy.json +1 -1
- package/tools/tools.anthropic.json +584 -79
- package/tools/tools.generic.json +584 -79
- package/tools/tools.openai.json +584 -79
- package/tools/tools.vercel.json +584 -79
package/tools/catalog.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"tools": [
|
|
6
6
|
{
|
|
7
7
|
"toolName": "superdoc_get_content",
|
|
8
|
-
"description": "Read document content in various formats. Call this first in any workflow to understand document structure before making edits. Action \"blocks\" returns structured block data with nodeId, nodeType, textPreview, formatting properties (fontFamily, fontSize, color, bold, underline, alignment), and ref handles for immediate use with superdoc_edit or superdoc_format. Action \"text\" and \"markdown\" return the full document as plain text or Markdown. Action \"html\" returns HTML. Action \"info\" returns document metadata: word count, paragraph count, page count, outline, available styles, and capability flags. The \"blocks\" action supports pagination via \"offset\" and \"limit\", and filtering via \"nodeTypes\". Other actions ignore these parameters. This tool never modifies the document. Do NOT call superdoc_edit or superdoc_format without first reading blocks to get valid refs and formatting reference values.",
|
|
8
|
+
"description": "Read document content in various formats. Call this first in any workflow to understand document structure before making edits. Action \"blocks\" returns structured block data with nodeId, nodeType, textPreview, optional full text when includeText:true, formatting properties (fontFamily, fontSize, color, bold, underline, alignment), and ref handles for immediate use with superdoc_edit or superdoc_format. When you need to evaluate or rewrite existing paragraphs or clauses, prefer action \"blocks\" with includeText:true so you can identify the correct block and then target it by nodeId. Action \"text\" and \"markdown\" return the full document as plain text or Markdown. Action \"html\" returns HTML. Action \"info\" returns document metadata: word count, paragraph count, page count, outline, available styles, and capability flags. The \"blocks\" action supports pagination via \"offset\" and \"limit\", and filtering via \"nodeTypes\". Other actions ignore these parameters. This tool never modifies the document. Do NOT call superdoc_edit or superdoc_format without first reading blocks to get valid refs and formatting reference values.",
|
|
9
9
|
"inputSchema": {
|
|
10
10
|
"type": "object",
|
|
11
11
|
"properties": {
|
|
@@ -49,6 +49,10 @@
|
|
|
49
49
|
]
|
|
50
50
|
},
|
|
51
51
|
"description": "Filter by block types (e.g. ['paragraph', 'heading']). Omit for all types. Only for action 'blocks'. Omit for other actions."
|
|
52
|
+
},
|
|
53
|
+
"includeText": {
|
|
54
|
+
"type": "boolean",
|
|
55
|
+
"description": "When true, includes the full flattened block text in each block entry. Only for action 'blocks'. Omit for other actions."
|
|
52
56
|
}
|
|
53
57
|
},
|
|
54
58
|
"required": [
|
|
@@ -86,7 +90,7 @@
|
|
|
86
90
|
},
|
|
87
91
|
{
|
|
88
92
|
"toolName": "superdoc_edit",
|
|
89
|
-
"description": "
|
|
93
|
+
"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.",
|
|
90
94
|
"inputSchema": {
|
|
91
95
|
"type": "object",
|
|
92
96
|
"properties": {
|
|
@@ -451,7 +455,7 @@
|
|
|
451
455
|
},
|
|
452
456
|
{
|
|
453
457
|
"toolName": "superdoc_format",
|
|
454
|
-
"description": "Change text and paragraph formatting.
|
|
458
|
+
"description": "Change text and paragraph formatting. To format multiple items at once, use superdoc_mutations with format.apply steps instead of calling this tool repeatedly. Use require \"all\" with a node selector to format every heading or paragraph in one batch. Use this tool for single-item formatting when you have a valid ref or nodeId. Action \"inline\" applies character formatting (bold, italic, underline, color, fontSize, fontFamily, highlight, strike, vertAlign) to a text range via \"ref\". Action \"set_style\" applies a named paragraph style by styleId (get available styles from superdoc_get_content info). Actions \"set_alignment\", \"set_indentation\", \"set_spacing\", \"set_direction\", and \"set_flow_options\" change paragraph-level properties and require a block target: {kind:\"block\", nodeType:\"paragraph\", nodeId:\"<nodeId>\"}, NOT a ref. Use \"set_flow_options\" with pageBreakBefore:true to start a paragraph on a new page. Supports \"dryRun\" and \"changeMode: tracked\" for inline formatting. Paragraph-level actions do NOT support tracked changes. Do NOT use a search ref for paragraph-level actions; they require a block target with nodeId. Do NOT use {kind:\"block\", start:{kind:\"nodeEdge\",...}} or selection-like structures for paragraph actions. ONLY {kind:\"block\", nodeType, nodeId} is accepted. Do NOT issue multiple superdoc_format calls in parallel; each call invalidates refs for subsequent calls.",
|
|
455
459
|
"inputSchema": {
|
|
456
460
|
"type": "object",
|
|
457
461
|
"properties": {
|
|
@@ -1069,7 +1073,7 @@
|
|
|
1069
1073
|
},
|
|
1070
1074
|
{
|
|
1071
1075
|
"toolName": "superdoc_create",
|
|
1072
|
-
"description": "
|
|
1076
|
+
"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.",
|
|
1073
1077
|
"inputSchema": {
|
|
1074
1078
|
"type": "object",
|
|
1075
1079
|
"properties": {
|
|
@@ -1765,6 +1769,153 @@
|
|
|
1765
1769
|
"properties": {
|
|
1766
1770
|
"id": {
|
|
1767
1771
|
"type": "string"
|
|
1772
|
+
},
|
|
1773
|
+
"story": {
|
|
1774
|
+
"oneOf": [
|
|
1775
|
+
{
|
|
1776
|
+
"type": "object",
|
|
1777
|
+
"properties": {
|
|
1778
|
+
"kind": {
|
|
1779
|
+
"const": "story",
|
|
1780
|
+
"type": "string"
|
|
1781
|
+
},
|
|
1782
|
+
"storyType": {
|
|
1783
|
+
"const": "body",
|
|
1784
|
+
"type": "string"
|
|
1785
|
+
}
|
|
1786
|
+
},
|
|
1787
|
+
"required": [
|
|
1788
|
+
"kind",
|
|
1789
|
+
"storyType"
|
|
1790
|
+
]
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
"type": "object",
|
|
1794
|
+
"properties": {
|
|
1795
|
+
"kind": {
|
|
1796
|
+
"const": "story",
|
|
1797
|
+
"type": "string"
|
|
1798
|
+
},
|
|
1799
|
+
"storyType": {
|
|
1800
|
+
"const": "headerFooterSlot",
|
|
1801
|
+
"type": "string"
|
|
1802
|
+
},
|
|
1803
|
+
"section": {
|
|
1804
|
+
"type": "object",
|
|
1805
|
+
"properties": {
|
|
1806
|
+
"kind": {
|
|
1807
|
+
"const": "section",
|
|
1808
|
+
"type": "string"
|
|
1809
|
+
},
|
|
1810
|
+
"sectionId": {
|
|
1811
|
+
"type": "string"
|
|
1812
|
+
}
|
|
1813
|
+
},
|
|
1814
|
+
"required": [
|
|
1815
|
+
"kind",
|
|
1816
|
+
"sectionId"
|
|
1817
|
+
]
|
|
1818
|
+
},
|
|
1819
|
+
"headerFooterKind": {
|
|
1820
|
+
"enum": [
|
|
1821
|
+
"header",
|
|
1822
|
+
"footer"
|
|
1823
|
+
]
|
|
1824
|
+
},
|
|
1825
|
+
"variant": {
|
|
1826
|
+
"enum": [
|
|
1827
|
+
"default",
|
|
1828
|
+
"first",
|
|
1829
|
+
"even"
|
|
1830
|
+
]
|
|
1831
|
+
},
|
|
1832
|
+
"resolution": {
|
|
1833
|
+
"enum": [
|
|
1834
|
+
"effective",
|
|
1835
|
+
"explicit"
|
|
1836
|
+
]
|
|
1837
|
+
},
|
|
1838
|
+
"onWrite": {
|
|
1839
|
+
"enum": [
|
|
1840
|
+
"materializeIfInherited",
|
|
1841
|
+
"editResolvedPart",
|
|
1842
|
+
"error"
|
|
1843
|
+
]
|
|
1844
|
+
}
|
|
1845
|
+
},
|
|
1846
|
+
"required": [
|
|
1847
|
+
"kind",
|
|
1848
|
+
"storyType",
|
|
1849
|
+
"section",
|
|
1850
|
+
"headerFooterKind",
|
|
1851
|
+
"variant"
|
|
1852
|
+
]
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"type": "object",
|
|
1856
|
+
"properties": {
|
|
1857
|
+
"kind": {
|
|
1858
|
+
"const": "story",
|
|
1859
|
+
"type": "string"
|
|
1860
|
+
},
|
|
1861
|
+
"storyType": {
|
|
1862
|
+
"const": "headerFooterPart",
|
|
1863
|
+
"type": "string"
|
|
1864
|
+
},
|
|
1865
|
+
"refId": {
|
|
1866
|
+
"type": "string"
|
|
1867
|
+
}
|
|
1868
|
+
},
|
|
1869
|
+
"required": [
|
|
1870
|
+
"kind",
|
|
1871
|
+
"storyType",
|
|
1872
|
+
"refId"
|
|
1873
|
+
]
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"type": "object",
|
|
1877
|
+
"properties": {
|
|
1878
|
+
"kind": {
|
|
1879
|
+
"const": "story",
|
|
1880
|
+
"type": "string"
|
|
1881
|
+
},
|
|
1882
|
+
"storyType": {
|
|
1883
|
+
"const": "footnote",
|
|
1884
|
+
"type": "string"
|
|
1885
|
+
},
|
|
1886
|
+
"noteId": {
|
|
1887
|
+
"type": "string"
|
|
1888
|
+
}
|
|
1889
|
+
},
|
|
1890
|
+
"required": [
|
|
1891
|
+
"kind",
|
|
1892
|
+
"storyType",
|
|
1893
|
+
"noteId"
|
|
1894
|
+
]
|
|
1895
|
+
},
|
|
1896
|
+
{
|
|
1897
|
+
"type": "object",
|
|
1898
|
+
"properties": {
|
|
1899
|
+
"kind": {
|
|
1900
|
+
"const": "story",
|
|
1901
|
+
"type": "string"
|
|
1902
|
+
},
|
|
1903
|
+
"storyType": {
|
|
1904
|
+
"const": "endnote",
|
|
1905
|
+
"type": "string"
|
|
1906
|
+
},
|
|
1907
|
+
"noteId": {
|
|
1908
|
+
"type": "string"
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
"required": [
|
|
1912
|
+
"kind",
|
|
1913
|
+
"storyType",
|
|
1914
|
+
"noteId"
|
|
1915
|
+
]
|
|
1916
|
+
}
|
|
1917
|
+
],
|
|
1918
|
+
"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."
|
|
1768
1919
|
}
|
|
1769
1920
|
},
|
|
1770
1921
|
"required": [
|
|
@@ -1811,7 +1962,7 @@
|
|
|
1811
1962
|
},
|
|
1812
1963
|
{
|
|
1813
1964
|
"toolName": "superdoc_search",
|
|
1814
|
-
"description": "
|
|
1965
|
+
"description": "Find text patterns or nodes in the document and get ref handles for targeting edits and formatting. Refs expire after any mutation that changes the document. Re-search before the next edit when using individual tools (superdoc_edit, superdoc_format). Within a superdoc_mutations batch, selectors in \"where\" clauses resolve automatically at compile time; no manual re-searching needed between steps. Text search returns handle.ref covering only the matched substring. Node search finds blocks by type (paragraph, heading, table, listItem, etc.). The \"require\" parameter controls match cardinality: \"first\" returns one match, \"all\" returns every match, \"exactlyOne\" fails if not exactly one match. Supports scoping via \"within\" to search inside a single block. Do NOT use regex or markdown formatting markers (#, **, etc.) in search patterns; patterns are plain text only. Do NOT use this tool when you already have a ref from superdoc_get_content blocks or superdoc_create; use that ref directly.",
|
|
1815
1966
|
"inputSchema": {
|
|
1816
1967
|
"type": "object",
|
|
1817
1968
|
"properties": {
|
|
@@ -1976,7 +2127,7 @@
|
|
|
1976
2127
|
},
|
|
1977
2128
|
{
|
|
1978
2129
|
"toolName": "superdoc_mutations",
|
|
1979
|
-
"description": "All steps succeed or all fail; no partial application. Execute multiple
|
|
2130
|
+
"description": "All steps succeed or all fail; no partial application. Execute multiple operations atomically in one batch. Use this for any workflow needing 2+ changes. Supported step types: text (text.rewrite, text.insert, text.delete), format (format.apply), create (create.heading, create.paragraph, create.table), assert. Each step has an id, an op, a \"where\" clause for targeting ({by:\"select\", select:{...}, require:\"first\"|\"exactlyOne\"|\"all\"} or {by:\"ref\", ref:\"...\"} or {by:\"block\", nodeType:\"paragraph\", nodeId:\"...\"}), and \"args\" with operation-specific parameters. Use {by:\"block\", nodeType, nodeId} when you want to rewrite, delete, format, or anchor against a whole known block from superdoc_get_content action \"blocks\" without relying on text matching. For full-paragraph or full-clause rewrites, first call superdoc_get_content with action:\"blocks\" and includeText:true, then rewrite the matching block by nodeId. Use {by:\"select\"} only for substring edits, discovery, or insertion relative to a sentence fragment; do NOT use a shortened text selector to replace an entire known block. For create steps, \"where\" targets an existing anchor block and args.position (\"before\" or \"after\") controls placement. Sequential creates targeting the same anchor maintain correct order via internal position mapping. For format.apply with require \"all\", use a node selector to format every heading or paragraph at once: {by:\"select\", select:{type:\"node\", nodeType:\"heading\"}, require:\"all\"}. Selectors resolve at compile time (before execution). This means format.apply steps CANNOT target content created by earlier create steps in the same batch. Split creates and formatting into separate batches: first a mutations call with creates, then a mutations call with format.apply. Action \"preview\" dry-runs the plan. Action \"apply\" executes it. If a selector matches nothing, the failure reports the step id plus selector details so you can retry with a shorter or more distinctive anchor. Do NOT create two steps that target overlapping text in the same block; combine them into a single text.rewrite step.",
|
|
1980
2131
|
"inputSchema": {
|
|
1981
2132
|
"type": "object",
|
|
1982
2133
|
"properties": {
|
|
@@ -2367,6 +2518,36 @@
|
|
|
2367
2518
|
"by",
|
|
2368
2519
|
"target"
|
|
2369
2520
|
]
|
|
2521
|
+
},
|
|
2522
|
+
{
|
|
2523
|
+
"type": "object",
|
|
2524
|
+
"properties": {
|
|
2525
|
+
"by": {
|
|
2526
|
+
"const": "block",
|
|
2527
|
+
"type": "string"
|
|
2528
|
+
},
|
|
2529
|
+
"nodeType": {
|
|
2530
|
+
"enum": [
|
|
2531
|
+
"paragraph",
|
|
2532
|
+
"heading",
|
|
2533
|
+
"listItem",
|
|
2534
|
+
"table",
|
|
2535
|
+
"tableRow",
|
|
2536
|
+
"tableCell",
|
|
2537
|
+
"tableOfContents",
|
|
2538
|
+
"image",
|
|
2539
|
+
"sdt"
|
|
2540
|
+
]
|
|
2541
|
+
},
|
|
2542
|
+
"nodeId": {
|
|
2543
|
+
"type": "string"
|
|
2544
|
+
}
|
|
2545
|
+
},
|
|
2546
|
+
"required": [
|
|
2547
|
+
"by",
|
|
2548
|
+
"nodeType",
|
|
2549
|
+
"nodeId"
|
|
2550
|
+
]
|
|
2370
2551
|
}
|
|
2371
2552
|
]
|
|
2372
2553
|
},
|
|
@@ -2517,53 +2698,102 @@
|
|
|
2517
2698
|
"type": "string"
|
|
2518
2699
|
},
|
|
2519
2700
|
"where": {
|
|
2520
|
-
"
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
"
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
{
|
|
2529
|
-
"
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
"
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2701
|
+
"oneOf": [
|
|
2702
|
+
{
|
|
2703
|
+
"type": "object",
|
|
2704
|
+
"properties": {
|
|
2705
|
+
"by": {
|
|
2706
|
+
"const": "select",
|
|
2707
|
+
"type": "string"
|
|
2708
|
+
},
|
|
2709
|
+
"select": {
|
|
2710
|
+
"oneOf": [
|
|
2711
|
+
{
|
|
2712
|
+
"type": "object",
|
|
2713
|
+
"properties": {
|
|
2714
|
+
"type": {
|
|
2715
|
+
"const": "text",
|
|
2716
|
+
"description": "Must be 'text' for text pattern search.",
|
|
2717
|
+
"type": "string"
|
|
2718
|
+
},
|
|
2719
|
+
"pattern": {
|
|
2720
|
+
"type": "string",
|
|
2721
|
+
"description": "Text or regex pattern to match."
|
|
2722
|
+
},
|
|
2723
|
+
"mode": {
|
|
2724
|
+
"description": "Match mode: 'contains' (substring) or 'regex'.",
|
|
2725
|
+
"enum": [
|
|
2726
|
+
"contains",
|
|
2727
|
+
"regex"
|
|
2728
|
+
]
|
|
2729
|
+
},
|
|
2730
|
+
"caseSensitive": {
|
|
2731
|
+
"type": "boolean",
|
|
2732
|
+
"description": "Case-sensitive matching. Default: false."
|
|
2733
|
+
}
|
|
2734
|
+
},
|
|
2735
|
+
"required": [
|
|
2736
|
+
"type",
|
|
2737
|
+
"pattern"
|
|
2545
2738
|
]
|
|
2546
2739
|
},
|
|
2547
|
-
|
|
2548
|
-
"type": "
|
|
2549
|
-
"
|
|
2740
|
+
{
|
|
2741
|
+
"type": "object",
|
|
2742
|
+
"properties": {
|
|
2743
|
+
"type": {
|
|
2744
|
+
"const": "node",
|
|
2745
|
+
"description": "Must be 'node' for node type search.",
|
|
2746
|
+
"type": "string"
|
|
2747
|
+
},
|
|
2748
|
+
"nodeType": {
|
|
2749
|
+
"description": "Block type to match (paragraph, heading, table, listItem, etc.).",
|
|
2750
|
+
"enum": [
|
|
2751
|
+
"paragraph",
|
|
2752
|
+
"heading",
|
|
2753
|
+
"listItem",
|
|
2754
|
+
"table",
|
|
2755
|
+
"tableRow",
|
|
2756
|
+
"tableCell",
|
|
2757
|
+
"tableOfContents",
|
|
2758
|
+
"image",
|
|
2759
|
+
"sdt",
|
|
2760
|
+
"run",
|
|
2761
|
+
"bookmark",
|
|
2762
|
+
"comment",
|
|
2763
|
+
"hyperlink",
|
|
2764
|
+
"footnoteRef",
|
|
2765
|
+
"endnoteRef",
|
|
2766
|
+
"crossRef",
|
|
2767
|
+
"indexEntry",
|
|
2768
|
+
"citation",
|
|
2769
|
+
"authorityEntry",
|
|
2770
|
+
"sequenceField",
|
|
2771
|
+
"tab",
|
|
2772
|
+
"lineBreak"
|
|
2773
|
+
]
|
|
2774
|
+
},
|
|
2775
|
+
"kind": {
|
|
2776
|
+
"description": "Filter: 'block' or 'inline'.",
|
|
2777
|
+
"enum": [
|
|
2778
|
+
"block",
|
|
2779
|
+
"inline"
|
|
2780
|
+
]
|
|
2781
|
+
}
|
|
2782
|
+
},
|
|
2783
|
+
"required": [
|
|
2784
|
+
"type"
|
|
2785
|
+
]
|
|
2550
2786
|
}
|
|
2551
|
-
},
|
|
2552
|
-
"required": [
|
|
2553
|
-
"type",
|
|
2554
|
-
"pattern"
|
|
2555
2787
|
]
|
|
2556
2788
|
},
|
|
2557
|
-
{
|
|
2789
|
+
"within": {
|
|
2558
2790
|
"type": "object",
|
|
2559
2791
|
"properties": {
|
|
2560
|
-
"
|
|
2561
|
-
"const": "
|
|
2562
|
-
"description": "Must be 'node' for node type search.",
|
|
2792
|
+
"kind": {
|
|
2793
|
+
"const": "block",
|
|
2563
2794
|
"type": "string"
|
|
2564
2795
|
},
|
|
2565
2796
|
"nodeType": {
|
|
2566
|
-
"description": "Block type to match (paragraph, heading, table, listItem, etc.).",
|
|
2567
2797
|
"enum": [
|
|
2568
2798
|
"paragraph",
|
|
2569
2799
|
"heading",
|
|
@@ -2573,40 +2803,253 @@
|
|
|
2573
2803
|
"tableCell",
|
|
2574
2804
|
"tableOfContents",
|
|
2575
2805
|
"image",
|
|
2576
|
-
"sdt"
|
|
2577
|
-
"run",
|
|
2578
|
-
"bookmark",
|
|
2579
|
-
"comment",
|
|
2580
|
-
"hyperlink",
|
|
2581
|
-
"footnoteRef",
|
|
2582
|
-
"endnoteRef",
|
|
2583
|
-
"crossRef",
|
|
2584
|
-
"indexEntry",
|
|
2585
|
-
"citation",
|
|
2586
|
-
"authorityEntry",
|
|
2587
|
-
"sequenceField",
|
|
2588
|
-
"tab",
|
|
2589
|
-
"lineBreak"
|
|
2806
|
+
"sdt"
|
|
2590
2807
|
]
|
|
2591
2808
|
},
|
|
2809
|
+
"nodeId": {
|
|
2810
|
+
"type": "string"
|
|
2811
|
+
}
|
|
2812
|
+
},
|
|
2813
|
+
"required": [
|
|
2814
|
+
"kind",
|
|
2815
|
+
"nodeType",
|
|
2816
|
+
"nodeId"
|
|
2817
|
+
]
|
|
2818
|
+
},
|
|
2819
|
+
"require": {
|
|
2820
|
+
"enum": [
|
|
2821
|
+
"first",
|
|
2822
|
+
"exactlyOne"
|
|
2823
|
+
]
|
|
2824
|
+
}
|
|
2825
|
+
},
|
|
2826
|
+
"required": [
|
|
2827
|
+
"by",
|
|
2828
|
+
"select",
|
|
2829
|
+
"require"
|
|
2830
|
+
]
|
|
2831
|
+
},
|
|
2832
|
+
{
|
|
2833
|
+
"type": "object",
|
|
2834
|
+
"properties": {
|
|
2835
|
+
"by": {
|
|
2836
|
+
"const": "ref",
|
|
2837
|
+
"type": "string"
|
|
2838
|
+
},
|
|
2839
|
+
"ref": {
|
|
2840
|
+
"type": "string"
|
|
2841
|
+
},
|
|
2842
|
+
"within": {
|
|
2843
|
+
"type": "object",
|
|
2844
|
+
"properties": {
|
|
2592
2845
|
"kind": {
|
|
2593
|
-
"
|
|
2846
|
+
"const": "block",
|
|
2847
|
+
"type": "string"
|
|
2848
|
+
},
|
|
2849
|
+
"nodeType": {
|
|
2594
2850
|
"enum": [
|
|
2595
|
-
"
|
|
2596
|
-
"
|
|
2851
|
+
"paragraph",
|
|
2852
|
+
"heading",
|
|
2853
|
+
"listItem",
|
|
2854
|
+
"table",
|
|
2855
|
+
"tableRow",
|
|
2856
|
+
"tableCell",
|
|
2857
|
+
"tableOfContents",
|
|
2858
|
+
"image",
|
|
2859
|
+
"sdt"
|
|
2597
2860
|
]
|
|
2861
|
+
},
|
|
2862
|
+
"nodeId": {
|
|
2863
|
+
"type": "string"
|
|
2598
2864
|
}
|
|
2599
2865
|
},
|
|
2600
2866
|
"required": [
|
|
2601
|
-
"
|
|
2867
|
+
"kind",
|
|
2868
|
+
"nodeType",
|
|
2869
|
+
"nodeId"
|
|
2602
2870
|
]
|
|
2603
2871
|
}
|
|
2872
|
+
},
|
|
2873
|
+
"required": [
|
|
2874
|
+
"by",
|
|
2875
|
+
"ref"
|
|
2604
2876
|
]
|
|
2605
2877
|
},
|
|
2606
|
-
|
|
2878
|
+
{
|
|
2607
2879
|
"type": "object",
|
|
2608
2880
|
"properties": {
|
|
2609
|
-
"
|
|
2881
|
+
"by": {
|
|
2882
|
+
"const": "target",
|
|
2883
|
+
"type": "string"
|
|
2884
|
+
},
|
|
2885
|
+
"target": {
|
|
2886
|
+
"type": "object",
|
|
2887
|
+
"properties": {
|
|
2888
|
+
"kind": {
|
|
2889
|
+
"const": "selection",
|
|
2890
|
+
"type": "string"
|
|
2891
|
+
},
|
|
2892
|
+
"start": {
|
|
2893
|
+
"oneOf": [
|
|
2894
|
+
{
|
|
2895
|
+
"type": "object",
|
|
2896
|
+
"properties": {
|
|
2897
|
+
"kind": {
|
|
2898
|
+
"const": "text",
|
|
2899
|
+
"type": "string"
|
|
2900
|
+
},
|
|
2901
|
+
"blockId": {
|
|
2902
|
+
"type": "string"
|
|
2903
|
+
},
|
|
2904
|
+
"offset": {
|
|
2905
|
+
"type": "number"
|
|
2906
|
+
}
|
|
2907
|
+
},
|
|
2908
|
+
"required": [
|
|
2909
|
+
"kind",
|
|
2910
|
+
"blockId",
|
|
2911
|
+
"offset"
|
|
2912
|
+
]
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"type": "object",
|
|
2916
|
+
"properties": {
|
|
2917
|
+
"kind": {
|
|
2918
|
+
"const": "nodeEdge",
|
|
2919
|
+
"type": "string"
|
|
2920
|
+
},
|
|
2921
|
+
"node": {
|
|
2922
|
+
"type": "object",
|
|
2923
|
+
"properties": {
|
|
2924
|
+
"kind": {
|
|
2925
|
+
"const": "block",
|
|
2926
|
+
"type": "string"
|
|
2927
|
+
},
|
|
2928
|
+
"nodeType": {
|
|
2929
|
+
"enum": [
|
|
2930
|
+
"paragraph",
|
|
2931
|
+
"heading",
|
|
2932
|
+
"table",
|
|
2933
|
+
"tableOfContents",
|
|
2934
|
+
"sdt",
|
|
2935
|
+
"image"
|
|
2936
|
+
]
|
|
2937
|
+
},
|
|
2938
|
+
"nodeId": {
|
|
2939
|
+
"type": "string"
|
|
2940
|
+
}
|
|
2941
|
+
},
|
|
2942
|
+
"required": [
|
|
2943
|
+
"kind",
|
|
2944
|
+
"nodeType",
|
|
2945
|
+
"nodeId"
|
|
2946
|
+
]
|
|
2947
|
+
},
|
|
2948
|
+
"edge": {
|
|
2949
|
+
"enum": [
|
|
2950
|
+
"before",
|
|
2951
|
+
"after"
|
|
2952
|
+
]
|
|
2953
|
+
}
|
|
2954
|
+
},
|
|
2955
|
+
"required": [
|
|
2956
|
+
"kind",
|
|
2957
|
+
"node",
|
|
2958
|
+
"edge"
|
|
2959
|
+
]
|
|
2960
|
+
}
|
|
2961
|
+
],
|
|
2962
|
+
"description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries."
|
|
2963
|
+
},
|
|
2964
|
+
"end": {
|
|
2965
|
+
"oneOf": [
|
|
2966
|
+
{
|
|
2967
|
+
"type": "object",
|
|
2968
|
+
"properties": {
|
|
2969
|
+
"kind": {
|
|
2970
|
+
"const": "text",
|
|
2971
|
+
"type": "string"
|
|
2972
|
+
},
|
|
2973
|
+
"blockId": {
|
|
2974
|
+
"type": "string"
|
|
2975
|
+
},
|
|
2976
|
+
"offset": {
|
|
2977
|
+
"type": "number"
|
|
2978
|
+
}
|
|
2979
|
+
},
|
|
2980
|
+
"required": [
|
|
2981
|
+
"kind",
|
|
2982
|
+
"blockId",
|
|
2983
|
+
"offset"
|
|
2984
|
+
]
|
|
2985
|
+
},
|
|
2986
|
+
{
|
|
2987
|
+
"type": "object",
|
|
2988
|
+
"properties": {
|
|
2989
|
+
"kind": {
|
|
2990
|
+
"const": "nodeEdge",
|
|
2991
|
+
"type": "string"
|
|
2992
|
+
},
|
|
2993
|
+
"node": {
|
|
2994
|
+
"type": "object",
|
|
2995
|
+
"properties": {
|
|
2996
|
+
"kind": {
|
|
2997
|
+
"const": "block",
|
|
2998
|
+
"type": "string"
|
|
2999
|
+
},
|
|
3000
|
+
"nodeType": {
|
|
3001
|
+
"enum": [
|
|
3002
|
+
"paragraph",
|
|
3003
|
+
"heading",
|
|
3004
|
+
"table",
|
|
3005
|
+
"tableOfContents",
|
|
3006
|
+
"sdt",
|
|
3007
|
+
"image"
|
|
3008
|
+
]
|
|
3009
|
+
},
|
|
3010
|
+
"nodeId": {
|
|
3011
|
+
"type": "string"
|
|
3012
|
+
}
|
|
3013
|
+
},
|
|
3014
|
+
"required": [
|
|
3015
|
+
"kind",
|
|
3016
|
+
"nodeType",
|
|
3017
|
+
"nodeId"
|
|
3018
|
+
]
|
|
3019
|
+
},
|
|
3020
|
+
"edge": {
|
|
3021
|
+
"enum": [
|
|
3022
|
+
"before",
|
|
3023
|
+
"after"
|
|
3024
|
+
]
|
|
3025
|
+
}
|
|
3026
|
+
},
|
|
3027
|
+
"required": [
|
|
3028
|
+
"kind",
|
|
3029
|
+
"node",
|
|
3030
|
+
"edge"
|
|
3031
|
+
]
|
|
3032
|
+
}
|
|
3033
|
+
],
|
|
3034
|
+
"description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries."
|
|
3035
|
+
}
|
|
3036
|
+
},
|
|
3037
|
+
"required": [
|
|
3038
|
+
"kind",
|
|
3039
|
+
"start",
|
|
3040
|
+
"end"
|
|
3041
|
+
]
|
|
3042
|
+
}
|
|
3043
|
+
},
|
|
3044
|
+
"required": [
|
|
3045
|
+
"by",
|
|
3046
|
+
"target"
|
|
3047
|
+
]
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
"type": "object",
|
|
3051
|
+
"properties": {
|
|
3052
|
+
"by": {
|
|
2610
3053
|
"const": "block",
|
|
2611
3054
|
"type": "string"
|
|
2612
3055
|
},
|
|
@@ -2628,22 +3071,11 @@
|
|
|
2628
3071
|
}
|
|
2629
3072
|
},
|
|
2630
3073
|
"required": [
|
|
2631
|
-
"
|
|
3074
|
+
"by",
|
|
2632
3075
|
"nodeType",
|
|
2633
3076
|
"nodeId"
|
|
2634
3077
|
]
|
|
2635
|
-
},
|
|
2636
|
-
"require": {
|
|
2637
|
-
"enum": [
|
|
2638
|
-
"first",
|
|
2639
|
-
"exactlyOne"
|
|
2640
|
-
]
|
|
2641
3078
|
}
|
|
2642
|
-
},
|
|
2643
|
-
"required": [
|
|
2644
|
-
"by",
|
|
2645
|
-
"select",
|
|
2646
|
-
"require"
|
|
2647
3079
|
]
|
|
2648
3080
|
},
|
|
2649
3081
|
"args": {
|
|
@@ -3095,6 +3527,36 @@
|
|
|
3095
3527
|
"by",
|
|
3096
3528
|
"target"
|
|
3097
3529
|
]
|
|
3530
|
+
},
|
|
3531
|
+
{
|
|
3532
|
+
"type": "object",
|
|
3533
|
+
"properties": {
|
|
3534
|
+
"by": {
|
|
3535
|
+
"const": "block",
|
|
3536
|
+
"type": "string"
|
|
3537
|
+
},
|
|
3538
|
+
"nodeType": {
|
|
3539
|
+
"enum": [
|
|
3540
|
+
"paragraph",
|
|
3541
|
+
"heading",
|
|
3542
|
+
"listItem",
|
|
3543
|
+
"table",
|
|
3544
|
+
"tableRow",
|
|
3545
|
+
"tableCell",
|
|
3546
|
+
"tableOfContents",
|
|
3547
|
+
"image",
|
|
3548
|
+
"sdt"
|
|
3549
|
+
]
|
|
3550
|
+
},
|
|
3551
|
+
"nodeId": {
|
|
3552
|
+
"type": "string"
|
|
3553
|
+
}
|
|
3554
|
+
},
|
|
3555
|
+
"required": [
|
|
3556
|
+
"by",
|
|
3557
|
+
"nodeType",
|
|
3558
|
+
"nodeId"
|
|
3559
|
+
]
|
|
3098
3560
|
}
|
|
3099
3561
|
]
|
|
3100
3562
|
},
|
|
@@ -3476,6 +3938,36 @@
|
|
|
3476
3938
|
"by",
|
|
3477
3939
|
"target"
|
|
3478
3940
|
]
|
|
3941
|
+
},
|
|
3942
|
+
{
|
|
3943
|
+
"type": "object",
|
|
3944
|
+
"properties": {
|
|
3945
|
+
"by": {
|
|
3946
|
+
"const": "block",
|
|
3947
|
+
"type": "string"
|
|
3948
|
+
},
|
|
3949
|
+
"nodeType": {
|
|
3950
|
+
"enum": [
|
|
3951
|
+
"paragraph",
|
|
3952
|
+
"heading",
|
|
3953
|
+
"listItem",
|
|
3954
|
+
"table",
|
|
3955
|
+
"tableRow",
|
|
3956
|
+
"tableCell",
|
|
3957
|
+
"tableOfContents",
|
|
3958
|
+
"image",
|
|
3959
|
+
"sdt"
|
|
3960
|
+
]
|
|
3961
|
+
},
|
|
3962
|
+
"nodeId": {
|
|
3963
|
+
"type": "string"
|
|
3964
|
+
}
|
|
3965
|
+
},
|
|
3966
|
+
"required": [
|
|
3967
|
+
"by",
|
|
3968
|
+
"nodeType",
|
|
3969
|
+
"nodeId"
|
|
3970
|
+
]
|
|
3479
3971
|
}
|
|
3480
3972
|
]
|
|
3481
3973
|
},
|
|
@@ -3741,11 +4233,24 @@
|
|
|
3741
4233
|
"type": "boolean"
|
|
3742
4234
|
}
|
|
3743
4235
|
}
|
|
4236
|
+
},
|
|
4237
|
+
"alignment": {
|
|
4238
|
+
"description": "Set paragraph alignment on the target block(s). Can be combined with inline formatting in the same step.",
|
|
4239
|
+
"enum": [
|
|
4240
|
+
"left",
|
|
4241
|
+
"center",
|
|
4242
|
+
"right",
|
|
4243
|
+
"justify"
|
|
4244
|
+
]
|
|
4245
|
+
},
|
|
4246
|
+
"scope": {
|
|
4247
|
+
"description": "When \"block\", inline formatting expands to cover the entire parent paragraph(s), not just the matched text. Use \"block\" after markdown inserts to format whole paragraphs with a short identifying pattern. Default: \"match\".",
|
|
4248
|
+
"enum": [
|
|
4249
|
+
"match",
|
|
4250
|
+
"block"
|
|
4251
|
+
]
|
|
3744
4252
|
}
|
|
3745
|
-
}
|
|
3746
|
-
"required": [
|
|
3747
|
-
"inline"
|
|
3748
|
-
]
|
|
4253
|
+
}
|
|
3749
4254
|
}
|
|
3750
4255
|
},
|
|
3751
4256
|
"required": [
|