lucid-extension-sdk 0.0.51 → 0.0.52

package/package.json

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

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

@@ -19,7 +19,16 @@ export declare enum FieldDisplayType {
      * Given a number, display the number in the bottom-left of the card. If the number is higher than 999,
      * display 999.
      */
-    StandardEstimation = "StandardEstimation"
+    StandardEstimation = "StandardEstimation",
+    /**
+     * Given a URL, display a small image cropped into a circle in the lower-left of the card.
+     */
+    ImageBadge = "ImageBadge",
+    /**
+     * Given a date, display a small calendar icon alongside a very short version of the date
+     * as a string, e.g. "Sep 9"
+     */
+    DateBadge = "DateBadge"
 }
 export declare const isFieldDisplayType: (x: unknown) => x is FieldDisplayType;
 /**
@@ -30,9 +39,13 @@ export declare enum OnClickHandlerKeys {
     /**
      * Display the UI panel to edit fields on the data associated with the card
      */
-    BasicEditPanel = "BasicEditPanel"
+    BasicEditPanel = "BasicEditPanel",
+    /**
+     * Open a new browser window to a URL specified by linkFormula
+     */
+    OpenBrowserWindow = "OpenBrowserWindow"
 }
-export declare const isOnClickHandlerKey: (x: unknown) => x is OnClickHandlerKeys.BasicEditPanel;
+export declare const isOnClickHandlerKey: (x: unknown) => x is OnClickHandlerKeys;
 export interface StencilConfig {
     /**
      * How should we generate the stencil/data graphic from the specified field value?
@@ -48,6 +61,19 @@ export interface StencilConfig {
      * by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
      */
     backgroundColor?: string;
+    /**
+     * If specified, the result of this formula (executed in the context of the data item
+     * associated with this card) will be used instead of the raw field value when
+     * creating the data graphic. This can be useful if, for example, you see to convert
+     * an ID into a URL.
+     */
+    valueFormula?: string;
+    /**
+     * If specified, the result of this formula (executed in the context of the data item
+     * associated with this card) will be used as a tooltip when the user hovers the
+     * cursor over this data graphic.
+     */
+    tooltipFormula?: string;
     /**
      * Each display type has its default location on the card. You can override those
      * default locations by setting these values.
@@ -63,6 +89,10 @@ export interface StencilConfig {
      * generated via the above displayType?
      */
     onClickHandlerKey?: OnClickHandlerKeys;
+    /**
+     * If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
+     */
+    linkFormula?: string;
 }
 /**
  * Configuration settings for how to display a particular field on the card itself.
@@ -77,6 +107,9 @@ export declare type SerializedLucidCardFieldDisplaySettings = {
         /** Since renamed to displayType, but we can't change the serialized name */
         'getterKey': FieldDisplayType;
         'bg'?: string;
+        'f'?: string;
+        't'?: string;
+        'l'?: string;
         'h'?: HorizontalBadgePos;
         'v'?: VerticalBadgePos;
         'onClickHandlerKey'?: OnClickHandlerKeys;

package/sdk/core/cardintegration/cardfielddisplaysettings.js

@@ -24,6 +24,15 @@ var FieldDisplayType;
      * display 999.
      */
     FieldDisplayType["StandardEstimation"] = "StandardEstimation";
+    /**
+     * Given a URL, display a small image cropped into a circle in the lower-left of the card.
+     */
+    FieldDisplayType["ImageBadge"] = "ImageBadge";
+    /**
+     * Given a date, display a small calendar icon alongside a very short version of the date
+     * as a string, e.g. "Sep 9"
+     */
+    FieldDisplayType["DateBadge"] = "DateBadge";
 })(FieldDisplayType = exports.FieldDisplayType || (exports.FieldDisplayType = {}));
 exports.isFieldDisplayType = (0, validators_1.enumValidator)(FieldDisplayType);
 /**
@@ -36,6 +45,10 @@ var OnClickHandlerKeys;
      * Display the UI panel to edit fields on the data associated with the card
      */
     OnClickHandlerKeys["BasicEditPanel"] = "BasicEditPanel";
+    /**
+     * Open a new browser window to a URL specified by linkFormula
+     */
+    OnClickHandlerKeys["OpenBrowserWindow"] = "OpenBrowserWindow";
 })(OnClickHandlerKeys = exports.OnClickHandlerKeys || (exports.OnClickHandlerKeys = {}));
 exports.isOnClickHandlerKey = (0, validators_1.enumValidator)(OnClickHandlerKeys);
 /** @ignore */
@@ -43,6 +56,9 @@ function serializeLucidCardFieldDisplaySettings(settings) {
     return {
         'StencilConfig': settings.stencilConfig && {
             'getterKey': settings.stencilConfig.displayType,
+            'f': settings.stencilConfig.valueFormula,
+            't': settings.stencilConfig.tooltipFormula,
+            'l': settings.stencilConfig.linkFormula,
             'bg': settings.stencilConfig.backgroundColor,
             'h': settings.stencilConfig.horizontalPosition,
             'v': settings.stencilConfig.verticalPosition,
@@ -56,6 +72,9 @@ function deserializeLucidCardFieldDisplaySettings(settings) {
     return {
         stencilConfig: settings['StencilConfig'] && {
             displayType: settings['StencilConfig']['getterKey'],
+            valueFormula: settings['StencilConfig']['f'],
+            tooltipFormula: settings['StencilConfig']['t'],
+            linkFormula: settings['StencilConfig']['l'],
             backgroundColor: settings['StencilConfig']['bg'],
             horizontalPosition: settings['StencilConfig']['h'],
             verticalPosition: settings['StencilConfig']['v'],