lucid-extension-sdk 0.0.213 → 0.0.215

package/commandtypes.d.ts

@@ -77,6 +77,7 @@ export declare const enum CommandName {
     GetRelativeLinePosition = "grlp",
     GetSelection = "gs",
     GetShapeData = "gsd",
+    GetSvg = "gsvg",
     GetTextStyle = "gts",
     GetUserId = "guid",
     GetVisibleRect = "gvr",
@@ -369,6 +370,10 @@ export type CommandArgs = {
         query: GetShapeDataQuery;
         result: GetShapeDataResult;
     };
+    [CommandName.GetSvg]: {
+        query: GetSvgQuery;
+        result: GetSvgResult;
+    };
     [CommandName.GetTextStyle]: {
         query: GetTextStyleQuery;
         result: GetTextStyleResult;
@@ -1097,6 +1102,17 @@ export type GetShapeDataQuery = {
     'n': string;
 };
 export type GetShapeDataResult = SerializedFieldType | SerializedDataError;
+export type GetSvgQuery = {
+    /** Page ID to get an image of */
+    'p': string;
+    /** True to include the background of the page */
+    'bg': boolean;
+    /** If specified, the bounding box specifying what portion of the page to show */
+    'bb'?: Box | undefined;
+    /** If specified, only include these item IDs */
+    'i'?: string[] | undefined;
+};
+export type GetSvgResult = Promise<string>;
 export type GetTextStyleQuery = {
     /** ID of the element to get text style from */
     'id': string;

package/commandtypes.js

@@ -55,6 +55,7 @@ exports.commandTitles = new Map([
     ["grlp" /* CommandName.GetRelativeLinePosition */, 'GetRelativeLinePosition'],
     ["gs" /* CommandName.GetSelection */, 'GetSelection'],
     ["gsd" /* CommandName.GetShapeData */, 'GetShapeData'],
+    ["gsvg" /* CommandName.GetSvg */, 'GetSvg'],
     ["gts" /* CommandName.GetTextStyle */, 'GetTextStyle'],
     ["guid" /* CommandName.GetUserId */, 'GetUserId'],
     ["gvr" /* CommandName.GetVisibleRect */, 'GetVisibleRect'],

package/core/checks.d.ts

@@ -98,6 +98,10 @@ export declare function isArray(val: unknown): val is unknown[];
  * @return Whether variable is an array of the given type.
  */
 export declare function isTypedArray<T>(typeGuard: (a: unknown) => a is T): (val: unknown) => val is T[];
+export type Tuple<T, N extends number> = N extends N ? (number extends N ? T[] : TupleOfHelper<T, N, []>) : never;
+type TupleOfHelper<T, N extends number, R extends unknown[]> = R['length'] extends N ? R : TupleOfHelper<T, N, [T, ...R]>;
+export declare function isExactLength<T, N extends number>(arr: T[], exactLength: N): arr is Tuple<T, N>;
+export declare function isAtLeastLength<T, N extends number>(arr: T[], minimumLength: N): arr is [...Tuple<T, N>, ...T[]];
 /**
  * Returns true if the specified object is either empty or all existing keys map to a nullish value
  *

package/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isAtLeastLength = exports.isExactLength = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -154,6 +154,14 @@ function isTypedArray(typeGuard) {
     };
 }
 exports.isTypedArray = isTypedArray;
+function isExactLength(arr, exactLength) {
+    return arr.length === exactLength;
+}
+exports.isExactLength = isExactLength;
+function isAtLeastLength(arr, minimumLength) {
+    return arr.length >= minimumLength;
+}
+exports.isAtLeastLength = isAtLeastLength;
 /**
  * Returns true if the specified object is either empty or all existing keys map to a nullish value
  *

package/document/itemproxy.d.ts

@@ -43,6 +43,10 @@ export declare class ItemProxy extends ElementProxy {
      * @param bb The bounding box to attempt to make this item fill
      */
     setBoundingBox(bb: Box): void;
+    /**
+     * @returns The ID of the page containing this item
+     */
+    getPageId(): string;
     /**
      * @returns The page containing this item
      */

package/document/itemproxy.js

@@ -71,11 +71,17 @@ class ItemProxy extends elementproxy_1.ElementProxy {
             });
         }
     }
+    /**
+     * @returns The ID of the page containing this item
+     */
+    getPageId() {
+        return this.client.sendCommand("gip" /* CommandName.GetItemPageId */, this.id);
+    }
     /**
      * @returns The page containing this item
      */
     getPage() {
-        return this.client.getPageProxy(this.client.sendCommand("gip" /* CommandName.GetItemPageId */, this.id));
+        return this.client.getPageProxy(this.getPageId());
     }
     /**
      * @returns The x/y location of this item

package/document/pageproxy.d.ts

@@ -118,4 +118,12 @@ export declare class PageProxy extends ElementProxy {
         prompt: string;
         idToLucidId: Map<string, string>;
     };
+    /**
+     *
+     * @param items If specified, only include these items in the resulting SVG
+     * @param includeBackground If true, include the background of the page in the SVG. Otherwise the background is transparent.
+     * @param viewBox If specified, crop the resulting SVG to the specified bounding box in page coordinates
+     * @returns A promise resolving to an SVG string
+     */
+    getSvg(items?: ItemProxy[], includeBackground?: boolean, viewBox?: Box): import("../commandtypes").GetSvgResult;
 }

package/document/pageproxy.js

@@ -192,5 +192,20 @@ class PageProxy extends elementproxy_1.ElementProxy {
             idToLucidId: new Map(Object.entries(result['id'])),
         };
     }
+    /**
+     *
+     * @param items If specified, only include these items in the resulting SVG
+     * @param includeBackground If true, include the background of the page in the SVG. Otherwise the background is transparent.
+     * @param viewBox If specified, crop the resulting SVG to the specified bounding box in page coordinates
+     * @returns A promise resolving to an SVG string
+     */
+    getSvg(items, includeBackground = false, viewBox) {
+        return this.client.sendCommand("gsvg" /* CommandName.GetSvg */, {
+            'p': this.id,
+            'bb': viewBox,
+            'bg': includeBackground,
+            'i': items === null || items === void 0 ? void 0 : items.map((item) => item.id),
+        });
+    }
 }
 exports.PageProxy = PageProxy;

package/package.json

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