@stablebaseline/sdk 0.6.2 → 0.7.0
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.d.cts +54 -31
- package/dist/index.d.ts +54 -31
- package/openapi.json +111 -33
- package/package.json +1 -1
- package/src/types.generated.ts +54 -31
package/openapi.json
CHANGED
|
@@ -266,7 +266,7 @@
|
|
|
266
266
|
"/tools/listDiagramTypes": {
|
|
267
267
|
"post": {
|
|
268
268
|
"summary": "listDiagramTypes",
|
|
269
|
-
"description": "List supported diagram types. Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema'. Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.",
|
|
269
|
+
"description": "List supported diagram types (renderers such as default, mermaid, plantuml, bpmn and d2; 'default' is the platform default renderer). Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema', 'BPMN process'. Each type lists supportedDiagrams: the diagram families it draws (BPMN process, ERD, flowchart, C4, system architecture and more), each with its defaultRenderer. A query that names a family also returns matchedDiagramFamilies. Use a family's defaultRenderer as the type unless you need another renderer's own format (for example BPMN 2.0 XML). Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.",
|
|
270
270
|
"operationId": "listDiagramTypes",
|
|
271
271
|
"tags": [
|
|
272
272
|
"diagrams"
|
|
@@ -280,7 +280,7 @@
|
|
|
280
280
|
"properties": {
|
|
281
281
|
"query": {
|
|
282
282
|
"type": "string",
|
|
283
|
-
"description": "Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing'. Semantic-backed: matches descriptions, not just names."
|
|
283
|
+
"description": "Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing', 'BPMN process'. Semantic-backed: matches descriptions and diagram family names, not just type names."
|
|
284
284
|
},
|
|
285
285
|
"enabledOnly": {
|
|
286
286
|
"type": "boolean"
|
|
@@ -296,7 +296,7 @@
|
|
|
296
296
|
"items": {
|
|
297
297
|
"type": "string"
|
|
298
298
|
},
|
|
299
|
-
"description": "Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt."
|
|
299
|
+
"description": "Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt, supportedDiagrams."
|
|
300
300
|
}
|
|
301
301
|
}
|
|
302
302
|
}
|
|
@@ -381,7 +381,7 @@
|
|
|
381
381
|
"/tools/getDiagramTypeGuide": {
|
|
382
382
|
"post": {
|
|
383
383
|
"summary": "getDiagramTypeGuide",
|
|
384
|
-
"description": "Get DSL writing instructions for a diagram type. Call before writing diagramCode.",
|
|
384
|
+
"description": "Get DSL writing instructions and an example for a diagram type (a renderer such as 'default', 'mermaid' or 'bpmn'). Also accepts a diagram family slug or name from supportedDiagrams (e.g. 'bpmn-process'), which resolves to that family's default renderer (see resolvedFrom). supportedDiagrams lists the families the type draws, each with its defaultRenderer. Call before writing diagramCode.",
|
|
385
385
|
"operationId": "getDiagramTypeGuide",
|
|
386
386
|
"tags": [
|
|
387
387
|
"diagrams"
|
|
@@ -394,7 +394,8 @@
|
|
|
394
394
|
"type": "object",
|
|
395
395
|
"properties": {
|
|
396
396
|
"type": {
|
|
397
|
-
"type": "string"
|
|
397
|
+
"type": "string",
|
|
398
|
+
"description": "A diagram type from listDiagramTypes (e.g. 'default', 'mermaid', 'bpmn'), or a diagram family slug or name (e.g. 'bpmn-process'), which resolves to the family's default renderer."
|
|
398
399
|
},
|
|
399
400
|
"fields": {
|
|
400
401
|
"type": "array",
|
|
@@ -489,7 +490,7 @@
|
|
|
489
490
|
"/tools/listArchitectureIcons": {
|
|
490
491
|
"post": {
|
|
491
492
|
"summary": "listArchitectureIcons",
|
|
492
|
-
"description": "
|
|
493
|
+
"description": "List and search the full Stable Baseline icon library, including 3,850 library icons. The AWS, Azure, GCP, Development, Essentials and other categories stay intact; library icons join matching categories, with specific Oracle Cloud, Kubernetes, Networking and General categories for the rest. The same logical name is shown once. iconKey is the exact icon string for a platform default diagram (type 'default'; e.g. {icon:'aws-account'}); iconKeys lists every exact key for that logical icon, and iconKeyUrl is its SVG. Results without an iconKey are not available in platform default diagrams. Use d2IconPath for compact relative D2 source (e.g. icon-library/azure-function-apps.svg); the renderer expands storage URLs. Existing iconPath values remain relative whiteboard paths; library-only icons supply iconUrl for a whiteboard imageUrl.",
|
|
493
494
|
"operationId": "listArchitectureIcons",
|
|
494
495
|
"tags": [
|
|
495
496
|
"diagrams"
|
|
@@ -503,11 +504,11 @@
|
|
|
503
504
|
"properties": {
|
|
504
505
|
"query": {
|
|
505
506
|
"type": "string",
|
|
506
|
-
"description": "Search by name, category, vendor, or
|
|
507
|
+
"description": "Search by icon name, exact iconKey, category, vendor, description or aliases."
|
|
507
508
|
},
|
|
508
509
|
"category": {
|
|
509
510
|
"type": "string",
|
|
510
|
-
"description": "Filter by category
|
|
511
|
+
"description": "Filter by category, e.g. AWS, Azure, GCP, Technology, Oracle Cloud, Kubernetes, Networking, General."
|
|
511
512
|
},
|
|
512
513
|
"limit": {
|
|
513
514
|
"type": "number"
|
|
@@ -520,7 +521,7 @@
|
|
|
520
521
|
"items": {
|
|
521
522
|
"type": "string"
|
|
522
523
|
},
|
|
523
|
-
"description": "Field projection. Valid fields: id, iconPath, iconName, category, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder."
|
|
524
|
+
"description": "Field projection. Valid fields: id, iconPath (existing relative paths only), iconUrl, iconName, category, categories, sources, iconKey, iconKeys, iconKeyUrl, d2IconPath, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder."
|
|
524
525
|
}
|
|
525
526
|
}
|
|
526
527
|
}
|
|
@@ -3319,11 +3320,11 @@
|
|
|
3319
3320
|
},
|
|
3320
3321
|
"type": {
|
|
3321
3322
|
"type": "string",
|
|
3322
|
-
"description": "Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types."
|
|
3323
|
+
"description": "Diagram type, meaning the renderer (e.g. default, mermaid, plantuml, bpmn, d2; 'default' is the platform default renderer). For a diagram family such as a BPMN process, an ERD or a flowchart, use the family's defaultRenderer from listDiagramTypes or getDiagramTypeGuide. Call listDiagramTypes for all types."
|
|
3323
3324
|
},
|
|
3324
3325
|
"diagramCode": {
|
|
3325
3326
|
"type": "string",
|
|
3326
|
-
"description": "Diagram DSL code. Call getDiagramTypeGuide for syntax. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it."
|
|
3327
|
+
"description": "Diagram DSL code. Call getDiagramTypeGuide for syntax. For 'default', provide MDP JSON with stable IDs and omit every entity x/y for automatic layout; fully positioned manual diagrams are also supported, and icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it."
|
|
3327
3328
|
},
|
|
3328
3329
|
"prompt": {
|
|
3329
3330
|
"type": "string",
|
|
@@ -3507,7 +3508,7 @@
|
|
|
3507
3508
|
},
|
|
3508
3509
|
"diagramCode": {
|
|
3509
3510
|
"type": "string",
|
|
3510
|
-
"description": "New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`)."
|
|
3511
|
+
"description": "New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. For 'default', provide complete MDP JSON and preserve stable IDs; omit entity x/y for automatic layout, or preserve all x/y in a manually positioned legacy diagram. Root layout.mode='auto' can explicitly rearrange an existing diagram. Its icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`)."
|
|
3511
3512
|
},
|
|
3512
3513
|
"prompt": {
|
|
3513
3514
|
"type": "string",
|
|
@@ -4286,7 +4287,7 @@
|
|
|
4286
4287
|
},
|
|
4287
4288
|
"strength": {
|
|
4288
4289
|
"type": "number",
|
|
4289
|
-
"description": "Optional 0..1
|
|
4290
|
+
"description": "Optional 0..1: how far the regenerated area may diverge from the original. The editing model may balance this from the prompt instead, so leave it unset unless you need it."
|
|
4290
4291
|
}
|
|
4291
4292
|
},
|
|
4292
4293
|
"required": [
|
|
@@ -4377,7 +4378,7 @@
|
|
|
4377
4378
|
"/tools/designDeckInWhiteboard": {
|
|
4378
4379
|
"post": {
|
|
4379
4380
|
"summary": "designDeckInWhiteboard",
|
|
4380
|
-
"description": "Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits and an edit
|
|
4381
|
+
"description": "Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. It can also generate imagery for the deck where the design calls for it. ADVANCED DECK BUILDING (optional, OFF by default): set advancedDeckBuilding:true to build the deck over several rounds of redraft and review by a panel of design, brand, accessibility and copy reviewers instead of one composer pass. It usually raises design quality, but it is not a guarantee. It is much slower and it costs more: a standard build takes roughly 2 to 8 minutes, advanced deck building takes roughly 15 to 20 minutes, and it adds 15 credits per depth level on top of the turn fee (advancedDeckBuildingDepth is 1 to 3, default 3, so +45 credits, making a 50-credit build cost 95). Only turn it on when the user asks for the highest quality and accepts the wait and the cost. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, slideCount (the target the conversation now carries) and slideCountClamped (always false; nothing reduces a slide count), advancedDeckBuilding (whether advanced deck building is on for this conversation), advancedDeckBuildingStatus, and assistantMessage. Export the finished deck with exportFromWhiteboard.",
|
|
4381
4382
|
"operationId": "designDeckInWhiteboard",
|
|
4382
4383
|
"tags": [
|
|
4383
4384
|
"whiteboards"
|
|
@@ -4425,7 +4426,7 @@
|
|
|
4425
4426
|
},
|
|
4426
4427
|
"slideCount": {
|
|
4427
4428
|
"type": "number",
|
|
4428
|
-
"description": "The number of slides to build — a hard requirement: the deck is built with exactly this many slides. SET THIS whenever the user states or implies a count, EXACT OR APPROXIMATE: '12 slides' → 12, 'about 15' / '15 or so' → 15, 'no more than 10' → 10. Never expand the user's number: if they said 'about 15', pass 15 and shape the brief to fit 15 — outlining 19 sections in the message does not raise the count, it just fights this parameter. It is PERSISTED on the conversation, so send it ONCE (on the turn that states it) and every later build turn of the same conversation carries it automatically; send it again only to CHANGE the target. It is honoured on edit turns too ('cut it to 8 slides').
|
|
4429
|
+
"description": "The number of slides to build — a hard requirement: the deck is built with exactly this many slides. SET THIS whenever the user states or implies a count, EXACT OR APPROXIMATE: '12 slides' → 12, 'about 15' / '15 or so' → 15, 'no more than 10' → 10. Never expand the user's number: if they said 'about 15', pass 15 and shape the brief to fit 15 — outlining 19 sections in the message does not raise the count, it just fights this parameter. It is PERSISTED on the conversation, so send it ONCE (on the turn that states it) and every later build turn of the same conversation carries it automatically; send it again only to CHANGE the target. It is honoured on edit turns too ('cut it to 8 slides'). THERE IS NO MAXIMUM: ask for 40, 60 or 100 slides and that is what gets built. Longer decks cost proportionally more (50 credits per 30 slides) and take proportionally longer. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12)."
|
|
4429
4430
|
},
|
|
4430
4431
|
"imageCount": {
|
|
4431
4432
|
"type": "number",
|
|
@@ -4560,7 +4561,7 @@
|
|
|
4560
4561
|
"/tools/designIllustrationInWhiteboard": {
|
|
4561
4562
|
"post": {
|
|
4562
4563
|
"summary": "designIllustrationInWhiteboard",
|
|
4563
|
-
"description": "Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the illustration designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. COST + APPROVAL: a build costs 50 credits and an edit
|
|
4564
|
+
"description": "Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the illustration designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the illustration's id), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage.",
|
|
4564
4565
|
"operationId": "designIllustrationInWhiteboard",
|
|
4565
4566
|
"tags": [
|
|
4566
4567
|
"whiteboards"
|
|
@@ -5797,12 +5798,9 @@
|
|
|
5797
5798
|
"documentId": {
|
|
5798
5799
|
"type": "string"
|
|
5799
5800
|
},
|
|
5800
|
-
"
|
|
5801
|
-
"type":
|
|
5802
|
-
|
|
5803
|
-
"string"
|
|
5804
|
-
],
|
|
5805
|
-
"description": "Optional, used by the design worker's connector pass: route the batch's BOUND arrows and lines with the obstacle-aware libavoid router against the full scene before placing them (true), or 'force' to also discard hand-authored elbow points. Omit for the default as-authored routing. Declared because the tool rejects undeclared parameters and every builder-drawn arrow was failing on it (2026-09-09)."
|
|
5801
|
+
"rerouteConnectors": {
|
|
5802
|
+
"type": "boolean",
|
|
5803
|
+
"description": "Optional. Arrows and lines bound to a shape at BOTH ends (start.id and end.id) are always routed around the other shapes on the board unless you give them points. true: ignore the points you gave for such connectors and route them too. Omit to keep the points you supply."
|
|
5806
5804
|
},
|
|
5807
5805
|
"shapes": {
|
|
5808
5806
|
"type": "array",
|
|
@@ -6414,11 +6412,11 @@
|
|
|
6414
6412
|
},
|
|
6415
6413
|
"diagramType": {
|
|
6416
6414
|
"type": "string",
|
|
6417
|
-
"description": "Diagram language, e.g. 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'.
|
|
6415
|
+
"description": "Diagram language, e.g. 'default', 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'. For a diagram family, use its defaultRenderer from listDiagramTypes."
|
|
6418
6416
|
},
|
|
6419
6417
|
"source": {
|
|
6420
6418
|
"type": "string",
|
|
6421
|
-
"description": "The diagram DSL / code. For
|
|
6419
|
+
"description": "The diagram DSL / code. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec)."
|
|
6422
6420
|
},
|
|
6423
6421
|
"caption": {
|
|
6424
6422
|
"type": "string",
|
|
@@ -7216,7 +7214,7 @@
|
|
|
7216
7214
|
"/tools/renderDiagram": {
|
|
7217
7215
|
"post": {
|
|
7218
7216
|
"summary": "renderDiagram",
|
|
7219
|
-
"description": "Generate a diagram from its DSL/code and get the IMAGE back — WITHOUT inserting it into any document or whiteboard. For acting as a pure diagram generator. Provide diagramType (e.g. 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'; call listDiagramTypes for the full set) and source (the diagram code). Choose format 'png' (default), 'jpeg', or 'svg'; for raster choose scale 1/2/3 for 1x/2x/3x; optional background (png only). Returns a TEMPORARY imageUrl that stays available for 1 hour (the render is then deleted), and for png/jpeg the image inline so you can see it. The link carries no signing token, so it survives being rendered as a citation. To render a diagram that already lives in a document/whiteboard use getDiagramImage; to persist a new one use insertDiagramInDocument or insertWhiteboardDiagram.",
|
|
7217
|
+
"description": "Generate a diagram from its DSL/code and get the IMAGE back — WITHOUT inserting it into any document or whiteboard. For acting as a pure diagram generator. Provide diagramType (e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'; call listDiagramTypes for the full set) and source (the diagram code). Choose format 'png' (default), 'jpeg', or 'svg'; for raster choose scale 1/2/3 for 1x/2x/3x; optional background (png only). Returns a TEMPORARY imageUrl that stays available for 1 hour (the render is then deleted), and for png/jpeg the image inline so you can see it. The link carries no signing token, so it survives being rendered as a citation. To render a diagram that already lives in a document/whiteboard use getDiagramImage; to persist a new one use insertDiagramInDocument or insertWhiteboardDiagram.",
|
|
7220
7218
|
"operationId": "renderDiagram",
|
|
7221
7219
|
"tags": [
|
|
7222
7220
|
"diagrams"
|
|
@@ -7230,11 +7228,11 @@
|
|
|
7230
7228
|
"properties": {
|
|
7231
7229
|
"diagramType": {
|
|
7232
7230
|
"type": "string",
|
|
7233
|
-
"description": "Diagram language, e.g. 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'.
|
|
7231
|
+
"description": "Diagram language, e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'. For a diagram family, use its defaultRenderer from listDiagramTypes."
|
|
7234
7232
|
},
|
|
7235
7233
|
"source": {
|
|
7236
7234
|
"type": "string",
|
|
7237
|
-
"description": "The diagram DSL / code to render. For
|
|
7235
|
+
"description": "The diagram DSL / code to render. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec)."
|
|
7238
7236
|
},
|
|
7239
7237
|
"format": {
|
|
7240
7238
|
"type": "string",
|
|
@@ -7243,7 +7241,7 @@
|
|
|
7243
7241
|
"jpeg",
|
|
7244
7242
|
"svg"
|
|
7245
7243
|
],
|
|
7246
|
-
"description": "png (default) or jpeg = raster; svg
|
|
7244
|
+
"description": "png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported."
|
|
7247
7245
|
},
|
|
7248
7246
|
"scale": {
|
|
7249
7247
|
"type": "number",
|
|
@@ -7380,7 +7378,7 @@
|
|
|
7380
7378
|
"jpeg",
|
|
7381
7379
|
"svg"
|
|
7382
7380
|
],
|
|
7383
|
-
"description": "png (default) or jpeg = raster; svg
|
|
7381
|
+
"description": "png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported."
|
|
7384
7382
|
},
|
|
7385
7383
|
"scale": {
|
|
7386
7384
|
"type": "number",
|
|
@@ -9353,6 +9351,20 @@
|
|
|
9353
9351
|
},
|
|
9354
9352
|
"status": {
|
|
9355
9353
|
"type": "string",
|
|
9354
|
+
"enum": [
|
|
9355
|
+
"captured",
|
|
9356
|
+
"triaging",
|
|
9357
|
+
"shaped",
|
|
9358
|
+
"approved",
|
|
9359
|
+
"ready_for_agent",
|
|
9360
|
+
"in_progress",
|
|
9361
|
+
"ready_for_review",
|
|
9362
|
+
"in_review",
|
|
9363
|
+
"blocked",
|
|
9364
|
+
"done",
|
|
9365
|
+
"rejected",
|
|
9366
|
+
"deferred"
|
|
9367
|
+
],
|
|
9356
9368
|
"description": "Initial status. Default: captured."
|
|
9357
9369
|
},
|
|
9358
9370
|
"source": {
|
|
@@ -9711,7 +9723,21 @@
|
|
|
9711
9723
|
"type": "string"
|
|
9712
9724
|
},
|
|
9713
9725
|
"status": {
|
|
9714
|
-
"type": "string"
|
|
9726
|
+
"type": "string",
|
|
9727
|
+
"enum": [
|
|
9728
|
+
"captured",
|
|
9729
|
+
"triaging",
|
|
9730
|
+
"shaped",
|
|
9731
|
+
"approved",
|
|
9732
|
+
"ready_for_agent",
|
|
9733
|
+
"in_progress",
|
|
9734
|
+
"ready_for_review",
|
|
9735
|
+
"in_review",
|
|
9736
|
+
"blocked",
|
|
9737
|
+
"done",
|
|
9738
|
+
"rejected",
|
|
9739
|
+
"deferred"
|
|
9740
|
+
]
|
|
9715
9741
|
},
|
|
9716
9742
|
"priority": {
|
|
9717
9743
|
"type": "string"
|
|
@@ -13104,6 +13130,20 @@
|
|
|
13104
13130
|
},
|
|
13105
13131
|
"status": {
|
|
13106
13132
|
"type": "string",
|
|
13133
|
+
"enum": [
|
|
13134
|
+
"captured",
|
|
13135
|
+
"triaging",
|
|
13136
|
+
"shaped",
|
|
13137
|
+
"approved",
|
|
13138
|
+
"ready_for_agent",
|
|
13139
|
+
"in_progress",
|
|
13140
|
+
"ready_for_review",
|
|
13141
|
+
"in_review",
|
|
13142
|
+
"blocked",
|
|
13143
|
+
"done",
|
|
13144
|
+
"rejected",
|
|
13145
|
+
"deferred"
|
|
13146
|
+
],
|
|
13107
13147
|
"description": "Initial status. Default: captured."
|
|
13108
13148
|
},
|
|
13109
13149
|
"priority": {
|
|
@@ -13700,7 +13740,21 @@
|
|
|
13700
13740
|
"type": "string"
|
|
13701
13741
|
},
|
|
13702
13742
|
"status": {
|
|
13703
|
-
"type": "string"
|
|
13743
|
+
"type": "string",
|
|
13744
|
+
"enum": [
|
|
13745
|
+
"captured",
|
|
13746
|
+
"triaging",
|
|
13747
|
+
"shaped",
|
|
13748
|
+
"approved",
|
|
13749
|
+
"ready_for_agent",
|
|
13750
|
+
"in_progress",
|
|
13751
|
+
"ready_for_review",
|
|
13752
|
+
"in_review",
|
|
13753
|
+
"blocked",
|
|
13754
|
+
"done",
|
|
13755
|
+
"rejected",
|
|
13756
|
+
"deferred"
|
|
13757
|
+
]
|
|
13704
13758
|
},
|
|
13705
13759
|
"priority": {
|
|
13706
13760
|
"type": "string"
|
|
@@ -15141,7 +15195,7 @@
|
|
|
15141
15195
|
"/tools/kg_search": {
|
|
15142
15196
|
"post": {
|
|
15143
15197
|
"summary": "kg_search",
|
|
15144
|
-
"description": "Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. To LOCATE AN ARTEFACT BY NAME OR ID rather than answer a question, pass artefactMetadataOnly:true — see below. Without that flag this tool retrieves knowledge from inside content and will not reliably find a thing by its title.\n\nPICK THE MODE THAT FITS THE QUERY:\n\n• mode='local' (default) — for SPECIFIC factual questions (\"what does section 15 say about deposits?\", \"who is the Chief Counsel?\"). FTS+vector RRF over individual document chunks. Returns precise excerpts with citations.\n\n• mode='global' — for THEMATIC / OVERVIEW / SUMMARY questions (\"what are the main themes\", \"give me an overview of the project\", \"what topics does this cover\"). Returns Louvain community summaries + curated wiki pages — far better than 'local' for big-picture queries because community summaries already aggregate across many chunks. ALWAYS PREFER over 'local' when the user asks for themes / summary / overview / topic landscape.\n\n• mode='graph' — for RELATIONSHIP questions (\"what's connected to entity X?\", \"who cites Section 5?\"). 1-hop entity-neighbourhood walk. Pass query OR srcEntityId.\n\n• mode='path' — for CONNECTION questions (\"how does X relate to Y?\"). Shortest path between two entities. Pass srcEntityId AND dstEntityId.\n\n• mode='ppr' — for MULTI-HOP discovery (\"what's relevant to X, even indirectly?\"). Personalised PageRank over AUTHORED-vs-EXTRACTED weighted edges, seeded by query-similar entities. Best when 'local' returns too few results and the answer requires walking through several entity hops.\n\nQuick decision tree:\n- User asks for an overview/summary/themes → 'global'\n- User asks a specific question with a clear answer → 'local'\n- User asks 'how is X connected to Y' → 'path' (with both entity IDs)\n- User asks 'what's near entity X' → 'graph' (with srcEntityId)\n- 'local' returned nothing useful and the question is broad → retry with 'ppr'\n- User wants to FIND a named artefact (\"the GTM plan\", \"DOC-123\", a uuid) → artefactMetadataOnly:true\n\nARTEFACT-METADATA MODE (artefactMetadataOnly:true): ignores `mode` entirely and matches title + friendly id + uuid across EVERY artefact type — documents, whiteboards, plans, tasks, improvements, compliance frameworks. Returns a typed navigable list ({ artefacts: [{ result_type, id, friendly_id, title, snippet, document_id, project_id, href }] }). It reads no document content and needs no knowledge graph: unlike every other mode it is NOT limited to what has been ingested, so it still finds artefacts in projects where the KG is switched off. Narrow it with artefactTypes. To search inside document BODIES use listDocuments (full-content grep).",
|
|
15198
|
+
"description": "Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. To LOCATE AN ARTEFACT BY NAME OR ID rather than answer a question, pass artefactMetadataOnly:true — see below. Without that flag this tool retrieves knowledge from inside content and will not reliably find a thing by its title.\n\nDATED FACTS: the response also carries `datedFacts` for the entities the query names: what holds now by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and its sources. Prefer them for \"who owns X now\", \"what was X in March\", \"when did X change\".\n\nPICK THE MODE THAT FITS THE QUERY:\n\n• mode='local' (default) — for SPECIFIC factual questions (\"what does section 15 say about deposits?\", \"who is the Chief Counsel?\"). FTS+vector RRF over individual document chunks. Returns precise excerpts with citations.\n\n• mode='global' — for THEMATIC / OVERVIEW / SUMMARY questions (\"what are the main themes\", \"give me an overview of the project\", \"what topics does this cover\"). Returns Louvain community summaries + curated wiki pages — far better than 'local' for big-picture queries because community summaries already aggregate across many chunks. ALWAYS PREFER over 'local' when the user asks for themes / summary / overview / topic landscape.\n\n• mode='graph' — for RELATIONSHIP questions (\"what's connected to entity X?\", \"who cites Section 5?\"). 1-hop entity-neighbourhood walk. Pass query OR srcEntityId.\n\n• mode='path' — for CONNECTION questions (\"how does X relate to Y?\"). Shortest path between two entities. Pass srcEntityId AND dstEntityId.\n\n• mode='ppr' — for MULTI-HOP discovery (\"what's relevant to X, even indirectly?\"). Personalised PageRank over AUTHORED-vs-EXTRACTED weighted edges, seeded by query-similar entities. Best when 'local' returns too few results and the answer requires walking through several entity hops.\n\nQuick decision tree:\n- User asks for an overview/summary/themes → 'global'\n- User asks a specific question with a clear answer → 'local'\n- User asks 'how is X connected to Y' → 'path' (with both entity IDs)\n- User asks 'what's near entity X' → 'graph' (with srcEntityId)\n- 'local' returned nothing useful and the question is broad → retry with 'ppr'\n- User wants to FIND a named artefact (\"the GTM plan\", \"DOC-123\", a uuid) → artefactMetadataOnly:true\n\nARTEFACT-METADATA MODE (artefactMetadataOnly:true): ignores `mode` entirely and matches title + friendly id + uuid across EVERY artefact type — documents, whiteboards, plans, tasks, improvements, compliance frameworks. Returns a typed navigable list ({ artefacts: [{ result_type, id, friendly_id, title, snippet, document_id, project_id, href }] }). It reads no document content and needs no knowledge graph: unlike every other mode it is NOT limited to what has been ingested, so it still finds artefacts in projects where the KG is switched off. Narrow it with artefactTypes. To search inside document BODIES use listDocuments (full-content grep).",
|
|
15145
15199
|
"operationId": "kg_search",
|
|
15146
15200
|
"tags": [
|
|
15147
15201
|
"knowledge_graph"
|
|
@@ -15217,6 +15271,18 @@
|
|
|
15217
15271
|
"limit": {
|
|
15218
15272
|
"type": "number",
|
|
15219
15273
|
"default": 20
|
|
15274
|
+
},
|
|
15275
|
+
"asOf": {
|
|
15276
|
+
"type": "string",
|
|
15277
|
+
"description": "Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date."
|
|
15278
|
+
},
|
|
15279
|
+
"history": {
|
|
15280
|
+
"type": "boolean",
|
|
15281
|
+
"description": "Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for \"how did X change\" or \"what was X before\"."
|
|
15282
|
+
},
|
|
15283
|
+
"timeZone": {
|
|
15284
|
+
"type": "string",
|
|
15285
|
+
"description": "Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC. Pass the user's zone when you know it, so \"today\" and dates match their calendar."
|
|
15220
15286
|
}
|
|
15221
15287
|
}
|
|
15222
15288
|
}
|
|
@@ -15406,7 +15472,7 @@
|
|
|
15406
15472
|
"/tools/kg_get_entity": {
|
|
15407
15473
|
"post": {
|
|
15408
15474
|
"summary": "kg_get_entity",
|
|
15409
|
-
"description": "Fetch a KG entity by id or name, with 1-hop neighbours.",
|
|
15475
|
+
"description": "Fetch a KG entity by id or name, with 1-hop neighbours. The response also carries `datedFacts`: what holds now about the entity by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and the sources that state it.",
|
|
15410
15476
|
"operationId": "kg_get_entity",
|
|
15411
15477
|
"tags": [
|
|
15412
15478
|
"knowledge_graph"
|
|
@@ -15427,6 +15493,18 @@
|
|
|
15427
15493
|
"projectId": {
|
|
15428
15494
|
"type": "string",
|
|
15429
15495
|
"description": "Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects."
|
|
15496
|
+
},
|
|
15497
|
+
"asOf": {
|
|
15498
|
+
"type": "string",
|
|
15499
|
+
"description": "Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date."
|
|
15500
|
+
},
|
|
15501
|
+
"history": {
|
|
15502
|
+
"type": "boolean",
|
|
15503
|
+
"description": "Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for \"how did X change\" or \"what was X before\"."
|
|
15504
|
+
},
|
|
15505
|
+
"timeZone": {
|
|
15506
|
+
"type": "string",
|
|
15507
|
+
"description": "Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC."
|
|
15430
15508
|
}
|
|
15431
15509
|
}
|
|
15432
15510
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stablebaseline/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "TypeScript SDK for the Stable Baseline REST API. End-to-end agent-managed company brain — docs, diagrams, plans, and a self-learning Knowledge Graph. 196 tools across 18 categories.",
|
|
5
5
|
"homepage": "https://stablebaseline.io",
|
|
6
6
|
"repository": {
|