lucid-extension-sdk 0.0.197 → 0.0.199

package/commandtypes.d.ts

@@ -19,6 +19,8 @@ import { PanelLocation } from './ui/panel';
  * exposed through appropriate classes and methods elsewhere in this SDK.
  *
  * To use these directly, use [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand).
+ *
+ * IMPORTANT - Before you add a new command bring it up in #api-committee to get feedback
  */
 export declare const enum CommandName {
     AddCardIntegration = "aci",
@@ -101,6 +103,7 @@ export declare const enum CommandName {
     ListTextAreas = "lta",
     LoadBlockClasses = "lbc",
     LogForTestCase = "log",
+    MeasureText = "mt",
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     Prompt = "p",
@@ -142,6 +145,8 @@ export declare const commandTitles: Map<CommandName, string>;
  * This is a type declaration whose purpose is to allow TypeScript to enforce the correct parameter and
  * return types from [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand) based on
  * which command name you pass in as the first parameter.
+ *
+ * IMPORTANT - Before you add a new command bring it up in #api-committee to get feedback
  */
 export type CommandArgs = {
     [CommandName.AddCardIntegration]: {
@@ -464,6 +469,10 @@ export type CommandArgs = {
         query: JsonSerializable;
         result: JsonSerializable;
     };
+    [CommandName.MeasureText]: {
+        query: MeasureTextQuery;
+        result: MeasureTextResult;
+    };
     [CommandName.OffsetItems]: {
         query: OffsetItemsQuery;
         result: OffsetItemsResult;
@@ -1163,6 +1172,20 @@ export type ListTextAreasQuery = string;
 export type ListTextAreasResult = string[];
 export type LoadBlockClassesQuery = string[];
 export type LoadBlockClassesResult = Promise<undefined>;
+export type MeasureTextQuery = {
+    /** ID of the element to measure text area */
+    'id': string;
+    /** Name of the text area to measure */
+    'n': string;
+    /** Max width for giving text area*/
+    'w': number;
+};
+export type MeasureTextResult = {
+    /** Text area width */
+    'w': number;
+    /** Text area height */
+    'h': number;
+};
 export type OffsetItemsQuery = {
     /** IDs of the items (blocks, lines, groups) to move */
     'ids': string[];

package/commandtypes.js

@@ -81,6 +81,7 @@ exports.commandTitles = new Map([
     ["lta" /* CommandName.ListTextAreas */, 'ListTextAreas'],
     ["lbc" /* CommandName.LoadBlockClasses */, 'LoadBlockClasses'],
     ["log" /* CommandName.LogForTestCase */, 'LogForTestCase'],
+    ["mt" /* CommandName.MeasureText */, 'MeasureText'],
     ["oi" /* CommandName.OffsetItems */, 'OffsetItems'],
     ["pdi" /* CommandName.PatchDataItems */, 'PatchDataItems'],
     ["p" /* CommandName.Prompt */, 'Prompt'],

package/document/itemproxy.d.ts

@@ -65,6 +65,14 @@ export declare class ItemProxy extends ElementProxy {
      * @param offset The amount to offset
      */
     offset(type: LinearOffsetType, offset: Point): void;
+    /**
+     * Measure the amount of space necessary to render the text in the given text area, given a
+     * width to measure that text within.
+     * @param name Name of the text area whose content we should measure
+     * @param maxWidth Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.
+     * @returns The size of rectangle necessary to render this text area's content.
+     */
+    measureText(name: string, maxWidth: number): import("../commandtypes").MeasureTextResult;
     /**
      * Delete this item from the document
      */

package/document/itemproxy.js

@@ -102,6 +102,16 @@ class ItemProxy extends elementproxy_1.ElementProxy {
     offset(type, offset) {
         this.client.sendCommand("oi" /* CommandName.OffsetItems */, { 'ids': [this.id], 't': type, 'o': offset });
     }
+    /**
+     * Measure the amount of space necessary to render the text in the given text area, given a
+     * width to measure that text within.
+     * @param name Name of the text area whose content we should measure
+     * @param maxWidth Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.
+     * @returns The size of rectangle necessary to render this text area's content.
+     */
+    measureText(name, maxWidth) {
+        return this.client.sendCommand("mt" /* CommandName.MeasureText */, { 'id': this.id, 'n': name, 'w': maxWidth });
+    }
     /**
      * Delete this item from the document
      */

package/package.json

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