lucid-extension-sdk 0.0.119 → 0.0.121

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -8,6 +8,7 @@ import { SerializedDataError } from './core/serializeddataerror';
 import { ShapeDataInheritance } from './core/shapedatainheritance';
 import { DocumentElementType } from './document/documentelement/documentelementtype';
 import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
+import { TextStyle } from './document/text/textstyle';
 import { Box, Point } from './math';
 import { MenuLocation, MenuType } from './ui/menu';
 import { PanelLocation } from './ui/panel';
@@ -59,6 +60,7 @@ export declare const enum CommandName {
     GetRelativeLinePosition = "grlp",
     GetSelection = "gs",
     GetShapeData = "gsd",
+    GetTextStyle = "gts",
     HideModal = "hm",
     HidePanel = "hp",
     HookCreateItems = "hci",
@@ -96,6 +98,7 @@ export declare const enum CommandName {
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
     SetText = "st",
+    SetTextStyle = "sts",
     ShowModal = "sm",
     ShowPanel = "spn",
     ShowPackageSettingsModal = "spsm",
@@ -277,6 +280,10 @@ export declare type CommandArgs = {
         query: GetShapeDataQuery;
         result: GetShapeDataResult;
     };
+    [CommandName.GetTextStyle]: {
+        query: GetTextStyleQuery;
+        result: GetTextStyleResult;
+    };
     [CommandName.HideModal]: {
         query: HideModalQuery;
         result: HideModalResult;
@@ -425,6 +432,10 @@ export declare type CommandArgs = {
         query: SetTextQuery;
         result: SetTextResult;
     };
+    [CommandName.SetTextStyle]: {
+        query: SetTextStyleQuery;
+        result: SetTextStyleResult;
+    };
     [CommandName.ShowModal]: {
         query: ShowModalQuery;
         result: ShowModalResult;
@@ -827,6 +838,13 @@ export declare type GetShapeDataQuery = {
     'n': string;
 };
 export declare type GetShapeDataResult = SerializedFieldType | SerializedDataError;
+export declare type GetTextStyleQuery = {
+    /** ID of the element to get text style from */
+    'id': string;
+    /** Name of the text area to get text style from */
+    'n': string;
+};
+export declare type GetTextStyleResult = TextStyle;
 export declare type HideModalQuery = {
     /** Name of the modal's action for receiving events, i.e. ShowModalQuery['n'] */
     'n': string;
@@ -1063,6 +1081,15 @@ export declare type SetTextQuery = {
     'f'?: boolean | undefined;
 };
 export declare type SetTextResult = undefined;
+export declare type SetTextStyleQuery = {
+    /** ID of the element to set text style on */
+    'id': string;
+    /** Name of the text area to set text style on */
+    'n': string;
+    /** Text styles to set */
+    's': Partial<TextStyle>;
+};
+export declare type SetTextStyleResult = Promise<undefined>;
 export declare type ShowModalQuery = {
     /** Name of the modal's action for receiving events; generated automatically by Modal base class */
     'n': string;

package/sdk/commandtypes.js

@@ -42,6 +42,7 @@ exports.commandTitles = new Map([
     ["grlp" /* CommandName.GetRelativeLinePosition */, 'GetRelativeLinePosition'],
     ["gs" /* CommandName.GetSelection */, 'GetSelection'],
     ["gsd" /* CommandName.GetShapeData */, 'GetShapeData'],
+    ["gts" /* CommandName.GetTextStyle */, 'GetTextStyle'],
     ["hm" /* CommandName.HideModal */, 'HideModal'],
     ["hp" /* CommandName.HidePanel */, 'HidePanel'],
     ["hci" /* CommandName.HookCreateItems */, 'HookCreateItems'],
@@ -77,6 +78,7 @@ exports.commandTitles = new Map([
     ["sp" /* CommandName.SetProperty */, 'SetProperty'],
     ["srk" /* CommandName.SetReferenceKey */, 'SetReferenceKey'],
     ["ssd" /* CommandName.SetShapeData */, 'SetShapeData'],
+    ["sts" /* CommandName.SetTextStyle */, 'SetTextStyle'],
     ["sm" /* CommandName.ShowModal */, 'ShowModal'],
     ["spsm" /* CommandName.ShowPackageSettingsModal */, 'ShowPackageSettingsModal'],
     ["spn" /* CommandName.ShowPanel */, 'ShowPanel'],

package/sdk/core/validators/validators.d.ts

@@ -69,6 +69,14 @@ export declare function mapValidator<T>(subValidator: (p1: unknown) => p1 is T):
 export declare function objectValidator<T extends {
     [key: string]: (p1: unknown) => p1 is unknown;
 }>(validatorStructure: T): (subject: unknown) => subject is DestructureGuardedTypeObj<T>;
+/**
+ * Creates a validator which tests if the target is an object
+ * and if the structure of the object matches the structure of the passed-in
+ * validator object, but with every entry being optional.
+ */
+export declare function partialObjectValidator<T extends {
+    [key: string]: (p1: unknown) => p1 is unknown;
+}>(validatorStructure: T): (subject: unknown) => subject is Partial<DestructureGuardedTypeObj<T>>;
 /**
  * Similar to {@link objectValidator}, but if the object has any non-undefined keys, they must also be present in the validator structure.
  * This is useful for things where extra data is unwanted, like Property serialization.

package/sdk/core/validators/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.recordValidator = exports.strictObjectValidator = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
+exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 const object_1 = require("../object");
 /*********************************************************************************
@@ -145,6 +145,24 @@ function objectValidator(validatorStructure) {
     };
 }
 exports.objectValidator = objectValidator;
+/**
+ * Creates a validator which tests if the target is an object
+ * and if the structure of the object matches the structure of the passed-in
+ * validator object, but with every entry being optional.
+ */
+function partialObjectValidator(validatorStructure) {
+    return (subject) => {
+        if ((0, checks_1.isArray)(subject) || !(0, checks_1.isObject)(subject)) {
+            return false;
+        }
+        else {
+            return (0, object_1.objectEvery)(validatorStructure, (validator, key) => {
+                return subject[key] === undefined || validator(subject[key]);
+            });
+        }
+    };
+}
+exports.partialObjectValidator = partialObjectValidator;
 /**
  * Similar to {@link objectValidator}, but if the object has any non-undefined keys, they must also be present in the validator structure.
  * This is useful for things where extra data is unwanted, like Property serialization.

package/sdk/dataconnector/actions/patchresponsebody.d.ts

@@ -27,8 +27,8 @@ export declare type SerializedPatchChange = {
     'collections': {
         'collectionId': string;
         'itemsPatch': {
-            'items'?: Record<string, object>;
-            'itemsDeleted'?: string[];
+            'items': Record<string, object>;
+            'itemsDeleted': string[];
         };
     }[];
 };

package/sdk/dataconnector/actions/patchresponsebody.js

@@ -33,11 +33,12 @@ function serializePatchResponse(patchChange) {
     return {
         'syncId': patchChange.syncId,
         'collections': patchChange.collections.map((c) => {
+            var _a, _b;
             return {
                 'collectionId': c.collectionId,
                 'itemsPatch': {
-                    'items': c.items,
-                    'itemsDeleted': c.itemsDeleted,
+                    'items': (_a = c.items) !== null && _a !== void 0 ? _a : {},
+                    'itemsDeleted': (_b = c.itemsDeleted) !== null && _b !== void 0 ? _b : [],
                 },
             };
         }),

package/sdk/document/itemproxy.d.ts

@@ -3,6 +3,7 @@ import { EditorClient } from '../editorclient';
 import { Box, Point } from '../math';
 import { ElementProxy } from './elementproxy';
 import { WriteableMapProxy } from './mapproxy';
+import { TextStyle } from './text/textstyle';
 /**
  * A block, line, or group on a page of the current document.
  */
@@ -16,7 +17,11 @@ export declare class ItemProxy extends ElementProxy {
     /**
      * The plain text in each of the text areas on this item, organized by text area name.
      */
-    readonly textAreas: WriteableMapProxy<string, string>;
+    readonly textAreas: WriteableMapProxy<string, string, undefined, string>;
+    /**
+     * The text style in each of the text areas on this item, organized by text area name.
+     */
+    readonly textStyles: WriteableMapProxy<string, TextStyle, Promise<undefined>, Partial<TextStyle>>;
     /**
      * @returns The bounding box of this item relative to its containing page. As pages may change size
      * to fit the content on them, note that these coordinates may be negative or very large.

package/sdk/document/itemproxy.js

@@ -27,6 +27,17 @@ class ItemProxy extends elementproxy_1.ElementProxy {
             't': plainText,
             'f': options === null || options === void 0 ? void 0 : options.force,
         }));
+        /**
+         * The text style in each of the text areas on this item, organized by text area name.
+         */
+        this.textStyles = new mapproxy_1.WriteableMapProxy(() => this.textAreas.keys(), (name) => this.client.sendCommand("gts" /* CommandName.GetTextStyle */, {
+            'id': this.id,
+            'n': name,
+        }), (name, style) => this.client.sendCommand("sts" /* CommandName.SetTextStyle */, {
+            'id': this.id,
+            'n': name,
+            's': style,
+        }));
     }
     /**
      * @returns The bounding box of this item relative to its containing page. As pages may change size

package/sdk/document/mapproxy.d.ts

@@ -15,10 +15,10 @@ export declare class MapProxy<KEY, VALUE> {
     get(key: KEY): VALUE;
     first(): VALUE | undefined;
 }
-export declare class WriteableMapProxy<KEY, VALUE> extends MapProxy<KEY, VALUE> {
+export declare class WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE = VALUE> extends MapProxy<KEY, VALUE> {
     private readonly setter;
-    constructor(getKeys: () => KEY[], getItem: (key: KEY) => VALUE, setter: (key: KEY, val: VALUE, options?: SetterOptions) => void);
-    set(key: KEY, value: VALUE, options?: SetterOptions): void;
+    constructor(getKeys: () => KEY[], getItem: (key: KEY) => VALUE, setter: (key: KEY, val: WRITEVALUE, options?: SetterOptions) => WRITERETURN);
+    set(key: KEY, value: WRITEVALUE, options?: SetterOptions): WRITERETURN;
 }
 export interface SetterOptions {
     force?: boolean;

package/sdk/document/mapproxy.js

@@ -59,7 +59,7 @@ class WriteableMapProxy extends MapProxy {
         this.setter = setter;
     }
     set(key, value, options = {}) {
-        this.setter(key, value, options);
+        return this.setter(key, value, options);
     }
 }
 exports.WriteableMapProxy = WriteableMapProxy;

package/sdk/document/propertystoreproxy.d.ts

@@ -11,7 +11,7 @@ export declare class PropertyStoreProxy {
      * Not all properties are writeable (e.g. "ClassName" on a block).
      * To move or resize elements, use setLocation() or setBoundingBox() or offset() instead.
      */
-    readonly properties: WriteableMapProxy<string, import("..").JsonSerializable>;
+    readonly properties: WriteableMapProxy<string, import("..").JsonSerializable, void, import("..").JsonSerializable>;
     /**
      *
      * @param id ID of this element, or undefined for the document itself

package/sdk/document/shapedataproxy.d.ts

@@ -6,7 +6,7 @@ import { WriteableMapProxy } from './mapproxy';
 /**
  * The shape data fields on a single element of the current document
  */
-export declare class ShapeDataProxy extends WriteableMapProxy<string, SerializedFieldType | SerializedDataError> {
+export declare class ShapeDataProxy extends WriteableMapProxy<string, SerializedFieldType | SerializedDataError, void> {
     readonly id: string | undefined;
     protected readonly client: EditorClient;
     /**

package/sdk/document/text/textstyle.d.ts

@@ -0,0 +1,28 @@
+import { isBoolean, isNumber, isString } from '../../core/checks';
+/**
+ * Text styles that can be read and written with ItemProxy.textStyles.
+ */
+export declare enum TextMarkupNames {
+    Family = "font",
+    Bold = "bold",
+    Italic = "italic",
+    Underline = "underline",
+    Size = "size",
+    Color = "color"
+}
+export interface TextStyle {
+    [TextMarkupNames.Family]: string;
+    [TextMarkupNames.Bold]: boolean;
+    [TextMarkupNames.Italic]: boolean;
+    [TextMarkupNames.Underline]: boolean;
+    [TextMarkupNames.Size]: number;
+    [TextMarkupNames.Color]: string;
+}
+export declare const isPartialTextStyle: (subject: unknown) => subject is Partial<import("../..").DestructureGuardedTypeObj<{
+    font: typeof isString;
+    bold: typeof isBoolean;
+    italic: typeof isBoolean;
+    underline: typeof isBoolean;
+    size: typeof isNumber;
+    color: typeof isString;
+}>>;

package/sdk/document/text/textstyle.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPartialTextStyle = exports.TextMarkupNames = void 0;
+const checks_1 = require("../../core/checks");
+const validators_1 = require("../../core/validators/validators");
+/**
+ * Text styles that can be read and written with ItemProxy.textStyles.
+ */
+var TextMarkupNames;
+(function (TextMarkupNames) {
+    TextMarkupNames["Family"] = "font";
+    TextMarkupNames["Bold"] = "bold";
+    TextMarkupNames["Italic"] = "italic";
+    TextMarkupNames["Underline"] = "underline";
+    TextMarkupNames["Size"] = "size";
+    TextMarkupNames["Color"] = "color";
+})(TextMarkupNames = exports.TextMarkupNames || (exports.TextMarkupNames = {}));
+exports.isPartialTextStyle = (0, validators_1.partialObjectValidator)({
+    [TextMarkupNames.Family]: checks_1.isString,
+    [TextMarkupNames.Bold]: checks_1.isBoolean,
+    [TextMarkupNames.Italic]: checks_1.isBoolean,
+    [TextMarkupNames.Underline]: checks_1.isBoolean,
+    [TextMarkupNames.Size]: checks_1.isNumber,
+    [TextMarkupNames.Color]: checks_1.isString,
+});

package/sdk/index.d.ts

@@ -87,6 +87,7 @@ export * from './document/pagedefinition';
 export * from './document/pageproxy';
 export * from './document/propertystoreproxy';
 export * from './document/shapedataproxy';
+export * from './document/text/textstyle';
 export * from './editorclient';
 export * from './index';
 export * from './math';

package/sdk/index.js

@@ -103,6 +103,7 @@ __exportStar(require("./document/pagedefinition"), exports);
 __exportStar(require("./document/pageproxy"), exports);
 __exportStar(require("./document/propertystoreproxy"), exports);
 __exportStar(require("./document/shapedataproxy"), exports);
+__exportStar(require("./document/text/textstyle"), exports);
 __exportStar(require("./editorclient"), exports);
 __exportStar(require("./index"), exports);
 __exportStar(require("./math"), exports);