lucid-extension-sdk 0.0.57 → 0.0.59

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -420,14 +420,21 @@ export declare type CommandArgs = {
 export declare type AddCardIntegrationQuery = {
     /** Title/name */
     'n': string;
+    /** Data connector name */
+    'dcn': string;
     /** Item label */
     'il': string;
     /** Items label */
     'isl': string;
     /** Icon url */
     'u': string;
-    /** Callback to get field definitions for a given imported collection */
-    'gf': string;
+    /** Field configuration */
+    'fc': {
+        /** Callback to get field definitions for all fields supported by the card integration */
+        'gf': string;
+        /** Callback to handle a change in the fields the user want to be displayed */
+        'osfc'?: string;
+    };
     /** Show intro if user has not yet authorized this integration */
     'i'?: string;
     /** Get default config action */

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

@@ -1,5 +1,6 @@
 import { CollectionDefinition } from '../../data/collectiondefinition';
 import { CollectionProxy } from '../../data/collectionproxy';
+import { DataSourceProxy } from '../../data/datasourceproxy';
 import { FieldDefinition } from '../../data/schemadefinition';
 import { isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
@@ -105,13 +106,23 @@ export interface CardIntegration {
      */
     iconUrl: string;
     /**
-     * Callback to provide a list of field definitions for the given collection, if that collection
-     * was imported as part of this card integration.
-     *
-     * Any fields on the schema of the collection that you don't provide a ExtensionCardFieldDefinition
-     * for will have a default definition generated based on the type specified in the schema.
+     * The name of the data connector associated with the card integration.
      */
-    getAllFields: (collection: CollectionProxy) => Promise<ExtensionCardFieldDefinition[]>;
+    dataConnectorName: string;
+    fieldConfiguration: {
+        /**
+         * Callback to provide a list of all supported field definitions for the card integration.
+         *
+         * Any fields on the schema of the collection that you don't provide a ExtensionCardFieldDefinition
+         * for will have a default definition generated based on the type specified in the schema.
+         */
+        getAllFields: (collection: CollectionProxy) => Promise<ExtensionCardFieldDefinition[]>;
+        /**
+         * Callback that handled changes in the fields the user wants to be displayed in the card integration.
+         * If this callback is not provided then the user will not be shown the modal to configure fields.
+         */
+        onSelectedFieldsChange?: (dataSource: DataSourceProxy, selectedFields: string[]) => void;
+    };
     /**
      * If specified, and the user hasn't yet authorized the data connector for this extension,
      * this should show the user an intro dialog or take some other action.

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

@@ -1,23 +1,48 @@
 import { LucidCardFieldDisplaySettings, SerializedLucidCardFieldDisplaySettings } from './cardfielddisplaysettings';
 export interface CardIntegrationConfig {
-    /**
-     * The data fields to be displayed on cards, as data-linked text fields
-     */
-    fieldNames: string[];
-    /**
-     * The data fields to be displayed on cards as data graphics
-     */
-    fieldDisplaySettings?: Map<string, LucidCardFieldDisplaySettings>;
-    /**
-     * The field name to use as the displayed ID of the card, if any
-     */
-    idFieldName?: string;
+    cardConfig: {
+        /**
+         * The data fields to be displayed on cards, as data-linked text fields
+         */
+        fieldNames: string[];
+        /**
+         * The data fields to be displayed on cards as data graphics
+         */
+        fieldDisplaySettings?: Map<string, LucidCardFieldDisplaySettings>;
+        /**
+         * The field name to use as the displayed ID of the card, if any
+         */
+        idFieldName?: string;
+    };
+    cardDetailsPanelConfig: {
+        /**
+         * The data fields to be displayed in the details panel of a card
+         */
+        fields: {
+            /**
+             * The field name
+             */
+            name: string;
+            /**
+             * If true then the visibility of this field in the details panel cannot be modified by a user.
+             */
+            locked?: boolean;
+        }[];
+    };
 }
 /** @ignore */
 export declare type SerializedCardIntegrationConfig = {
-    'f': string[];
-    'fd'?: [string, SerializedLucidCardFieldDisplaySettings][];
-    'id'?: string;
+    'cc': {
+        'f': string[];
+        'fd'?: [string, SerializedLucidCardFieldDisplaySettings][];
+        'id'?: string;
+    };
+    'cdpc': {
+        'f': {
+            'n': string;
+            'l'?: boolean;
+        }[];
+    };
 };
 /** @ignore */
 export declare function serializeCardIntegrationConfig(config: CardIntegrationConfig): SerializedCardIntegrationConfig;

package/sdk/core/cardintegration/cardintegrationconfig.js

@@ -5,25 +5,48 @@ const cardfielddisplaysettings_1 = require("./cardfielddisplaysettings");
 /** @ignore */
 function serializeCardIntegrationConfig(config) {
     return {
-        'f': config.fieldNames,
-        'fd': config.fieldDisplaySettings
-            ? [...config.fieldDisplaySettings].map(([key, settings]) => [
-                key,
-                (0, cardfielddisplaysettings_1.serializeLucidCardFieldDisplaySettings)(settings),
-            ])
-            : undefined,
-        'id': config.idFieldName,
+        'cc': {
+            'f': config.cardConfig.fieldNames,
+            'fd': config.cardConfig.fieldDisplaySettings
+                ? [...config.cardConfig.fieldDisplaySettings].map(([key, settings]) => [
+                    key,
+                    (0, cardfielddisplaysettings_1.serializeLucidCardFieldDisplaySettings)(settings),
+                ])
+                : undefined,
+            'id': config.cardConfig.idFieldName,
+        },
+        'cdpc': {
+            'f': config.cardDetailsPanelConfig.fields.map((field) => {
+                return {
+                    'n': field.name,
+                    'l': field.locked,
+                };
+            }),
+        },
     };
 }
 exports.serializeCardIntegrationConfig = serializeCardIntegrationConfig;
 /** @ignore */
 function deserializeCardIntegrationConfig(raw) {
     return {
-        fieldNames: raw['f'],
-        fieldDisplaySettings: raw['fd']
-            ? new Map(raw['fd'].map(([key, settings]) => [key, (0, cardfielddisplaysettings_1.deserializeLucidCardFieldDisplaySettings)(settings)]))
-            : undefined,
-        idFieldName: raw['id'],
+        cardConfig: {
+            fieldNames: raw['cc']['f'],
+            fieldDisplaySettings: raw['cc']['fd']
+                ? new Map(raw['cc']['fd'].map(([key, settings]) => [
+                    key,
+                    (0, cardfielddisplaysettings_1.deserializeLucidCardFieldDisplaySettings)(settings),
+                ]))
+                : undefined,
+            idFieldName: raw['cc']['id'],
+        },
+        cardDetailsPanelConfig: {
+            fields: raw['cdpc']['f'].map((field) => {
+                return {
+                    name: field['n'],
+                    locked: field['l'],
+                };
+            }),
+        },
     };
 }
 exports.deserializeCardIntegrationConfig = deserializeCardIntegrationConfig;

package/sdk/core/unfurl/unfurliframe.d.ts

@@ -1,4 +1,5 @@
 import { isString } from '../checks';
+import { IframeAttributes } from '../iframe/iframeutils';
 /**
  * An enumeration of of the supported unfurl Iframe aspect ratio.
  * The iframe will be maximized to fit the screen responsively
@@ -64,3 +65,4 @@ export declare function serializeUnfurlIframe(concrete: UnfurlIframe): Serialize
 export declare function getIFrameHeight(unfurlIframeAspectRatio: UnfurlIframeAspectRatio): number;
 /** @ignore */
 export declare function getIFrameWidth(unfurlIframeAspectRatio: UnfurlIframeAspectRatio): number;
+export declare function generateIframeAttributes(unfurlIframe: UnfurlIframe): IframeAttributes;

package/sdk/core/unfurl/unfurliframe.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIFrameWidth = exports.getIFrameHeight = exports.serializeUnfurlIframe = exports.deserializeUnfurlIframe = exports.isValidUnfurlIframe = exports.UnfurlIframeAspectRatio = void 0;
+exports.generateIframeAttributes = exports.getIFrameWidth = exports.getIFrameHeight = exports.serializeUnfurlIframe = exports.deserializeUnfurlIframe = exports.isValidUnfurlIframe = exports.UnfurlIframeAspectRatio = void 0;
 const checks_1 = require("../checks");
+const iframeutils_1 = require("../iframe/iframeutils");
 const validators_1 = require("../validators/validators");
 /**
  * An enumeration of of the supported unfurl Iframe aspect ratio.
@@ -91,3 +92,13 @@ function getIFrameWidth(unfurlIframeAspectRatio) {
     }
 }
 exports.getIFrameWidth = getIFrameWidth;
+function generateIframeAttributes(unfurlIframe) {
+    const iframeAttributes = {
+        src: unfurlIframe.iframeUrl,
+        height: unfurlIframe.aspectRatio ? getIFrameHeight(unfurlIframe.aspectRatio) : iframeutils_1.DEFAULT_IFRAME_HEIGHT,
+        width: unfurlIframe.aspectRatio ? getIFrameWidth(unfurlIframe.aspectRatio) : iframeutils_1.DEFAULT_IFRAME_WIDTH,
+        title: unfurlIframe.iframeTitle,
+    };
+    return iframeAttributes;
+}
+exports.generateIframeAttributes = generateIframeAttributes;

package/sdk/data/datasourceproxy.d.ts

@@ -11,7 +11,7 @@ import { SchemaDefinition } from './schemadefinition';
 export declare class DataSourceProxy extends PropertyStoreProxy {
     readonly id: string;
     /**
-     * @param id ID of the collection on the current document
+     * @param id ID of the dataSource on the current document
      * @param client
      */
     constructor(id: string, client: EditorClient);

package/sdk/data/datasourceproxy.js

@@ -12,7 +12,7 @@ const collectionproxy_1 = require("./collectionproxy");
  */
 class DataSourceProxy extends propertystoreproxy_1.PropertyStoreProxy {
     /**
-     * @param id ID of the collection on the current document
+     * @param id ID of the dataSource on the current document
      * @param client
      */
     constructor(id, client) {

package/sdk/document/blockclasses/linkunfurlblockproxy.js

@@ -41,12 +41,7 @@ class ExperimentalLinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
      * @ignore
      */
     setIframe(unfurlIframe) {
-        const iframeAttributes = {
-            src: unfurlIframe.iframeUrl,
-            height: unfurlIframe.aspectRatio ? (0, unfurliframe_1.getIFrameHeight)(unfurlIframe.aspectRatio) : iframeutils_1.DEFAULT_IFRAME_HEIGHT,
-            width: unfurlIframe.aspectRatio ? (0, unfurliframe_1.getIFrameWidth)(unfurlIframe.aspectRatio) : iframeutils_1.DEFAULT_IFRAME_WIDTH,
-            title: unfurlIframe.iframeTitle,
-        };
+        const iframeAttributes = (0, unfurliframe_1.generateIframeAttributes)(unfurlIframe);
         this.properties.set('LinkUnfurlIframeHtml', (0, iframeutils_1.generateIFrameHTML)(iframeAttributes));
         this.properties.set('LinkUnfurlIframeHeight', iframeAttributes.height);
         this.properties.set('LinkUnfurlIframeWidth', iframeAttributes.width);

package/sdk/document/taskmanagementcardintegration.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskManagementCardIntegration = void 0;
+const lucid_extension_sdk_1 = require("../../lucid-extension-sdk");
 const cardintegration_1 = require("../core/cardintegration/cardintegration");
 const cardintegrationconfig_1 = require("../core/cardintegration/cardintegrationconfig");
 const collectiondefinition_1 = require("../data/collectiondefinition");
@@ -36,10 +37,19 @@ class TaskManagementCardIntegration {
         const getFieldsActionName = TaskManagementCardIntegration.nextHookName();
         this.client.registerAction(getFieldsActionName, async (param) => {
             const collection = new collectionproxy_1.CollectionProxy(param['c'], this.client);
-            const fields = await card.getAllFields(collection);
+            const fields = await card.fieldConfiguration.getAllFields(collection);
             const serializedFields = (0, cardintegration_1.serializeCardFieldArrayDefinition)(fields);
             return serializedFields;
         });
+        let onSelectedFieldsChangeActionName = undefined;
+        const onSelectedFieldsChange = card.fieldConfiguration.onSelectedFieldsChange;
+        if (onSelectedFieldsChange) {
+            onSelectedFieldsChangeActionName = TaskManagementCardIntegration.nextHookName();
+            this.client.registerAction(onSelectedFieldsChangeActionName, (param) => {
+                const dataSource = new lucid_extension_sdk_1.DataSourceProxy(param['ds'], this.client);
+                onSelectedFieldsChange(dataSource, param['sf']);
+            });
+        }
         const getDefaultConfigActionName = TaskManagementCardIntegration.nextHookName();
         this.client.registerAction(getDefaultConfigActionName, async (param) => {
             const collection = new collectionproxy_1.CollectionProxy(param['c'], this.client);
@@ -52,10 +62,14 @@ class TaskManagementCardIntegration {
         }
         const serialized = {
             'n': card.label,
+            'dcn': card.dataConnectorName,
             'il': card.itemLabel,
             'isl': card.itemsLabel,
             'u': card.iconUrl,
-            'gf': getFieldsActionName,
+            'fc': {
+                'gf': getFieldsActionName,
+                'osfc': onSelectedFieldsChangeActionName,
+            },
             'gdc': getDefaultConfigActionName,
             'i': showIntroActionName,
         };