lucid-extension-sdk 0.0.240 → 0.0.242

package/commandtypes.d.ts

@@ -112,6 +112,7 @@ export declare const enum CommandName {
     LoadBlockClasses = "lbc",
     LogForTestCase = "log",
     MeasureText = "mt",
+    AddDiagramFromMermaid = "adfm",
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     Prompt = "p",
@@ -514,6 +515,10 @@ export type CommandArgs = {
         query: MeasureTextQuery;
         result: MeasureTextResult;
     };
+    [CommandName.AddDiagramFromMermaid]: {
+        query: AddDiagramFromMermaidQuery;
+        result: AddDiagramFromMermaidResult;
+    };
     [CommandName.OffsetItems]: {
         query: OffsetItemsQuery;
         result: OffsetItemsResult;
@@ -1329,6 +1334,21 @@ export type MeasureTextResult = {
     /** Text area height */
     'h': number;
 };
+export declare enum MermaidDiagramType {
+    FLOWCHART = "flowchart"
+}
+export type AddDiagramFromMermaidQuery = {
+    /** Type of diagram as an enum, e.g., flowchart. */
+    't': MermaidDiagramType;
+    /** A mermaid diagram syntax string, e.g., flowchart TD\nA --> B */
+    'm': string;
+    /** The point on the canvas for placing the diagram */
+    'o'?: Point | undefined;
+    /** If true, place the diagram exactly at the point. Otherwise, place it in open space near the point. */
+    'e'?: boolean | undefined;
+};
+/** A list of shape ids that represent the mermaid diagram. Empty if the rendering fails. */
+export type AddDiagramFromMermaidResult = Promise<string[]>;
 export type OffsetItemsQuery = {
     /** IDs of the items (blocks, lines, groups) to move */
     'ids': string[];

package/commandtypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
 /** @ignore */
 exports.commandTitles = new Map([
@@ -90,6 +90,7 @@ exports.commandTitles = new Map([
     ["lbc" /* CommandName.LoadBlockClasses */, 'LoadBlockClasses'],
     ["log" /* CommandName.LogForTestCase */, 'LogForTestCase'],
     ["mt" /* CommandName.MeasureText */, 'MeasureText'],
+    ["adfm" /* CommandName.AddDiagramFromMermaid */, 'AddDiagramFromMermaid'],
     ["oi" /* CommandName.OffsetItems */, 'OffsetItems'],
     ["pdi" /* CommandName.PatchDataItems */, 'PatchDataItems'],
     ["p" /* CommandName.Prompt */, 'Prompt'],
@@ -151,6 +152,22 @@ var GetLLMContextType;
      * */
     GetLLMContextType[GetLLMContextType["RelationalWithoutExpansion"] = 3] = "RelationalWithoutExpansion";
 })(GetLLMContextType || (exports.GetLLMContextType = GetLLMContextType = {}));
+var MermaidDiagramType;
+(function (MermaidDiagramType) {
+    MermaidDiagramType["FLOWCHART"] = "flowchart";
+    // The following types are not yet supported.
+    // SEQUENCE_DIAGRAM = 'sequence_diagram',
+    // CLASS_DIAGRAM = 'class_diagram',
+    // STATE_DIAGRAM = 'state_diagram',
+    // ERD = 'erd',
+    // USER_JOURNEY = 'user_journey',
+    // GANTT = 'gantt',
+    // PIECHART = 'piechart',
+    // MINDMAP = 'mindmap',
+    // REQUIREMENT_DIAGRAM = 'requirement_diagram',
+    // GITGRAPH = 'gitgraph',
+    // TIMELINE = 'timeline',
+})(MermaidDiagramType || (exports.MermaidDiagramType = MermaidDiagramType = {}));
 function isRawSendXHRResponse(val) {
     return (0, checks_1.isString)(val['url']) && (0, checks_1.isString)(val['t']) && (0, checks_1.isNumber)(val['s']) && (0, checks_1.isObject)(val['h']);
 }

package/document/pageproxy.d.ts

@@ -1,6 +1,6 @@
-import { GetItemsAtSearchType, GetLLMContextType } from '../commandtypes';
+import { GetItemsAtSearchType, GetLLMContextType, MermaidDiagramType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
-import { Box } from '../math';
+import { Box, Point } from '../math';
 import { BlockDefinition } from './blockdefinition';
 import { BlockProxy } from './blockproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
@@ -98,6 +98,21 @@ export declare class PageProxy extends ElementProxy {
      * @returns The added image
      */
     addImage(def: ImageDefinition): Promise<BlockProxy>;
+    /**
+     * Add a diagram described by Mermaid markup to this page.
+     *
+     * See https://mermaid.js.org/intro/syntax-reference.html for information on Mermaid markup syntax.
+     *
+     * @param diagramType The type of the diagram. Note that this is redundant because the Mermaid markup also contains
+     *                         the diagram type.
+     * @param mermaid Mermaid markup text describing the diagram to add.
+     * @param origin Where to place the diagram on the page. If absent some free
+     *                  space within or near the current viewport is automatically chosen.
+     * @param exactPlacement If true and if origin is specified, places the diagram exactly at the specified origin
+     *                          instead of trying to find free space.
+     * @returns An array of the proxies for all the objects in the added diagram.
+     */
+    addDiagramFromMermaid(diagramType: MermaidDiagramType, mermaid: string, origin?: Point, exactPlacement?: boolean): Promise<(BlockProxy | LineProxy | GroupProxy)[]>;
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/document/pageproxy.js

@@ -151,6 +151,28 @@ class PageProxy extends elementproxy_1.ElementProxy {
         await this.client.loadBlockClasses(['UserImage2Block']);
         return this.addBlock((0, imagedefinition_1.imageToBlockDefinition)(def));
     }
+    /**
+     * Add a diagram described by Mermaid markup to this page.
+     *
+     * See https://mermaid.js.org/intro/syntax-reference.html for information on Mermaid markup syntax.
+     *
+     * @param diagramType The type of the diagram. Note that this is redundant because the Mermaid markup also contains
+     *                         the diagram type.
+     * @param mermaid Mermaid markup text describing the diagram to add.
+     * @param origin Where to place the diagram on the page. If absent some free
+     *                  space within or near the current viewport is automatically chosen.
+     * @param exactPlacement If true and if origin is specified, places the diagram exactly at the specified origin
+     *                          instead of trying to find free space.
+     * @returns An array of the proxies for all the objects in the added diagram.
+     */
+    async addDiagramFromMermaid(diagramType, mermaid, origin, exactPlacement) {
+        return (await this.client.sendCommand("adfm" /* CommandName.AddDiagramFromMermaid */, {
+            't': diagramType,
+            'm': mermaid,
+            'o': origin,
+            'e': exactPlacement,
+        })).map((id) => this.client.getItemProxy(id));
+    }
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/interop.d.ts

@@ -48,8 +48,25 @@ declare interface I18nFormattedNumberParams {
 
 declare class I18nFormattedNumber {}
 
+declare enum ListStyles {
+    LONG = 'long',
+    SHORT = 'short',
+    NARROW = 'narrow',
+}
+declare enum ListTypes {
+    AND = 'conjunction',
+    OR = 'disjunction',
+    UNIT_LIST = 'unit',
+}
+declare type FormattedListParams = {
+    style: ListStyles;
+    type: ListTypes;
+};
+
+declare class I18nFormattedList {}
+
 declare interface I18nReplacement {
-    [s: string]: number | string | I18nSafeString | I18nFormattedNumber;
+    [s: string]: number | string | string[] | I18nSafeString | I18nFormattedNumber | I18nFormattedList;
 }
 
 declare namespace i18n {
@@ -58,4 +75,5 @@ declare namespace i18n {
     function getLanguage(): string;
     function getInLocale(locale: string, key: string, replacements?: I18nReplacement, wrappers?: string[]): string;
     function formatNumber(value: number, params: I18nFormattedNumberParams): I18nFormattedNumber;
+    function formatList(value: string[], params?: I18nFormattedListParams): I18nFormattedList;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.240",
+    "version": "0.0.242",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",