lucid-extension-sdk 0.0.337 → 0.0.339

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/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/dataconnector/datasourceupdatetypes.d.ts

@@ -128,6 +128,8 @@ export interface CollectionPatch {
     represents?: SemanticCollection[];
     /** The collection's display name */
     name?: string | undefined;
+    /** Whether the collection is hidden from the data panel */
+    hideFromDataPanel?: boolean;
 }
 /** @ignore */
 export declare function serializeFieldDefinitionForApi(field: FieldDefinition): SerializedFieldDefinitionForApi;

package/dataconnector/datasourceupdatetypes.js

@@ -85,10 +85,18 @@ function serializeNameAsPropertyForApi(name) {
         'Name': name, // key needs to match 'Name' key in cake/app/webroot/ts/property/collection/collectionproperties.ts
     };
 }
+function serializeHiddenFromDataPanelForApi(hiddenFromDataPanel) {
+    return {
+        'IsHiddenFromDataPanel': hiddenFromDataPanel, // key needs to match 'IsHiddenFromDataPanel' key in cake/app/webroot/ts/property/collection/collectionproperties.ts
+    };
+}
 function serializeCollectionPatch(patch) {
     const representsProperty = patch.represents && serializeRepresentsAsPropertyForApi(patch.represents);
     const nameProperty = (0, checks_1.isString)(patch.name) ? serializeNameAsPropertyForApi(patch.name) : undefined;
-    const properties = (representsProperty || nameProperty) && Object.assign(Object.assign({}, representsProperty), nameProperty);
+    const isHiddenFromDataPanelProperty = (0, checks_1.isDef)(patch.hideFromDataPanel)
+        ? serializeHiddenFromDataPanelForApi(patch.hideFromDataPanel)
+        : undefined;
+    const properties = (representsProperty || nameProperty || isHiddenFromDataPanelProperty) && Object.assign(Object.assign(Object.assign({}, representsProperty), nameProperty), isHiddenFromDataPanelProperty);
     return {
         'schema': patch.schema && serializeSchemaForApi(patch.schema),
         'itemsPatch': serializeItemsPatch(patch.patch),

package/package.json

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