lucid-extension-sdk 0.0.336 → 0.0.338

package/commandtypes.d.ts

@@ -964,8 +964,19 @@ export type AddSpreadsheetIntegrationQuery = {
     };
     /** getMultipleSheetsForSpreadsheetDetails */
     'gm': string;
+    /** IconConfiguration */
+    'icu'?: {
+        /** Primary Icon Url */
+        'pi': string;
+        /** Light Icon URl */
+        'li'?: string;
+        /** Dark Icon URl */
+        'di'?: string;
+    } | undefined;
     /** addCardsIntegration */
     'c'?: boolean;
+    /** getUpstreamSourceUrl */
+    'gu'?: string;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationResult = undefined;

package/core/data/fieldtypedefinition/lucidfields.d.ts

@@ -14,6 +14,8 @@
  * Integration Simplicity: Simplifies the process of integrating new data sources into Lucid by mapping to an established set of Lucid Fields.
  * Feature Compatibility: Allows for seamless use of Lucid’s intelligent features across all data, regardless of its origin.
  * Data Organization: Provides a structured approach to organizing and grouping data within the Lucid ecosystem.
+ *
+ * Must be kept in sync with src/jvm/com/lucidchart/data/model/fielddefinition/LucidFields.scala
  */
 export declare enum LucidFields {
     /**

package/core/data/fieldtypedefinition/lucidfields.js

@@ -18,6 +18,8 @@ const validators_1 = require("../../validators/validators");
  * Integration Simplicity: Simplifies the process of integrating new data sources into Lucid by mapping to an established set of Lucid Fields.
  * Feature Compatibility: Allows for seamless use of Lucid’s intelligent features across all data, regardless of its origin.
  * Data Organization: Provides a structured approach to organizing and grouping data within the Lucid ecosystem.
+ *
+ * Must be kept in sync with src/jvm/com/lucidchart/data/model/fielddefinition/LucidFields.scala
  */
 var LucidFields;
 (function (LucidFields) {

package/core/data/serializedfield/lucidfielddefaults.d.ts

@@ -0,0 +1,18 @@
+import { LucidFields } from '../fieldtypedefinition/lucidfields';
+export type SerializedLucidFieldDefaults = {
+    [key in LucidFields]?: string;
+};
+export declare const isSerializedLucidFieldDefaults: (defaults: any) => defaults is SerializedLucidFieldDefaults;
+export declare function serializeLucidFieldDefaults(defaults: LucidFieldDefaults): SerializedLucidFieldDefaults;
+export type LucidFieldDefaults = Map<LucidFields, string>;
+export declare function isLucidFieldDefaults(data: any): data is LucidFieldDefaults;
+export declare class LucidFieldDefaultsFactory {
+    static deserializeLucidFieldDefaults(serializeDefaults: SerializedLucidFieldDefaults): LucidFieldDefaults;
+    /**
+     * Merge two LucidFieldDefaults together, with `first` taking precedence over `second`.
+     * @param first prioritized defaults
+     * @param second secondary defaults to be merged
+     * @returns merged LucidFieldDefaults
+     */
+    static merge(first: LucidFieldDefaults, second: LucidFieldDefaults): LucidFieldDefaults;
+}

package/core/data/serializedfield/lucidfielddefaults.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LucidFieldDefaultsFactory = exports.isLucidFieldDefaults = exports.serializeLucidFieldDefaults = exports.isSerializedLucidFieldDefaults = void 0;
+const checks_1 = require("../../checks");
+const lucidfields_1 = require("../fieldtypedefinition/lucidfields");
+exports.isSerializedLucidFieldDefaults = (0, checks_1.isRecord)(checks_1.isString);
+function serializeLucidFieldDefaults(defaults) {
+    const res = {};
+    for (const [key, value] of defaults.entries()) {
+        res[key] = value;
+    }
+    return res;
+}
+exports.serializeLucidFieldDefaults = serializeLucidFieldDefaults;
+function isLucidFieldDefaults(data) {
+    return data instanceof Map && [...data.keys()].every((key) => key in lucidfields_1.LucidFields);
+}
+exports.isLucidFieldDefaults = isLucidFieldDefaults;
+class LucidFieldDefaultsFactory {
+    static deserializeLucidFieldDefaults(serializeDefaults) {
+        const res = new Map();
+        for (const [key, value] of Object.entries(serializeDefaults)) {
+            if ((0, lucidfields_1.isLucidFields)(key)) {
+                res.set(key, value);
+            }
+        }
+        return res;
+    }
+    /**
+     * Merge two LucidFieldDefaults together, with `first` taking precedence over `second`.
+     * @param first prioritized defaults
+     * @param second secondary defaults to be merged
+     * @returns merged LucidFieldDefaults
+     */
+    static merge(first, second) {
+        return new Map([...second.entries(), ...first.entries()]);
+    }
+}
+exports.LucidFieldDefaultsFactory = LucidFieldDefaultsFactory;

package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -49,9 +49,32 @@ export declare class CustomDetailsChooser {
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare abstract class LucidSpreadsheetIntegration {
     abstract labelDescription: string;
+    /**
+     * @deprecated Use iconConfiguration.primaryIconUrl.
+     */
     abstract labelIconUrl: string;
+    iconConfiguration?: {
+        /**
+         * URL for the primary icon to display in most components, usually on a white background.
+         * Should be at least 24x24.
+         */
+        primaryIconUrl: string;
+        /**
+         * Optional. URL for an alternate light icon to show in colored components where the primary icon may appear too dark.
+         * If not provided, the primaryIconUrl will be used. Should be at least 24x24.
+         */
+        lightIconUrl?: string;
+        /**
+         * Optional. URL for an alternate dark icon to show in colored components where the primary icon may appear too light.
+         * If not provided, the primaryIconUrl will be used. Should be at least 24x24.
+         */
+        darkIconUrl?: string;
+    };
     abstract dataConnectorName: string;
     addCardsIntegration: boolean;
     abstract configChooser: ListChooser | CustomDetailsChooser;
     abstract getMultipleSheetsForSpreadsheetDetails(spreadsheetDetails: string): Promise<Map<string, string> | LucidSpreadsheetIntegrationFailureType>;
+    getUpstreamSourceUrl?(spreadsheetDetails: string, sheetId: string): Promise<{
+        url: string;
+    } | LucidSpreadsheetIntegrationFailureType>;
 }

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -66,6 +66,33 @@ class LucidSpreadsheetIntegrationRegistry {
             'gs': configChooserActions,
             'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
         };
+        if (spreadsheetIntegration.iconConfiguration) {
+            serialized['icu'] = {
+                'pi': spreadsheetIntegration.iconConfiguration.primaryIconUrl,
+                'li': spreadsheetIntegration.iconConfiguration.lightIconUrl,
+                'di': spreadsheetIntegration.iconConfiguration.darkIconUrl,
+            };
+        }
+        if (spreadsheetIntegration.getUpstreamSourceUrl) {
+            const getUpstreamSourceUrl = LucidSpreadsheetIntegrationRegistry.nextHookName();
+            client.registerAction(getUpstreamSourceUrl, async (message) => {
+                try {
+                    if (!spreadsheetIntegration.getUpstreamSourceUrl) {
+                        return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
+                    }
+                    const result = await spreadsheetIntegration.getUpstreamSourceUrl(message['spreadsheetDetails'], message['sheetId']);
+                    if ((0, lucidspreadsheetintegration_1.lucidSpreadsheetIntegrationFailureTypeValidator)(result)) {
+                        return result;
+                    }
+                    else {
+                        return result.url;
+                    }
+                }
+                catch (error) { }
+                return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
+            });
+            serialized['gu'] = getUpstreamSourceUrl;
+        }
         client.sendCommand("asi" /* CommandName.AddSpreadsheetIntegration */, serialized);
     }
 }

package/package.json

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