lucid-extension-sdk 0.0.19 → 0.0.27

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -23,6 +23,7 @@ export declare const enum CommandName {
     Alert = "a",
     AnimateViewport = "av",
     Bootstrap = "b",
+    CancelDragBlockToCanvas = "cdc",
     Confirm = "c",
     CreateBlock = "cb",
     CreateCollection = "cc",
@@ -30,6 +31,7 @@ export declare const enum CommandName {
     CreateLine = "cl",
     CreatePage = "cp",
     DataAction = "da",
+    DataItemExists = "die",
     DeleteItem = "di",
     DeletePage = "dp",
     DeleteShapeData = "dsd",
@@ -81,6 +83,7 @@ export declare const enum CommandName {
     ShowModal = "sm",
     ShowPanel = "spn",
     SleepForTestCase = "sleep",
+    StartDragBlockToCanvas = "sdc",
     ThrowForTestCase = "throw",
     UnhookCreateItems = "uci",
     UnhookSelection = "us",
@@ -118,6 +121,10 @@ export declare type CommandArgs = {
         query: BootstrapQuery;
         result: BootstrapResult;
     };
+    [CommandName.CancelDragBlockToCanvas]: {
+        query: CancelDragBlockToCanvasQuery;
+        result: CancelDragBlockToCanvasResult;
+    };
     [CommandName.Confirm]: {
         query: ConfirmQuery;
         result: ConfirmResult;
@@ -146,6 +153,10 @@ export declare type CommandArgs = {
         query: DataActionQuery;
         result: DataActionResult;
     };
+    [CommandName.DataItemExists]: {
+        query: DataItemExistsQuery;
+        result: DataItemExistsResult;
+    };
     [CommandName.DeleteItem]: {
         query: DeleteItemQuery;
         result: DeleteItemResult;
@@ -350,6 +361,10 @@ export declare type CommandArgs = {
         query: SleepForTestCaseQuery;
         result: SleepForTestCaseResult;
     };
+    [CommandName.StartDragBlockToCanvas]: {
+        query: StartDragBlockToCanvasQuery;
+        result: StartDragBlockToCanvasResult;
+    };
     [CommandName.ThrowForTestCase]: {
         query: ThrowForTestCaseQuery;
         result: ThrowForTestCaseResult;
@@ -432,8 +447,14 @@ export declare type BootstrapQuery = {
      * the result of the callback, the bootstrap data is cleared.
      */
     'c': string;
+    /**
+     * Marks a document as requiring the editor extension.
+     */
+    'm'?: boolean;
 };
 export declare type BootstrapResult = Promise<void>;
+export declare type CancelDragBlockToCanvasQuery = void;
+export declare type CancelDragBlockToCanvasResult = undefined;
 export declare type ConfirmQuery = {
     /** Title; defaults to extension title */
     't'?: string;
@@ -517,6 +538,13 @@ export declare type RawDataActionResult = {
     'j': unknown;
 });
 export declare type DataActionResult = Promise<RawDataActionResult>;
+export declare type DataItemExistsQuery = {
+    /** Collection ID to check */
+    'c': string;
+    /** Primary key to check */
+    'pk': string;
+};
+export declare type DataItemExistsResult = boolean;
 export declare type DeleteItemQuery = string;
 export declare type DeleteItemResult = boolean;
 export declare type DeletePageQuery = string;
@@ -830,6 +858,22 @@ export declare type ShowPanelQuery = {
 export declare type ShowPanelResult = undefined;
 export declare type SleepForTestCaseQuery = number;
 export declare type SleepForTestCaseResult = Promise<void>;
+export declare type StartDragBlockToCanvasQuery = {
+    /** Class name of the block to create */
+    'c': string;
+    /** Size of the block to create */
+    'sz': {
+        'w': number;
+        'h': number;
+    };
+    /** Additional properties to set on the block being dragged */
+    'p': {
+        [key: string]: JsonSerializable;
+    };
+    /** If specified, the stencil for a custom shape. Only valid if the class name is 'CustomBlock' */
+    's'?: JsonSerializable | undefined;
+};
+export declare type StartDragBlockToCanvasResult = Promise<string | undefined>;
 export declare type ThrowForTestCaseQuery = number;
 export declare type ThrowForTestCaseResult = undefined | Promise<void>;
 export declare type UnhookCreateItemsQuery = {

package/sdk/commandtypes.js

@@ -10,12 +10,14 @@ exports.commandTitles = new Map([
     ["a" /* Alert */, 'Alert'],
     ["av" /* AnimateViewport */, 'AnimateViewport'],
     ["b" /* Bootstrap */, 'Bootstrap'],
+    ["cdc" /* CancelDragBlockToCanvas */, 'CancelDragBlockToCanvas'],
     ["c" /* Confirm */, 'Confirm'],
     ["cb" /* CreateBlock */, 'CreateBlock'],
     ["cc" /* CreateCollection */, 'CreateCollection'],
     ["cds" /* CreateDataSource */, 'CreateDataSource'],
     ["cl" /* CreateLine */, 'CreateLine'],
     ["cp" /* CreatePage */, 'CreatePage'],
+    ["die" /* DataItemExists */, 'DataItemExists'],
     ["di" /* DeleteItem */, 'DeleteItem'],
     ["dp" /* DeletePage */, 'DeletePage'],
     ["dsd" /* DeleteShapeData */, 'DeleteShapeData'],
@@ -67,6 +69,7 @@ exports.commandTitles = new Map([
     ["sm" /* ShowModal */, 'ShowModal'],
     ["spn" /* ShowPanel */, 'ShowPanel'],
     ["sleep" /* SleepForTestCase */, 'SleepForTestCase'],
+    ["sdc" /* StartDragBlockToCanvas */, 'StartDragBlockToCanvas'],
     ["throw" /* ThrowForTestCase */, 'ThrowForTestCase'],
     ["uci" /* UnhookCreateItems */, 'UnhookCreateItems'],
     ["us" /* UnhookSelection */, 'UnhookSelection'],

package/sdk/core/checks.js

@@ -160,6 +160,6 @@ function isUnknown(val) {
 }
 exports.isUnknown = isUnknown;
 function isPromise(val) {
-    return isObject(val) && isFunction(val.then) && isFunction(val.catch);
+    return isObject(val) && isFunction(val['then']) && isFunction(val['catch']);
 }
 exports.isPromise = isPromise;

package/sdk/core/data/serializedfield/serializedfields.js

@@ -7,7 +7,7 @@ function isSerializedColorObjectFieldType(value) {
 }
 exports.isSerializedColorObjectFieldType = isSerializedColorObjectFieldType;
 function isSerializedLucidDictionary(value) {
-    return (0, checks_1.isObject)(value) && Object.values(value).every(isSerializedFieldType);
+    return (0, checks_1.isObject)(value) && (0, checks_1.isObject)(value['dict']) && Object.values(value['dict']).every(isSerializedFieldType);
 }
 exports.isSerializedLucidDictionary = isSerializedLucidDictionary;
 function isSerializedLucidCurrency(value) {

package/sdk/core/properties/datagraphic/badgeposition.d.ts

@@ -0,0 +1,59 @@
+export declare enum HorizontalBadgePos {
+    LEFT = 0,
+    CENTER = 1,
+    RIGHT = 2
+}
+export declare enum VerticalBadgePos {
+    TOP = 0,
+    CENTER = 1,
+    BOTTOM = 2
+}
+export declare enum BadgeLayerPos {
+    INSIDE = 0,
+    EDGE = 1,
+    OUTSIDE = 2
+}
+export declare enum BadgeResponsiveness {
+    STATIC = 0,
+    STACK = 1
+}
+export interface BadgeEnumPosition {
+    horizontalPos: HorizontalBadgePos;
+    verticalPos: VerticalBadgePos;
+    layer: BadgeLayerPos;
+    responsive: BadgeResponsiveness;
+}
+export declare const BadgePositionsClockwise: {
+    horizontalPos: number;
+    verticalPos: number;
+}[];
+export declare type SerializedBadgeEnumPosition = {
+    'horiz'?: HorizontalBadgePos;
+    'vert'?: VerticalBadgePos;
+    'layer'?: BadgeLayerPos;
+    'responsive'?: BadgeResponsiveness;
+};
+export interface Badgeable {
+    position: SerializedBadgeEnumPosition;
+}
+export declare const defaultBadgePosition: {
+    horizontalPos: HorizontalBadgePos;
+    verticalPos: VerticalBadgePos;
+    layer: BadgeLayerPos;
+    responsive: BadgeResponsiveness;
+};
+export declare const defaultBadgePositionSerialized: {
+    horiz: HorizontalBadgePos;
+    vert: VerticalBadgePos;
+    layer: BadgeLayerPos;
+    responsive: BadgeResponsiveness;
+};
+export declare function badgePositionsEqual(a: BadgeEnumPosition, b: BadgeEnumPosition): boolean;
+export declare function deserializeBadgeEnumPosition(serialized?: SerializedBadgeEnumPosition): BadgeEnumPosition;
+export declare function deserializeBadgeEnumPosition(serialized?: SerializedBadgeEnumPosition | null): BadgeEnumPosition | undefined;
+export declare function serializeBadgeEnumPosition(position?: BadgeEnumPosition | null): SerializedBadgeEnumPosition;
+export declare function serializeBadgeEnumPositionAsKey(position: BadgeEnumPosition): string;
+export declare function isValidSerializedBadgeEnumPosition(val: any): val is SerializedBadgeEnumPosition;
+export declare function isHorizontalPos(maybePos: HorizontalBadgePos | undefined | null): maybePos is HorizontalBadgePos;
+export declare function isVerticalPos(maybePos: VerticalBadgePos | undefined | null): maybePos is VerticalBadgePos;
+export declare function isLayerPos(maybePos: BadgeLayerPos | undefined | null): maybePos is BadgeLayerPos;

package/sdk/core/properties/datagraphic/badgeposition.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLayerPos = exports.isVerticalPos = exports.isHorizontalPos = exports.isValidSerializedBadgeEnumPosition = exports.serializeBadgeEnumPositionAsKey = exports.serializeBadgeEnumPosition = exports.deserializeBadgeEnumPosition = exports.badgePositionsEqual = exports.defaultBadgePositionSerialized = exports.defaultBadgePosition = exports.BadgePositionsClockwise = exports.BadgeResponsiveness = exports.BadgeLayerPos = exports.VerticalBadgePos = exports.HorizontalBadgePos = void 0;
+const checks_1 = require("../../checks");
+var HorizontalBadgePos;
+(function (HorizontalBadgePos) {
+    HorizontalBadgePos[HorizontalBadgePos["LEFT"] = 0] = "LEFT";
+    HorizontalBadgePos[HorizontalBadgePos["CENTER"] = 1] = "CENTER";
+    HorizontalBadgePos[HorizontalBadgePos["RIGHT"] = 2] = "RIGHT";
+})(HorizontalBadgePos = exports.HorizontalBadgePos || (exports.HorizontalBadgePos = {}));
+var VerticalBadgePos;
+(function (VerticalBadgePos) {
+    VerticalBadgePos[VerticalBadgePos["TOP"] = 0] = "TOP";
+    VerticalBadgePos[VerticalBadgePos["CENTER"] = 1] = "CENTER";
+    VerticalBadgePos[VerticalBadgePos["BOTTOM"] = 2] = "BOTTOM";
+})(VerticalBadgePos = exports.VerticalBadgePos || (exports.VerticalBadgePos = {}));
+var BadgeLayerPos;
+(function (BadgeLayerPos) {
+    BadgeLayerPos[BadgeLayerPos["INSIDE"] = 0] = "INSIDE";
+    BadgeLayerPos[BadgeLayerPos["EDGE"] = 1] = "EDGE";
+    BadgeLayerPos[BadgeLayerPos["OUTSIDE"] = 2] = "OUTSIDE";
+})(BadgeLayerPos = exports.BadgeLayerPos || (exports.BadgeLayerPos = {}));
+var BadgeResponsiveness;
+(function (BadgeResponsiveness) {
+    BadgeResponsiveness[BadgeResponsiveness["STATIC"] = 0] = "STATIC";
+    BadgeResponsiveness[BadgeResponsiveness["STACK"] = 1] = "STACK";
+})(BadgeResponsiveness = exports.BadgeResponsiveness || (exports.BadgeResponsiveness = {}));
+/*
+ * The order of the badge position starting from the top-left corner and going clockwise
+ */
+exports.BadgePositionsClockwise = [
+    { horizontalPos: 0, verticalPos: 0 },
+    { horizontalPos: 1, verticalPos: 0 },
+    { horizontalPos: 2, verticalPos: 0 },
+    { horizontalPos: 2, verticalPos: 1 },
+    { horizontalPos: 2, verticalPos: 2 },
+    { horizontalPos: 1, verticalPos: 2 },
+    { horizontalPos: 0, verticalPos: 2 },
+    { horizontalPos: 0, verticalPos: 1 }, // left-center
+];
+exports.defaultBadgePosition = {
+    horizontalPos: HorizontalBadgePos.RIGHT,
+    verticalPos: VerticalBadgePos.TOP,
+    layer: BadgeLayerPos.EDGE,
+    responsive: BadgeResponsiveness.STACK,
+};
+exports.defaultBadgePositionSerialized = {
+    'horiz': HorizontalBadgePos.RIGHT,
+    'vert': VerticalBadgePos.TOP,
+    'layer': BadgeLayerPos.EDGE,
+    'responsive': BadgeResponsiveness.STACK,
+};
+function badgePositionsEqual(a, b) {
+    return (a.horizontalPos === b.horizontalPos &&
+        a.verticalPos === b.verticalPos &&
+        a.layer === b.layer &&
+        a.responsive === b.responsive);
+}
+exports.badgePositionsEqual = badgePositionsEqual;
+function deserializeBadgeEnumPosition(serialized) {
+    if (serialized == null) {
+        return undefined;
+    }
+    return {
+        horizontalPos: serialized['horiz'] != null ? serialized['horiz'] : exports.defaultBadgePosition.horizontalPos,
+        verticalPos: serialized['vert'] != null ? serialized['vert'] : exports.defaultBadgePosition.verticalPos,
+        layer: serialized['layer'] != null ? serialized['layer'] : exports.defaultBadgePosition.layer,
+        responsive: serialized['responsive'] != null ? serialized['responsive'] : exports.defaultBadgePosition.responsive,
+    };
+}
+exports.deserializeBadgeEnumPosition = deserializeBadgeEnumPosition;
+function serializeBadgeEnumPosition(position) {
+    if (position == null) {
+        return {
+            'horiz': exports.defaultBadgePosition.horizontalPos,
+            'vert': exports.defaultBadgePosition.verticalPos,
+            'layer': exports.defaultBadgePosition.layer,
+            'responsive': exports.defaultBadgePosition.responsive,
+        };
+    }
+    return {
+        'horiz': position.horizontalPos,
+        'vert': position.verticalPos,
+        'layer': position.layer,
+        'responsive': position.responsive,
+    };
+}
+exports.serializeBadgeEnumPosition = serializeBadgeEnumPosition;
+function serializeBadgeEnumPositionAsKey(position) {
+    return JSON.stringify(position);
+}
+exports.serializeBadgeEnumPositionAsKey = serializeBadgeEnumPositionAsKey;
+function isValidSerializedBadgeEnumPosition(val) {
+    // All fields are optional, so it's fine if they're not present
+    const horizValid = val['horiz'] == undefined || Object.values(HorizontalBadgePos).includes(val['horiz']);
+    const vertValid = val['vert'] == undefined || Object.values(VerticalBadgePos).includes(val['vert']);
+    const layerValid = val['layer'] == undefined || Object.values(BadgeLayerPos).includes(val['layer']);
+    const responsiveValid = val['responsive'] == undefined || Object.values(BadgeResponsiveness).includes(val['responsive']);
+    return horizValid && vertValid && layerValid && responsiveValid;
+}
+exports.isValidSerializedBadgeEnumPosition = isValidSerializedBadgeEnumPosition;
+function isHorizontalPos(maybePos) {
+    if ((0, checks_1.isNumber)(maybePos)) {
+        return !!HorizontalBadgePos[maybePos];
+    }
+    return false;
+}
+exports.isHorizontalPos = isHorizontalPos;
+function isVerticalPos(maybePos) {
+    if ((0, checks_1.isNumber)(maybePos)) {
+        return !!VerticalBadgePos[maybePos];
+    }
+    return false;
+}
+exports.isVerticalPos = isVerticalPos;
+function isLayerPos(maybePos) {
+    if ((0, checks_1.isNumber)(maybePos)) {
+        return !!BadgeLayerPos[maybePos];
+    }
+    return false;
+}
+exports.isLayerPos = isLayerPos;

package/sdk/core/properties/datagraphic/datagraphicindexes.d.ts

@@ -0,0 +1,24 @@
+export declare enum DataGraphicIconSets {
+    CUSTOM_ICONS = -1,
+    STATUS_ICONS = 0,
+    STATUS_CIRCLES = 1,
+    STOPLIGHTS = 2,
+    TOGGLES = 3,
+    COMPLETION_PIES = 4,
+    TRENDING_ARROWS = 5,
+    STATUS_CHECK_BOXES = 6,
+    TRENDING_ARROWS_FLIPPED = 7
+}
+export declare type DataGraphicIconLibrarySets = Exclude<DataGraphicIconSets, DataGraphicIconSets.CUSTOM_ICONS>;
+export declare type DataGraphicImage = {
+    url: string;
+    w: number;
+    h: number;
+};
+export declare type DataGraphicIconIndexes = {
+    set: DataGraphicIconSets;
+    index: number;
+    iconImage?: DataGraphicImage;
+};
+export declare function areDataGraphicIconIndexesEqual(a: DataGraphicIconIndexes, b: DataGraphicIconIndexes): boolean;
+export declare function areDataGraphicImagesEqual(a: DataGraphicImage | undefined, b: DataGraphicImage | undefined): boolean;

package/sdk/core/properties/datagraphic/datagraphicindexes.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areDataGraphicImagesEqual = exports.areDataGraphicIconIndexesEqual = exports.DataGraphicIconSets = void 0;
+var DataGraphicIconSets;
+(function (DataGraphicIconSets) {
+    // Custom icons are a user-defined set of uploaded icons, not a predefined set of icons
+    DataGraphicIconSets[DataGraphicIconSets["CUSTOM_ICONS"] = -1] = "CUSTOM_ICONS";
+    DataGraphicIconSets[DataGraphicIconSets["STATUS_ICONS"] = 0] = "STATUS_ICONS";
+    DataGraphicIconSets[DataGraphicIconSets["STATUS_CIRCLES"] = 1] = "STATUS_CIRCLES";
+    DataGraphicIconSets[DataGraphicIconSets["STOPLIGHTS"] = 2] = "STOPLIGHTS";
+    DataGraphicIconSets[DataGraphicIconSets["TOGGLES"] = 3] = "TOGGLES";
+    DataGraphicIconSets[DataGraphicIconSets["COMPLETION_PIES"] = 4] = "COMPLETION_PIES";
+    DataGraphicIconSets[DataGraphicIconSets["TRENDING_ARROWS"] = 5] = "TRENDING_ARROWS";
+    DataGraphicIconSets[DataGraphicIconSets["STATUS_CHECK_BOXES"] = 6] = "STATUS_CHECK_BOXES";
+    DataGraphicIconSets[DataGraphicIconSets["TRENDING_ARROWS_FLIPPED"] = 7] = "TRENDING_ARROWS_FLIPPED";
+})(DataGraphicIconSets = exports.DataGraphicIconSets || (exports.DataGraphicIconSets = {}));
+function areDataGraphicIconIndexesEqual(a, b) {
+    return a.set == b.set && a.index == b.index && areDataGraphicImagesEqual(a.iconImage, b.iconImage);
+}
+exports.areDataGraphicIconIndexesEqual = areDataGraphicIconIndexesEqual;
+function areDataGraphicImagesEqual(a, b) {
+    if (a == undefined || b == undefined) {
+        return a == b;
+    }
+    return a.w == b.w && a.h == b.h && a.url == b.url;
+}
+exports.areDataGraphicImagesEqual = areDataGraphicImagesEqual;

package/sdk/core/properties/datagraphic/staticdatagraphicsettings.d.ts

@@ -0,0 +1,15 @@
+import { BadgeEnumPosition, SerializedBadgeEnumPosition } from './badgeposition';
+import { DataGraphicIconIndexes } from './datagraphicindexes';
+export declare type SerializedSimpleStaticDataGraphicSettings = {
+    'icon': DataGraphicIconIndexes;
+    'pos': SerializedBadgeEnumPosition;
+    'color': string;
+};
+export declare type SimpleStaticDataGraphicSettings = {
+    icon: DataGraphicIconIndexes;
+    position: BadgeEnumPosition;
+    color: string;
+};
+export declare function serializeSimpleStaticDataGraphicSettings(settings: SimpleStaticDataGraphicSettings): SerializedSimpleStaticDataGraphicSettings;
+export declare function deserializeSimpleStaticDataGraphicSettings(settings: SerializedSimpleStaticDataGraphicSettings): SimpleStaticDataGraphicSettings;
+export declare function isSerializedSimpleStaticDataGraphicSettings(settings: unknown): settings is SerializedSimpleStaticDataGraphicSettings;

package/sdk/core/properties/datagraphic/staticdatagraphicsettings.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSerializedSimpleStaticDataGraphicSettings = exports.deserializeSimpleStaticDataGraphicSettings = exports.serializeSimpleStaticDataGraphicSettings = void 0;
+const checks_1 = require("../../checks");
+const badgeposition_1 = require("./badgeposition");
+function serializeSimpleStaticDataGraphicSettings(settings) {
+    return {
+        'icon': settings.icon,
+        'pos': (0, badgeposition_1.serializeBadgeEnumPosition)(settings.position),
+        'color': settings.color,
+    };
+}
+exports.serializeSimpleStaticDataGraphicSettings = serializeSimpleStaticDataGraphicSettings;
+function deserializeSimpleStaticDataGraphicSettings(settings) {
+    return {
+        icon: settings['icon'],
+        position: (0, badgeposition_1.deserializeBadgeEnumPosition)(settings['pos']),
+        color: settings['color'],
+    };
+}
+exports.deserializeSimpleStaticDataGraphicSettings = deserializeSimpleStaticDataGraphicSettings;
+function isSerializedSimpleStaticDataGraphicSettings(settings) {
+    return ((0, checks_1.isObject)(settings) &&
+        (0, checks_1.isString)(settings['color']) &&
+        (0, checks_1.isObject)(settings['icon']) &&
+        (0, badgeposition_1.isValidSerializedBadgeEnumPosition)(settings['pos']));
+}
+exports.isSerializedSimpleStaticDataGraphicSettings = isSerializedSimpleStaticDataGraphicSettings;

package/sdk/core/properties/fillcolor.d.ts

@@ -0,0 +1,65 @@
+/** @ignore */
+export declare type SerializedImageFill = {
+    'pos': string;
+    'url': string;
+    'polys': {
+        'x': number;
+        'y': number;
+    }[][] | null;
+    'w'?: number;
+    'h'?: number;
+    'FX'?: any[];
+    'bb'?: {
+        'x': number;
+        'y': number;
+        'w': number;
+        'h': number;
+    };
+    'location'?: string;
+    'fallbackUrl'?: string;
+    'rotation'?: number;
+    'horizontalAlign'?: string;
+    'verticalAlign'?: string;
+    'FlipX'?: boolean;
+    'FlipY'?: boolean;
+    'isSvg'?: boolean;
+};
+/** @ignore */
+export declare type SimpleSerializedFillStyle = string | SerializedImageFill;
+/**
+ * Different ways of laying out the image in the background of the block.
+ */
+export declare enum SimpleImageFillPosition {
+    /** The image retains its original aspect ratio, and is as large as possible while still fitting in the block */
+    Fit = "fit",
+    /** The image retains its original aspect ratio, and is as small as possible while still completely covering the block */
+    Fill = "fill",
+    /** The image is stretched to the bounding box of the block */
+    Stretch = "stretch",
+    /** The image is shown in its original size if possible */
+    Original = "original",
+    /** The image is tiled in its original size vertically and horizontally to fully cover the block */
+    Tile = "tile"
+}
+/**
+ * Settings for using an image as the fill style of a block.
+ */
+export declare type SimpleImageFill = {
+    /**
+     * URL of the image to display. If a data URL is provided, the image will be uploaded
+     * to the current user's Lucid account and the URL replaced with a Lucid-provided one.
+     */
+    url: string;
+    /**
+     * Different ways of laying out the image in the background of the block.
+     */
+    position: SimpleImageFillPosition;
+};
+/**
+ * Settings for the fill style of a block.
+ *
+ * If a string is provided, it must be a hex color string, e.g. `'#ff00ff'` or `'#aabbcc80'`.
+ */
+export declare type SimpleFillStyle = string | SimpleImageFill;
+/** @ignore */
+export declare function serializeSimpleFill(fill: SimpleFillStyle): SimpleSerializedFillStyle;

package/sdk/core/properties/fillcolor.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSimpleFill = exports.SimpleImageFillPosition = void 0;
+const checks_1 = require("../checks");
+/**
+ * Different ways of laying out the image in the background of the block.
+ */
+var SimpleImageFillPosition;
+(function (SimpleImageFillPosition) {
+    /** The image retains its original aspect ratio, and is as large as possible while still fitting in the block */
+    SimpleImageFillPosition["Fit"] = "fit";
+    /** The image retains its original aspect ratio, and is as small as possible while still completely covering the block */
+    SimpleImageFillPosition["Fill"] = "fill";
+    /** The image is stretched to the bounding box of the block */
+    SimpleImageFillPosition["Stretch"] = "stretch";
+    /** The image is shown in its original size if possible */
+    SimpleImageFillPosition["Original"] = "original";
+    /** The image is tiled in its original size vertically and horizontally to fully cover the block */
+    SimpleImageFillPosition["Tile"] = "tile";
+    //TODO: 'mask' but mask requires additional settings
+})(SimpleImageFillPosition = exports.SimpleImageFillPosition || (exports.SimpleImageFillPosition = {}));
+/** @ignore */
+function serializeSimpleFill(fill) {
+    if ((0, checks_1.isString)(fill)) {
+        return fill;
+    }
+    else {
+        return {
+            'pos': fill.position,
+            'url': fill.url,
+            'polys': null,
+        };
+    }
+}
+exports.serializeSimpleFill = serializeSimpleFill;

package/sdk/core/properties/shadow.d.ts

@@ -0,0 +1,15 @@
+export declare type SerializedShadow = {
+    'x': number;
+    'y': number;
+    'b': number;
+    'c': string;
+    'ang'?: number;
+};
+export interface Shadow {
+    distance: number;
+    angle: number;
+    blur: number;
+    color: string;
+}
+export declare function serializeShadow(shadow: Shadow): SerializedShadow;
+export declare function deserializeShadow(shadow: SerializedShadow): Shadow;

package/sdk/core/properties/shadow.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeShadow = exports.serializeShadow = void 0;
+function serializeShadow(shadow) {
+    return {
+        'x': shadow.distance * Math.cos(shadow.angle),
+        'y': shadow.distance * Math.sin(shadow.angle),
+        'b': shadow.blur,
+        'c': shadow.color,
+        'ang': shadow.angle,
+    };
+}
+exports.serializeShadow = serializeShadow;
+function deserializeShadow(shadow) {
+    var _a;
+    return {
+        distance: Math.sqrt(shadow['x'] * shadow['x'] + shadow['y'] * shadow['y']),
+        angle: (_a = shadow['ang']) !== null && _a !== void 0 ? _a : Math.atan2(shadow['y'], shadow['x']),
+        blur: shadow['b'],
+        color: shadow['c'],
+    };
+}
+exports.deserializeShadow = deserializeShadow;

package/sdk/data/dataitemproxy.d.ts

@@ -18,4 +18,8 @@ export declare class DataItemProxy {
      * The fields on this data item, organized by their name.
      */
     readonly fields: MapProxy<string, import("..").SerializedFieldType>;
+    /**
+     * @returns True if a data item exists in this collection at this primary key
+     */
+    exists(): boolean;
 }

package/sdk/data/dataitemproxy.js

@@ -24,5 +24,11 @@ class DataItemProxy {
             'f': name,
         }));
     }
+    /**
+     * @returns True if a data item exists in this collection at this primary key
+     */
+    exists() {
+        return this.client.sendCommand("die" /* DataItemExists */, { 'c': this.collection.id, 'pk': this.primaryKey });
+    }
 }
 exports.DataItemProxy = DataItemProxy;

package/sdk/document/blockdefinition.d.ts

@@ -1,4 +1,5 @@
 import { JsonObject, JsonSerializable } from '../../lucid-extension-sdk';
+import { SimpleFillStyle } from '../core/properties/fillcolor';
 import { Box } from '../math';
 /**
  * The information required to create a new block on the current document
@@ -12,6 +13,14 @@ export interface BlockDefinition {
      * The initial location and size of the block on the page.
      */
     boundingBox: Box;
+    /**
+     * If specified, the initial FillColor property for the block
+     */
+    fillStyle?: SimpleFillStyle;
+    /**
+     * If specified, the initial line width for the block
+     */
+    lineWidth?: number;
     /**
      * Additional properties to set on the block immediately after creation. This is not typically
      * set directly (it's easier and safer to call `.properties.set()` after block creation) but

package/sdk/document/blockproxy.d.ts

@@ -1,3 +1,6 @@
+import { SimpleStaticDataGraphicSettings } from '../core/properties/datagraphic/staticdatagraphicsettings';
+import { SimpleFillStyle } from '../core/properties/fillcolor';
+import { Shadow } from '../core/properties/shadow';
 import { ItemProxy } from './itemproxy';
 /**
  * A block is a single shape on the document. A BlockProxy provides an interface to
@@ -15,10 +18,55 @@ export declare class BlockProxy extends ItemProxy {
      * @returns The amount this block is rotated around its own center, in radians.
      */
     getRotation(): number;
+    /**
+     * @param radians Angle the block should be rotated
+     */
+    setRotation(radians: number): void;
+    /**
+     * @returns The current drop shadow on this block, or undefined if no shadow is set
+     */
+    getShadow(): Shadow | undefined;
+    /**
+     * @param shadow The drop shadow to set on the block, or undefined to clear the drop shadow
+     */
+    setShadow(shadow: Shadow | undefined): void;
+    /**
+     * Set the fill style used (by most kinds of blocks) to fill in their main opaque areas.
+     * This can be a string color (e.g. `'#ff00ff80'`) or an image fill.
+     */
+    setFillStyle(fillStyle: SimpleFillStyle): void;
     /**
      * @returns An array of lines that have one or both endpoints connected to this block.
      */
     getConnectedLines(): import("./lineproxy").LineProxy[];
+    /**
+     * @param settings Information about the static data graphic icon to set on this block.
+     */
+    setSimpleStaticDataGraphic(settings: SimpleStaticDataGraphicSettings | undefined): void;
+    /**
+     * @returns Settings for the simple static data graphic currently set on this block, or undefined
+     * if no simple data graphic is currently set. Note that if a data graphic exists that is not an
+     * icon, this will return undefined. This function will not consider data graphics set via
+     * conditional formatting rules.
+     */
+    getSimpleStaticDataGraphic(): SimpleStaticDataGraphicSettings | undefined;
+    /**
+     * Lock this block's aspect ratio to its current value.
+     * This can be reversed with unlockAspectRatio.
+     */
+    lockAspectRatio(): void;
+    /**
+     * Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.
+     */
+    unlockAspectRatio(): void;
+    /**
+     * @returns The line width used by most kinds of blocks to render their outline.
+     */
+    getLineWidth(): number;
+    /**
+     * @param width The line width to be used (by most kinds of blocks) to render this block's outline
+     */
+    setLineWidth(width: number): void;
     /**
      * Link a text area to a data field, so that editing the text area will also update the
      * associated data, and vice versa.

package/sdk/document/blockproxy.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlockProxy = void 0;
+const staticdatagraphicsettings_1 = require("../core/properties/datagraphic/staticdatagraphicsettings");
+const fillcolor_1 = require("../core/properties/fillcolor");
+const shadow_1 = require("../core/properties/shadow");
 const itemproxy_1 = require("./itemproxy");
 /**
  * A block is a single shape on the document. A BlockProxy provides an interface to
@@ -22,6 +25,40 @@ class BlockProxy extends itemproxy_1.ItemProxy {
     getRotation() {
         return this.properties.get('Rotation');
     }
+    /**
+     * @param radians Angle the block should be rotated
+     */
+    setRotation(radians) {
+        this.properties.set('Rotation', radians);
+    }
+    /**
+     * @returns The current drop shadow on this block, or undefined if no shadow is set
+     */
+    getShadow() {
+        const raw = this.properties.get('Shadow');
+        if (!raw) {
+            return undefined;
+        }
+        return (0, shadow_1.deserializeShadow)(raw);
+    }
+    /**
+     * @param shadow The drop shadow to set on the block, or undefined to clear the drop shadow
+     */
+    setShadow(shadow) {
+        if (shadow) {
+            this.properties.set('Shadow', (0, shadow_1.serializeShadow)(shadow));
+        }
+        else {
+            this.properties.set('Shadow', null);
+        }
+    }
+    /**
+     * Set the fill style used (by most kinds of blocks) to fill in their main opaque areas.
+     * This can be a string color (e.g. `'#ff00ff80'`) or an image fill.
+     */
+    setFillStyle(fillStyle) {
+        this.properties.set('FillColor', (0, fillcolor_1.serializeSimpleFill)(fillStyle));
+    }
     /**
      * @returns An array of lines that have one or both endpoints connected to this block.
      */
@@ -29,6 +66,58 @@ class BlockProxy extends itemproxy_1.ItemProxy {
         const ids = this.client.sendCommand("gcl" /* GetConnectedLines */, this.id);
         return ids.map((id) => this.client.getLineProxy(id));
     }
+    /**
+     * @param settings Information about the static data graphic icon to set on this block.
+     */
+    setSimpleStaticDataGraphic(settings) {
+        if (settings) {
+            this.properties.set('StaticDataGraphic', (0, staticdatagraphicsettings_1.serializeSimpleStaticDataGraphicSettings)(settings));
+        }
+        else {
+            this.properties.set('StaticDataGraphic', undefined);
+        }
+    }
+    /**
+     * @returns Settings for the simple static data graphic currently set on this block, or undefined
+     * if no simple data graphic is currently set. Note that if a data graphic exists that is not an
+     * icon, this will return undefined. This function will not consider data graphics set via
+     * conditional formatting rules.
+     */
+    getSimpleStaticDataGraphic() {
+        const settings = this.properties.get('StaticDataGraphic');
+        if ((0, staticdatagraphicsettings_1.isSerializedSimpleStaticDataGraphicSettings)(settings)) {
+            return (0, staticdatagraphicsettings_1.deserializeSimpleStaticDataGraphicSettings)(settings);
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Lock this block's aspect ratio to its current value.
+     * This can be reversed with unlockAspectRatio.
+     */
+    lockAspectRatio() {
+        const bb = this.getBoundingBox();
+        this.properties.set('AspectRatio', bb.w / bb.h);
+    }
+    /**
+     * Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.
+     */
+    unlockAspectRatio() {
+        this.properties.set('AspectRatio', undefined);
+    }
+    /**
+     * @returns The line width used by most kinds of blocks to render their outline.
+     */
+    getLineWidth() {
+        return this.properties.get('LineWidth');
+    }
+    /**
+     * @param width The line width to be used (by most kinds of blocks) to render this block's outline
+     */
+    setLineWidth(width) {
+        this.properties.set('LineWidth', width);
+    }
     /**
      * Link a text area to a data field, so that editing the text area will also update the
      * associated data, and vice versa.

package/sdk/document/documentproxy.d.ts

@@ -15,6 +15,10 @@ export declare class DocumentProxy extends ElementProxy {
      */
     readonly pages: MapProxy<string, PageProxy>;
     constructor(client: EditorClient);
+    /**
+     * An iterator over all blocks on all pages of the document
+     */
+    allBlocks(): Generator<import("./blockproxy").BlockProxy, void, unknown>;
     /**
      * Add a new page to the current document
      * @param def Definition of the page to add

package/sdk/document/documentproxy.js

@@ -18,6 +18,16 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
     static getNextHookName() {
         return '__documentproxy__hook' + DocumentProxy.nextHookId++;
     }
+    /**
+     * An iterator over all blocks on all pages of the document
+     */
+    *allBlocks() {
+        for (const page of this.pages.values()) {
+            for (const block of page.blocks.values()) {
+                yield block;
+            }
+        }
+    }
     /**
      * Add a new page to the current document
      * @param def Definition of the page to add

package/sdk/document/pageproxy.js

@@ -64,6 +64,12 @@ class PageProxy extends elementproxy_1.ElementProxy {
                 block.properties.set(key, def.properties[key]);
             }
         }
+        if (def.fillStyle !== undefined) {
+            block.setFillStyle(def.fillStyle);
+        }
+        if (def.lineWidth !== undefined) {
+            block.setLineWidth(def.lineWidth);
+        }
         return block;
     }
     /**

package/sdk/document/shapedataproxy.d.ts

@@ -21,4 +21,9 @@ export declare class ShapeDataProxy extends WriteableMapProxy<string, Serialized
     delete(key: string): void;
     /** @ignore */
     static parseData(raw: SerializedFieldType | SerializedDataError): SerializedFieldType | DataError;
+    /**
+     * @param key Name of the shape data to read
+     * @returns The value if it is a string, or an empty string if it does not exist or is not a string.
+     */
+    getString(key: string): string;
 }

package/sdk/document/shapedataproxy.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDataProxy = void 0;
+const checks_1 = require("../core/checks");
 const serializeddataerror_1 = require("../core/serializeddataerror");
 const shapedatainheritance_1 = require("../core/shapedatainheritance");
 const dataerror_1 = require("../data/dataerror");
@@ -53,5 +54,16 @@ class ShapeDataProxy extends mapproxy_1.WriteableMapProxy {
         //TODO, eventually: parse these
         return raw;
     }
+    /**
+     * @param key Name of the shape data to read
+     * @returns The value if it is a string, or an empty string if it does not exist or is not a string.
+     */
+    getString(key) {
+        const val = this.get(key);
+        if (!(0, checks_1.isString)(val)) {
+            return '';
+        }
+        return val;
+    }
 }
 exports.ShapeDataProxy = ShapeDataProxy;

package/sdk/editorclient.d.ts

@@ -178,12 +178,17 @@ export declare class EditorClient {
      * associated with this editor extension. If this callback is async (returns a promise), then the
      * bootstrap data is not cleared off of the document until that promise resolves.
      *
+     * @param markExtensionAsRequired If bootstrap data is available for this editor extension, this will mark the
+     * document as requiring the extension. Once marked, if the extension is not installed the user will be
+     * notified about the extension being required on document load. The minimum extension version required by the
+     * document is the version provided in the request body when creating the document.
+     *
      * @return a promise that resolves immediately if there is no available bootstrap data, or else after
      * the callback successfully completes. This promise will reject/throw if the callback throws or
      * returns a promise that rejects, or if there is another editor session processing the same bootstrap
      * data at the same time.
      */
-    processAndClearBootstrapData(callback: (data: JsonSerializable) => void | Promise<void>): Promise<void>;
+    processAndClearBootstrapData(callback: (data: JsonSerializable) => void | Promise<void>, markExtensionAsRequired?: boolean): Promise<void>;
     /**
      * @param id ID of the line to create a proxy for
      * @returns the given line

package/sdk/editorclient.js

@@ -102,13 +102,14 @@ class EditorClient {
             };
         })
             .catch((error) => {
+            var _a, _b, _c, _d;
             const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
             throw {
-                url: raw ? raw['url'] : '',
-                responseText: raw ? raw['t'] : 'An unknown error occurred',
-                status: raw ? raw['s'] : 0,
-                headers: raw ? raw['h'] : {},
-                timeout: raw ? raw['to'] : undefined,
+                url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '',
+                responseText: (_b = raw === null || raw === void 0 ? void 0 : raw['t']) !== null && _b !== void 0 ? _b : 'An unknown error occurred',
+                status: (_c = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _c !== void 0 ? _c : 0,
+                headers: (_d = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _d !== void 0 ? _d : {},
+                timeout: raw === null || raw === void 0 ? void 0 : raw['to'],
             };
         });
     }
@@ -131,13 +132,14 @@ class EditorClient {
             };
         })
             .catch((error) => {
-            const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : error;
+            var _a, _b, _c, _d;
+            const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
             throw {
-                url: raw['url'],
-                responseText: raw['t'],
-                status: raw['s'],
-                headers: raw['h'],
-                timeout: raw['to'],
+                url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '',
+                responseText: (_b = raw === null || raw === void 0 ? void 0 : raw['t']) !== null && _b !== void 0 ? _b : 'An unknown error occurred',
+                status: (_c = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _c !== void 0 ? _c : 0,
+                headers: (_d = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _d !== void 0 ? _d : {},
+                timeout: raw === null || raw === void 0 ? void 0 : raw['to'],
             };
         });
     }
@@ -284,17 +286,22 @@ class EditorClient {
      * associated with this editor extension. If this callback is async (returns a promise), then the
      * bootstrap data is not cleared off of the document until that promise resolves.
      *
+     * @param markExtensionAsRequired If bootstrap data is available for this editor extension, this will mark the
+     * document as requiring the extension. Once marked, if the extension is not installed the user will be
+     * notified about the extension being required on document load. The minimum extension version required by the
+     * document is the version provided in the request body when creating the document.
+     *
      * @return a promise that resolves immediately if there is no available bootstrap data, or else after
      * the callback successfully completes. This promise will reject/throw if the callback throws or
      * returns a promise that rejects, or if there is another editor session processing the same bootstrap
      * data at the same time.
      */
-    async processAndClearBootstrapData(callback) {
+    async processAndClearBootstrapData(callback, markExtensionAsRequired) {
         const name = this.getUniqueActionName();
         this.registerAction(name, (msg) => {
             return callback(msg['d']);
         });
-        await this.sendCommand("b" /* Bootstrap */, { 'c': name });
+        await this.sendCommand("b" /* Bootstrap */, { 'c': name, 'm': markExtensionAsRequired });
         this.deleteAction(name);
     }
     /**

package/sdk/ui/panel.d.ts

@@ -5,7 +5,9 @@ import { IframeUI } from './iframeui';
  */
 export declare enum PanelLocation {
     /** In Lucidchart, create a sibling to the Contextual Panel */
-    RightDock = 1
+    RightDock = 1,
+    /** In Lucidchart, create a sibling to the shape toolbox */
+    ContentDock = 2
 }
 export interface PanelConfig {
     /** Title to display at the top of the panel */

package/sdk/ui/panel.js

@@ -9,6 +9,8 @@ var PanelLocation;
 (function (PanelLocation) {
     /** In Lucidchart, create a sibling to the Contextual Panel */
     PanelLocation[PanelLocation["RightDock"] = 1] = "RightDock";
+    /** In Lucidchart, create a sibling to the shape toolbox */
+    PanelLocation[PanelLocation["ContentDock"] = 2] = "ContentDock";
 })(PanelLocation = exports.PanelLocation || (exports.PanelLocation = {}));
 /**
  * Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed

package/sdk/ui/viewport.d.ts

@@ -1,3 +1,4 @@
+import { BlockDefinition } from '../../lucid-extension-sdk';
 import { ItemProxy } from '../document/itemproxy';
 import { PageProxy } from '../document/pageproxy';
 import { EditorClient } from '../editorclient';
@@ -69,4 +70,19 @@ export declare class Viewport {
      * @param handle The return value of hookSelection.
      */
     unhookSelection(handle: string): void;
+    /**
+     * Start an interaction of the current user dragging a new block onto the current page, exactly
+     * as if they started dragging that block out of the normal toolbox. At the time this function is
+     * called, the user's primary mouse button should be down (e.g. in a mousedown event handler).
+     *
+     * @param definition Definition of the block to create if and where the user drops it on-canvas
+     * @returns A promise resolving to a reference to the created block, if successfully dropped,
+     *  or undefined if the user cancels the drag interaction.
+     */
+    startDraggingNewBlock(definition: BlockDefinition): Promise<import("../document/blockproxy").BlockProxy | undefined>;
+    /**
+     * If startDraggingNewBlock has been called, and the drag-new-block interaction is still active,
+     * cancel that interaction.
+     */
+    cancelDraggingNewBlock(): void;
 }

package/sdk/ui/viewport.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Viewport = void 0;
 const checks_1 = require("../core/checks");
+const fillcolor_1 = require("../core/properties/fillcolor");
 const itemproxy_1 = require("../document/itemproxy");
 const pageproxy_1 = require("../document/pageproxy");
 const math_1 = require("../math");
@@ -126,6 +127,42 @@ class Viewport {
         this.client.deleteAction(handle);
         this.client.sendCommand("us" /* UnhookSelection */, { 'n': handle });
     }
+    /**
+     * Start an interaction of the current user dragging a new block onto the current page, exactly
+     * as if they started dragging that block out of the normal toolbox. At the time this function is
+     * called, the user's primary mouse button should be down (e.g. in a mousedown event handler).
+     *
+     * @param definition Definition of the block to create if and where the user drops it on-canvas
+     * @returns A promise resolving to a reference to the created block, if successfully dropped,
+     *  or undefined if the user cancels the drag interaction.
+     */
+    async startDraggingNewBlock(definition) {
+        var _a;
+        const properties = (_a = definition.properties) !== null && _a !== void 0 ? _a : {};
+        if (definition.fillStyle !== undefined) {
+            properties['FillColor'] = (0, fillcolor_1.serializeSimpleFill)(definition.fillStyle);
+        }
+        if (definition.lineWidth !== undefined) {
+            properties['LineWidth'] = definition.lineWidth;
+        }
+        const maybeBlockId = await this.client.sendCommand("sdc" /* StartDragBlockToCanvas */, {
+            'c': definition.className,
+            'sz': {
+                'w': definition.boundingBox.w,
+                'h': definition.boundingBox.h,
+            },
+            'p': properties,
+            's': definition.stencil,
+        });
+        return maybeBlockId ? this.client.getBlockProxy(maybeBlockId) : undefined;
+    }
+    /**
+     * If startDraggingNewBlock has been called, and the drag-new-block interaction is still active,
+     * cancel that interaction.
+     */
+    cancelDraggingNewBlock() {
+        this.client.sendCommand("cdc" /* CancelDragBlockToCanvas */, undefined);
+    }
 }
 exports.Viewport = Viewport;
 Viewport.nextHookId = 0;