lucid-extension-sdk 0.0.123 → 0.0.125

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -501,6 +501,8 @@ export declare type AddCardIntegrationQuery = {
     'isl': string;
     /** Icon url */
     'u': string;
+    /** Text style */
+    'ts'?: Partial<TextStyle> | undefined;
     /** Field configuration */
     'fc': {
         /** Callback to get field definitions for all fields supported by the card integration */
@@ -991,6 +993,8 @@ export declare type RegisterPanelQuery = {
     'i': string;
     /** tooltip */
     'to'?: string;
+    /** If true, we will persist the panel's iframe */
+    'p'?: boolean;
 };
 export declare type RegisterPanelResult = undefined;
 export declare type RegisterUnfurlQuery = {

package/sdk/core/cardintegration/cardintegrationconfig.d.ts

@@ -1,3 +1,4 @@
+import { TextStyle } from '../../document/text/textstyle';
 import { LucidCardFieldDisplaySettings, SerializedLucidCardFieldDisplaySettings } from './cardfielddisplaysettings';
 export interface CardIntegrationConfig {
     cardConfig: {
@@ -5,6 +6,11 @@ export interface CardIntegrationConfig {
          * The data fields to be displayed on cards, as data-linked text fields
          */
         fieldNames: string[];
+        /**
+         * The default text style to set on each of the above fields for new cards. Any style not specified
+         * will use a default value, and any field name not present will use all defaults.
+         */
+        fieldStyles?: Map<string, Partial<TextStyle>>;
         /**
          * The data fields to be displayed on cards as data graphics
          */
@@ -30,7 +36,8 @@ export interface CardIntegrationConfig {
 export declare type SerializedCardIntegrationConfig = {
     'cc': {
         'f': string[];
-        'fd'?: [string, SerializedLucidCardFieldDisplaySettings][];
+        'fd'?: [string, SerializedLucidCardFieldDisplaySettings][] | undefined;
+        'fs'?: [string, Partial<TextStyle>][] | undefined;
         'id'?: string | undefined;
     };
     'cdpc': {

package/sdk/core/cardintegration/cardintegrationconfig.js

@@ -13,6 +13,7 @@ function serializeCardIntegrationConfig(config) {
                     (0, cardfielddisplaysettings_1.serializeLucidCardFieldDisplaySettings)(settings),
                 ])
                 : undefined,
+            'fs': config.cardConfig.fieldStyles ? [...config.cardConfig.fieldStyles] : undefined,
         },
         'cdpc': {
             'f': config.cardDetailsPanelConfig.fields.map((field) => {
@@ -30,6 +31,7 @@ function deserializeCardIntegrationConfig(raw) {
     return {
         cardConfig: {
             fieldNames: raw['cc']['f'],
+            fieldStyles: raw['cc']['fs'] ? new Map(raw['cc']['fs']) : undefined,
             fieldDisplaySettings: raw['cc']['fd']
                 ? new Map(raw['cc']['fd'].map(([key, settings]) => [
                     key,

package/sdk/core/cardintegration/lucidcardintegration.d.ts

@@ -1,6 +1,7 @@
 import { CollectionDefinition } from '../../data/collectiondefinition';
 import { CollectionProxy } from '../../data/collectionproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
+import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { CardIntegrationConfig } from './cardintegrationconfig';
@@ -29,6 +30,12 @@ export declare abstract class LucidCardIntegration {
      * The name of the data connector associated with the card integration.
      */
     abstract dataConnectorName: string;
+    /**
+     * The default text style to use on cards created as part of this integration.
+     * These can be overridden by values in getDefaultConfig().fieldStyles for
+     * individual fields that should have different styles.
+     */
+    textStyle?: Partial<TextStyle>;
     abstract fieldConfiguration: {
         /**
          * Callback to provide a list of all supported field names for the card integration.

package/sdk/core/cardintegration/lucidcardintegrationregistry.js

@@ -60,6 +60,7 @@ class LucidCardIntegrationRegistry {
             'il': cardIntegration.itemLabel,
             'isl': cardIntegration.itemsLabel,
             'u': cardIntegration.iconUrl,
+            'ts': cardIntegration.textStyle,
             'fc': {
                 'gf': getFieldsActionName,
                 'osfc': onSelectedFieldsChangeActionName,

package/sdk/editorclient.d.ts

@@ -20,6 +20,13 @@ export declare type DataActionResponse = {
     /** The body of the HTTP Response (otherwise) */
     'text': string;
 });
+export declare type DataActionOptions = {
+    dataConnectorName: string;
+    actionName: string;
+    actionData?: unknown;
+    syncDataSourceIdNonce?: string;
+    asynchronous?: boolean;
+};
 export declare class EditorClient {
     private nextId;
     private readonly callbacks;
@@ -58,17 +65,7 @@ export declare class EditorClient {
      * @deprecated Use createUserImage instead.
      */
     experimentalCreateUserImage(mediaType: string, data: Uint8Array | string): Promise<string>;
-    /**
-     *
-     * @param flowName
-     * @param dataConnectorName
-     * @param syncDataSourceId
-     * @param flowData
-     * @param async
-     * @returns
-     * @throws A string with an error from the data sync server
-     */
-    performDataAction(flowName: string, dataConnectorName: string, syncDataSourceId?: undefined | string, flowData?: unknown, async?: boolean): Promise<DataActionResponse>;
+    performDataAction(options: DataActionOptions): Promise<DataActionResponse>;
     /**
      * If the extension package containing this editor extension has configurable settings,
      * show a standard modal allowing the user to view or change those settings.

package/sdk/editorclient.js

@@ -96,23 +96,16 @@ class EditorClient {
     experimentalCreateUserImage(mediaType, data) {
         return this.createUserImage(mediaType, data);
     }
-    /**
-     *
-     * @param flowName
-     * @param dataConnectorName
-     * @param syncDataSourceId
-     * @param flowData
-     * @param async
-     * @returns
-     * @throws A string with an error from the data sync server
-     */
-    async performDataAction(flowName, dataConnectorName, syncDataSourceId = undefined, flowData = undefined, async = true) {
+    async performDataAction(options) {
+        if (options.asynchronous === undefined) {
+            options.asynchronous = true;
+        }
         const result = await this.sendCommand("da" /* CommandName.DataAction */, {
-            'fn': flowName,
-            'a': async,
-            's': syncDataSourceId,
-            'fd': flowData,
-            'n': dataConnectorName,
+            'fn': options.actionName,
+            'a': options.asynchronous,
+            's': options.syncDataSourceIdNonce,
+            'fd': options.actionData,
+            'n': options.dataConnectorName,
         });
         if ('t' in result) {
             return {

package/sdk/ui/panel.d.ts

@@ -24,6 +24,8 @@ export interface PanelConfig {
     iconUrl: string;
     /** A tool tip to be displayed when hovering over the activation icon. */
     toolTip?: string;
+    /** If set true, we will persist the panel's iframe in the background if it's not currently active*/
+    persist?: boolean;
 }
 /**
  * Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed

package/sdk/ui/panel.js

@@ -37,6 +37,7 @@ class Panel extends iframeui_1.IframeUI {
             'v': this.config.visibleAction,
             'i': this.config.iconUrl,
             'to': this.config.toolTip,
+            'p': this.config.persist,
         });
     }
     /**