@stablebaseline/sdk 0.5.3 → 0.6.1
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 +66 -29
- package/dist/index.d.ts +66 -29
- package/openapi.json +106 -34
- package/package.json +2 -2
- package/src/types.generated.ts +66 -29
package/src/types.generated.ts
CHANGED
|
@@ -695,7 +695,7 @@ export interface paths {
|
|
|
695
695
|
put?: never;
|
|
696
696
|
/**
|
|
697
697
|
* designDeckInWhiteboard
|
|
698
|
-
* @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 10; a clarifying question is FREE.
|
|
698
|
+
* @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 10; 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 + slideCountClamped (the target the conversation now carries, and whether it was reduced to the maximum), advancedDeckBuilding (whether advanced deck building is on for this conversation), advancedDeckBuildingStatus, and assistantMessage. Export the finished deck with exportFromWhiteboard.
|
|
699
699
|
*/
|
|
700
700
|
post: operations["designDeckInWhiteboard"];
|
|
701
701
|
delete?: never;
|
|
@@ -755,7 +755,7 @@ export interface paths {
|
|
|
755
755
|
put?: never;
|
|
756
756
|
/**
|
|
757
757
|
* exportFromWhiteboard
|
|
758
|
-
* @description Export a design that lives in a whiteboard to an editable PowerPoint (PPTX), PDF, PNG images,
|
|
758
|
+
* @description Export a design that lives in a whiteboard to an editable PowerPoint (PPTX), a PDF, or PNG images. LARGE DECKS FINISH IN THE BACKGROUND: if the export takes longer than one tool call can wait, this returns status:'exporting' with a jobId instead of the file — wait about 30 seconds and call this tool AGAIN with the SAME arguments to collect it. Repeat until status is 'completed' and 'url' is present. Nothing is re-exported while a job is already running, so polling is cheap and safe. Download links are available for 1 hour. Give it the whiteboard documentId and the designId (the deck). kind:'deck' (default) renders the finished deck via the export worker: 'pptx' = native, fully-editable PowerPoint (real shapes and text, not screenshots); 'pdf' = vector, one page per slide; 'png' = one image per slide. HTML is not an available format — do not ask for it. Small exports come back as base64 in data (pptx/pdf); anything larger, and every png export, comes back as download links. The design must be finished; one that is still generating, failed, or archived returns a clear message.
|
|
759
759
|
*/
|
|
760
760
|
post: operations["exportFromWhiteboard"];
|
|
761
761
|
delete?: never;
|
|
@@ -855,7 +855,7 @@ export interface paths {
|
|
|
855
855
|
put?: never;
|
|
856
856
|
/**
|
|
857
857
|
* listWhiteboards
|
|
858
|
-
* @description List the whiteboards in a project (hidden whiteboard-kind documents). Returns documentId, diagramId, title and timestamps for each.
|
|
858
|
+
* @description List AND grep the whiteboards in a project (hidden whiteboard-kind documents). `query` searches the title and friendlyId (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). This is the tool to find a board by name — listDocuments deliberately excludes whiteboards. Returns documentId, diagramId, title and timestamps for each.
|
|
859
859
|
*/
|
|
860
860
|
post: operations["listWhiteboards"];
|
|
861
861
|
delete?: never;
|
|
@@ -1095,7 +1095,7 @@ export interface paths {
|
|
|
1095
1095
|
put?: never;
|
|
1096
1096
|
/**
|
|
1097
1097
|
* renderDiagram
|
|
1098
|
-
* @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
|
|
1098
|
+
* @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.
|
|
1099
1099
|
*/
|
|
1100
1100
|
post: operations["renderDiagram"];
|
|
1101
1101
|
delete?: never;
|
|
@@ -1115,7 +1115,7 @@ export interface paths {
|
|
|
1115
1115
|
put?: never;
|
|
1116
1116
|
/**
|
|
1117
1117
|
* getDiagramImage
|
|
1118
|
-
* @description Render a diagram that ALREADY exists in a document to an IMAGE (svg/png/jpeg @1x/2x/3x) and return it — a temporary
|
|
1118
|
+
* @description Render a diagram that ALREADY exists in a document to an IMAGE (svg/png/jpeg @1x/2x/3x) and return it — a temporary imageUrl available for 1 hour plus, for png/jpeg, the image inline so you can see it, and title/url citing the document the diagram lives in. Pass the diagramId (from getDocument's DIAGRAM markers or getDiagramInDocument). Reuses the diagram's cached server render when available (pixel-identical to the editor), otherwise renders from the diagram's source on the fly. Read-only: nothing in the document or the diagram is changed; the image is a temporary artefact that expires after 1 hour. Use renderDiagram instead to generate from raw DSL without an existing diagram.
|
|
1119
1119
|
*/
|
|
1120
1120
|
post: operations["getDiagramImage"];
|
|
1121
1121
|
delete?: never;
|
|
@@ -1235,7 +1235,7 @@ export interface paths {
|
|
|
1235
1235
|
put?: never;
|
|
1236
1236
|
/**
|
|
1237
1237
|
* insertImageInDocument
|
|
1238
|
-
* @description Insert an image into a document (max 10MB). Provide imageBase64, imageBinary, or imageUrl. For large files, call createImageUploadSession first then use the returned assetUrl.
|
|
1238
|
+
* @description Insert an image into a document (max 10MB). Provide imageBase64, imageBinary, or imageUrl. For large files, call createImageUploadSession first then use the returned assetUrl. nlDescription AND caption are both REQUIRED, not optional polish: they are what makes the image findable in search and what lets an agent decide whether this picture belongs on a slide or in an answer, since neither can see the pixels from a filename. Write them about what the image SHOWS.
|
|
1239
1239
|
*/
|
|
1240
1240
|
post: operations["insertImageInDocument"];
|
|
1241
1241
|
delete?: never;
|
|
@@ -1255,7 +1255,7 @@ export interface paths {
|
|
|
1255
1255
|
put?: never;
|
|
1256
1256
|
/**
|
|
1257
1257
|
* updateImageInDocument
|
|
1258
|
-
* @description Update image metadata (alt, caption, dimensions, alignment). Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.
|
|
1258
|
+
* @description Update image metadata (alt, caption, nlDescription, dimensions, alignment) — metadata only; to change the picture itself, delete it and insert the new one. Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.
|
|
1259
1259
|
*/
|
|
1260
1260
|
post: operations["updateImageInDocument"];
|
|
1261
1261
|
delete?: never;
|
|
@@ -1275,7 +1275,7 @@ export interface paths {
|
|
|
1275
1275
|
put?: never;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* deleteImageInDocument
|
|
1278
|
-
* @description Delete an image from
|
|
1278
|
+
* @description Delete an image: removes the stored file, the database record, AND the image from the document body — both the IMAGE marker in the markdown and the image node in the document's rich-text content, so the picture stops appearing on every read. Deleting an image the document still references is the point of this tool; do not hand-edit the marker out with editDocument, which removes the reference but leaves the file and record behind.
|
|
1279
1279
|
*/
|
|
1280
1280
|
post: operations["deleteImageInDocument"];
|
|
1281
1281
|
delete?: never;
|
|
@@ -1675,11 +1675,11 @@ export interface paths {
|
|
|
1675
1675
|
put?: never;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* searchImprovements
|
|
1678
|
-
* @description
|
|
1678
|
+
* @description Ranked semantic search over IMPROVEMENTS AND TASKS — hybrid full-text + vector, so it matches meaning rather than just wording. Returns ranked { improvements }, each with a versionTimestamp you can pass straight to updateImprovement without a getImprovement round-trip.
|
|
1679
1679
|
*
|
|
1680
|
-
*
|
|
1680
|
+
* Improvements and tasks are one table (a task is an improvement with is_task=true), so both are searched by default. Pass types:["task"] or types:["improvement"] to narrow to one.
|
|
1681
1681
|
*
|
|
1682
|
-
*
|
|
1682
|
+
* This tool searches improvements and tasks ONLY. To find a document, whiteboard, plan or compliance item by name or friendly id, use kg_search({ query, artefactMetadataOnly: true }) — it matches title + friendly id + uuid across every artefact type and needs no knowledge graph. To search document CONTENT, use listDocuments.
|
|
1683
1683
|
*/
|
|
1684
1684
|
post: operations["searchImprovements"];
|
|
1685
1685
|
delete?: never;
|
|
@@ -2259,7 +2259,7 @@ export interface paths {
|
|
|
2259
2259
|
put?: never;
|
|
2260
2260
|
/**
|
|
2261
2261
|
* kg_search
|
|
2262
|
-
* @description Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT.
|
|
2262
|
+
* @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.
|
|
2263
2263
|
*
|
|
2264
2264
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2265
2265
|
*
|
|
@@ -2279,6 +2279,9 @@ export interface paths {
|
|
|
2279
2279
|
* - User asks 'how is X connected to Y' → 'path' (with both entity IDs)
|
|
2280
2280
|
* - User asks 'what's near entity X' → 'graph' (with srcEntityId)
|
|
2281
2281
|
* - 'local' returned nothing useful and the question is broad → retry with 'ppr'
|
|
2282
|
+
* - User wants to FIND a named artefact ("the GTM plan", "DOC-123", a uuid) → artefactMetadataOnly:true
|
|
2283
|
+
*
|
|
2284
|
+
* ARTEFACT-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).
|
|
2282
2285
|
*/
|
|
2283
2286
|
post: operations["kg_search"];
|
|
2284
2287
|
delete?: never;
|
|
@@ -3858,7 +3861,7 @@ export interface paths {
|
|
|
3858
3861
|
put?: never;
|
|
3859
3862
|
/**
|
|
3860
3863
|
* setDefaultBrandKit
|
|
3861
|
-
* @description Set or clear the default BRAND KIT at a scope: organization, workspace, or
|
|
3864
|
+
* @description Set or clear the default BRAND KIT at a scope: organization, workspace, project, folder, or document. Defaults cascade most-specific-first, lowest level up: document beats the nearest folder up the (nested) folder chain beats project beats workspace beats organization. Diagram brand theming, exports and decks all resolve through this cascade. Pass brandKitId:null to clear. Auth: org owner/admin.
|
|
3862
3865
|
*/
|
|
3863
3866
|
post: operations["setDefaultBrandKit"];
|
|
3864
3867
|
delete?: never;
|
|
@@ -3878,7 +3881,7 @@ export interface paths {
|
|
|
3878
3881
|
put?: never;
|
|
3879
3882
|
/**
|
|
3880
3883
|
* updateOrgFeatureFlags
|
|
3881
|
-
* @description Toggle feature
|
|
3884
|
+
* @description Toggle organisation feature modules (plans, improvements, compliance, knowledge_graph, documents, meeting_scribe). Auth: can_admin_org + org admin. Rate limit 30/min. A flag can only be ENABLED when the feature is available to the organisation — included in its plan (knowledge_graph and compliance need Enterprise, meeting_scribe needs Pro or Enterprise) or granted by a platform administrator. Disabling is always allowed. Disabled modules hide their tools and app pages.
|
|
3882
3885
|
*/
|
|
3883
3886
|
post: operations["updateOrgFeatureFlags"];
|
|
3884
3887
|
delete?: never;
|
|
@@ -6364,7 +6367,7 @@ export interface operations {
|
|
|
6364
6367
|
align?: "left" | "center" | "right";
|
|
6365
6368
|
/** @description Caption below the diagram. */
|
|
6366
6369
|
caption?: string;
|
|
6367
|
-
/** @description Insert after this line
|
|
6370
|
+
/** @description Insert after this line, counting the SAME line numbers getDocument prints (1-based; frontmatter is not counted, and every diagram/image marker counts as exactly one line). 0 inserts at the very beginning; omit it to append at the end. Re-read with getDocument if the document may have changed, since the number is positional. */
|
|
6368
6371
|
afterLine?: number;
|
|
6369
6372
|
/** @description BPMN only. Color plan: { byElementId: { ElementId: SwatchName } }. */
|
|
6370
6373
|
colorPlan?: {
|
|
@@ -6387,6 +6390,10 @@ export interface operations {
|
|
|
6387
6390
|
imageScale?: 1 | 2 | 3;
|
|
6388
6391
|
/** @description Background for the returned png/jpeg (e.g. '#ffffff' or 'transparent'). */
|
|
6389
6392
|
imageBackground?: string;
|
|
6393
|
+
/** @description Brand theming is ON BY DEFAULT: the document's effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram DSL before it is validated, rendered and stored, so the diagram is on-brand everywhere it appears (cascade: brandKitId override → project default → workspace default → org default → the built-in Stable Baseline theme). Set false to keep the library's stock styling. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic — other types (incl. bpmn, which has colorPlan) are always stored unchanged. Author theming in the DSL wins (an existing mermaid %%{init}%%, plantuml !theme, d2 vars.d2-config, or a hand-written infographic palette is never overridden). The stored diagramCode is the THEMED source. */
|
|
6394
|
+
applyBrandTheme?: boolean;
|
|
6395
|
+
/** @description Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation. */
|
|
6396
|
+
brandKitId?: string;
|
|
6390
6397
|
};
|
|
6391
6398
|
};
|
|
6392
6399
|
};
|
|
@@ -6483,6 +6490,10 @@ export interface operations {
|
|
|
6483
6490
|
align?: "left" | "center" | "right";
|
|
6484
6491
|
/** @description New caption. */
|
|
6485
6492
|
caption?: string;
|
|
6493
|
+
/** @description Brand theming is ON BY DEFAULT when diagramCode is provided: the document's effective BRAND KIT is baked into the new DSL before it is validated, rendered and stored. Set false to keep the library's stock styling. Same cascade + themable types + author-wins guards as insertDiagramInDocument. The stored diagramCode is the THEMED source. */
|
|
6494
|
+
applyBrandTheme?: boolean;
|
|
6495
|
+
/** @description Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation. */
|
|
6496
|
+
brandKitId?: string;
|
|
6486
6497
|
/** @description BPMN only. Updated color plan. Set to null to remove. */
|
|
6487
6498
|
colorPlan?: {
|
|
6488
6499
|
/** @description Map of element IDs to color swatch names. */
|
|
@@ -7146,7 +7157,7 @@ export interface operations {
|
|
|
7146
7157
|
brandKitId?: string;
|
|
7147
7158
|
/** @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'). Anything above the 30-slide maximum is reduced to 30 and the reduction is stated back in the response. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12). */
|
|
7148
7159
|
slideCount?: number;
|
|
7149
|
-
/** @description
|
|
7160
|
+
/** @description Deprecated and ignored. Still accepted so existing callers do not break; passing it changes nothing. */
|
|
7150
7161
|
imageCount?: number;
|
|
7151
7162
|
/** @description Optional, OFF by default. Build the deck with ADVANCED DECK BUILDING: instead of one composer pass, the deck is redrafted and reviewed over several rounds by a panel of design, brand, accessibility and copy reviewers, each round scoring the deck and listing what must be fixed. It usually produces a higher-quality deck, but it is not a guarantee. TIME: a standard build takes roughly 2 to 8 minutes; advanced deck building takes roughly 15 to 20 minutes. COST: 15 extra credits per depth level on top of the turn fee, so the default depth of 3 adds 45 credits and makes a 50-credit build cost 95. This is the user's deliberate choice, so only switch it on when they have asked for the best possible deck and accepted the wait and the cost. Quote the turn FIRST (call without confirm) so the user sees the real total before approving. Set it once and it is remembered for the rest of the conversation; pass false to turn it off again. */
|
|
7152
7163
|
advancedDeckBuilding?: boolean;
|
|
@@ -7451,10 +7462,10 @@ export interface operations {
|
|
|
7451
7462
|
*/
|
|
7452
7463
|
kind?: "deck";
|
|
7453
7464
|
/**
|
|
7454
|
-
* @description Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one
|
|
7465
|
+
* @description Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one image per slide. HTML is not available.
|
|
7455
7466
|
* @enum {string}
|
|
7456
7467
|
*/
|
|
7457
|
-
format?: "pptx" | "pdf" | "png"
|
|
7468
|
+
format?: "pptx" | "pdf" | "png";
|
|
7458
7469
|
/** @description Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary). */
|
|
7459
7470
|
brandKitId?: string;
|
|
7460
7471
|
};
|
|
@@ -7894,6 +7905,12 @@ export interface operations {
|
|
|
7894
7905
|
content: {
|
|
7895
7906
|
"application/json": {
|
|
7896
7907
|
projectId: string;
|
|
7908
|
+
/** @description Grep across title and friendlyId. Substring by default; a regular expression when isRegex is true. */
|
|
7909
|
+
query?: string;
|
|
7910
|
+
/** @description Treat `query` as a regular expression. */
|
|
7911
|
+
isRegex?: boolean;
|
|
7912
|
+
/** @description Match case exactly. Default false. */
|
|
7913
|
+
caseSensitive?: boolean;
|
|
7897
7914
|
};
|
|
7898
7915
|
};
|
|
7899
7916
|
};
|
|
@@ -8566,6 +8583,10 @@ export interface operations {
|
|
|
8566
8583
|
align?: "left" | "center" | "right";
|
|
8567
8584
|
/** @description Element id of an EXISTING embedded diagram to re-render and replace in place (keeps the element id + board position). Omit for a fresh insert. If the id is not on the board, a new element is created with it. */
|
|
8568
8585
|
updateElementId?: string;
|
|
8586
|
+
/** @description Brand theming is ON BY DEFAULT: the board's effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram before it is rendered and its editable source stored (cascade: brandKitId override → project → workspace → org default → the built-in Stable Baseline theme). Set false to keep the library's stock styling. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic; author theming in the DSL always wins. */
|
|
8587
|
+
applyBrandTheme?: boolean;
|
|
8588
|
+
/** @description Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation. */
|
|
8589
|
+
brandKitId?: string;
|
|
8569
8590
|
/**
|
|
8570
8591
|
* @description When 'contain' AND both width and height are given, treat width/height as a BOUNDING BOX: the diagram is scaled to its natural aspect ratio to fit inside the box (never upscaled past 1.5x natural) and centred, so it never stretches. The response's diagram.{x,y,width,height} carry the final drawn geometry. Omit for the exact width/height behaviour.
|
|
8571
8592
|
* @enum {string}
|
|
@@ -9149,6 +9170,12 @@ export interface operations {
|
|
|
9149
9170
|
scale?: 1 | 2 | 3;
|
|
9150
9171
|
/** @description Background for png/jpeg, e.g. '#ffffff' or 'transparent' (png only). */
|
|
9151
9172
|
background?: string;
|
|
9173
|
+
/** @description Brand theming is ON BY DEFAULT: the effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram before rendering (cascade: brandKitId override → project default → workspace default → org default → the built-in Stable Baseline theme). Set false to render with the library's stock styling instead. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic — other types always render unchanged. Author theming in the DSL wins (an existing mermaid %%{init}%%, plantuml !theme, d2 vars.d2-config, or a hand-written infographic palette is never overridden). */
|
|
9174
|
+
applyBrandTheme?: boolean;
|
|
9175
|
+
/** @description Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation. */
|
|
9176
|
+
brandKitId?: string;
|
|
9177
|
+
/** @description Optional project UUID used to resolve the project → workspace → org brand-kit cascade. Without it the built-in Stable Baseline brand themes the render. */
|
|
9178
|
+
projectId?: string;
|
|
9152
9179
|
};
|
|
9153
9180
|
};
|
|
9154
9181
|
};
|
|
@@ -9791,7 +9818,7 @@ export interface operations {
|
|
|
9791
9818
|
width?: number;
|
|
9792
9819
|
/** @description Height in pixels. */
|
|
9793
9820
|
height?: number;
|
|
9794
|
-
/** @description Insert after this line (0
|
|
9821
|
+
/** @description Insert after this line, counting the SAME line numbers getDocument prints (1-based; frontmatter is not counted, and every diagram/image marker counts as exactly one line). 0 inserts at the very beginning; omit it to append at the end. Re-read with getDocument if the document may have changed, since the number is positional. */
|
|
9795
9822
|
afterLine?: number;
|
|
9796
9823
|
/** @description Alt text. Defaults to caption. */
|
|
9797
9824
|
alt?: string;
|
|
@@ -9983,6 +10010,8 @@ export interface operations {
|
|
|
9983
10010
|
"application/json": {
|
|
9984
10011
|
/** @description Image ID from IMAGE_OMITTED markers. */
|
|
9985
10012
|
imageId: string;
|
|
10013
|
+
/** @description Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.) */
|
|
10014
|
+
versionTimestamp?: number;
|
|
9986
10015
|
};
|
|
9987
10016
|
};
|
|
9988
10017
|
};
|
|
@@ -11943,18 +11972,16 @@ export interface operations {
|
|
|
11943
11972
|
requestBody?: {
|
|
11944
11973
|
content: {
|
|
11945
11974
|
"application/json": {
|
|
11946
|
-
/** @description Search query — a name fragment or a friendly id. */
|
|
11975
|
+
/** @description Search query — meaning, a name fragment, or a friendly id (e.g. "IMP-2", "TAS-7"). */
|
|
11947
11976
|
query: string;
|
|
11948
|
-
/** @description
|
|
11949
|
-
types?: ("
|
|
11977
|
+
/** @description Narrow to one kind. Omit (or pass both) to search improvements and tasks together. Other artefact types are NOT accepted here — use kg_search with artefactMetadataOnly:true for those. */
|
|
11978
|
+
types?: ("improvement" | "task")[];
|
|
11950
11979
|
/** @description Limit to a project. */
|
|
11951
11980
|
projectId?: string;
|
|
11952
11981
|
/** @description Limit to a workspace. */
|
|
11953
11982
|
workspaceId?: string;
|
|
11954
|
-
/** @description Max results (default 20
|
|
11983
|
+
/** @description Max results (default 20, max 50). */
|
|
11955
11984
|
limit?: number;
|
|
11956
|
-
/** @description Pagination offset (cross-artefact mode). */
|
|
11957
|
-
offset?: number;
|
|
11958
11985
|
};
|
|
11959
11986
|
};
|
|
11960
11987
|
};
|
|
@@ -14715,8 +14742,17 @@ export interface operations {
|
|
|
14715
14742
|
requestBody?: {
|
|
14716
14743
|
content: {
|
|
14717
14744
|
"application/json": {
|
|
14718
|
-
/** @description Natural-language query. Required for local/global/ppr; optional for graph (use srcEntityId instead). */
|
|
14745
|
+
/** @description Natural-language query. Required for local/global/ppr; optional for graph (use srcEntityId instead). With artefactMetadataOnly:true this is the artefact name, friendly id or uuid to find. */
|
|
14719
14746
|
query?: string;
|
|
14747
|
+
/**
|
|
14748
|
+
* @description Find artefacts BY NAME/ID instead of retrieving knowledge. Matches title + friendly id + uuid only — never document content — across all artefact types, and does not require the knowledge graph to be enabled. Default false.
|
|
14749
|
+
* @default false
|
|
14750
|
+
*/
|
|
14751
|
+
artefactMetadataOnly?: boolean;
|
|
14752
|
+
/** @description Only with artefactMetadataOnly:true. Restrict the search to these artefact types. Omit to search all of them. Unknown values are rejected rather than ignored. */
|
|
14753
|
+
artefactTypes?: ("document" | "whiteboard" | "improvement" | "task" | "plan" | "compliance")[];
|
|
14754
|
+
/** @description Only with artefactMetadataOnly:true. Skip this many results for paging. */
|
|
14755
|
+
offset?: number;
|
|
14720
14756
|
/**
|
|
14721
14757
|
* @description Retrieval strategy. See tool description for when to use each — strongly prefer 'global' for thematic/overview questions.
|
|
14722
14758
|
* @default local
|
|
@@ -21247,7 +21283,7 @@ export interface operations {
|
|
|
21247
21283
|
logoUrl?: string;
|
|
21248
21284
|
/** @description URL of an existing .pptx or .docx to extract the brand from (theme colours + fonts + logo + watermark + embedded fonts). Max 25MB. Omit if passing logoUrl or tokens. */
|
|
21249
21285
|
officeUrl?: string;
|
|
21250
|
-
/** @description Explicit DTCG brand tokens { color:{brand:{primary,primaryText,ink,bg,surface,muted,border,positive,warning,negative}}, font:{heading,body} }. Omit to extract from logoUrl/officeUrl. */
|
|
21286
|
+
/** @description Explicit DTCG brand tokens { color:{brand:{primary,primaryText,ink,bg,surface,muted,border,positive,warning,negative,accentHover?,accentActive?}}, font:{heading,body} }. EXTENDED CAPTURE (all optional; captured values replace derivation heuristics in deck/document theming): structure:{typeScalePx:[..], leadingBody, leadingTight, trackingDisplayEm, spacingPx:[..], radiusPx:{sm,md,lg}, elevation:'flat'|'ring'|'soft'|'raised'}, motion:{speed:'snappy'|'standard'|'stately', easing:'cubic-bezier(..)'}, voice:{tone, notes}, imagery:{style, notes}, antiPatterns:['never ..']. Omit tokens entirely to extract from logoUrl/officeUrl. */
|
|
21251
21287
|
tokens?: {
|
|
21252
21288
|
[key: string]: unknown;
|
|
21253
21289
|
};
|
|
@@ -21424,8 +21460,8 @@ export interface operations {
|
|
|
21424
21460
|
content: {
|
|
21425
21461
|
"application/json": {
|
|
21426
21462
|
/** @enum {string} */
|
|
21427
|
-
scope: "organization" | "workspace" | "project";
|
|
21428
|
-
/** @description The org/workspace/project id for the chosen scope. */
|
|
21463
|
+
scope: "organization" | "workspace" | "project" | "folder" | "document";
|
|
21464
|
+
/** @description The org/workspace/project/folder/document id for the chosen scope. */
|
|
21429
21465
|
scopeId: string;
|
|
21430
21466
|
/** @description Brand kit to make default, or null to clear. */
|
|
21431
21467
|
brandKitId?: string | null;
|
|
@@ -21516,6 +21552,7 @@ export interface operations {
|
|
|
21516
21552
|
compliance?: boolean;
|
|
21517
21553
|
knowledge_graph?: boolean;
|
|
21518
21554
|
documents?: boolean;
|
|
21555
|
+
meeting_scribe?: boolean;
|
|
21519
21556
|
};
|
|
21520
21557
|
};
|
|
21521
21558
|
};
|