lucid-extension-sdk 0.0.368 → 0.0.369

package/commandtypes.d.ts

@@ -1,3 +1,4 @@
+import { SerializedCardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
 import { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
 import { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
 import { SerializedFieldType } from './core/data/serializedfield/serializedfields';
@@ -71,6 +72,7 @@ export declare const enum CommandName {
     ExecuteFormula = "ef",
     FindAvailableSpace = "fas",
     FireBeaconEvent = "fbe",
+    GetCardIntegrationConfig = "gcic",
     GetConnectedLines = "gcl",
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
@@ -155,6 +157,7 @@ export declare const enum CommandName {
     UnhookDeleteItems = "udi",
     UnhookSelection = "us",
     UnhookTextEdit = "ute",
+    UpdateCardIntegrationConfig = "ucic",
     WithMutex = "wm",
     WithSilentActions = "wsa",
     ZOrder = "z"
@@ -353,6 +356,10 @@ export type CommandArgs = {
         query: FireBeaconEventQuery;
         result: FireBeaconEventResult;
     };
+    [CommandName.GetCardIntegrationConfig]: {
+        query: GetCardIntegrationConfigQuery;
+        result: GetCardIntegrationConfigResult;
+    };
     [CommandName.GetConnectedLines]: {
         query: GetConnectedLinesQuery;
         result: GetConnectedLinesResult;
@@ -689,6 +696,10 @@ export type CommandArgs = {
         query: UnhookTextEditQuery;
         result: UnhookTextEditResult;
     };
+    [CommandName.UpdateCardIntegrationConfig]: {
+        query: UpdateCardIntegrationConfigQuery;
+        result: UpdateCardIntegrationConfigResult;
+    };
     [CommandName.WithMutex]: {
         query: WithMutexQuery;
         result: WithMutexResult;
@@ -1300,6 +1311,8 @@ export type GetEnvironmentConfigQuery = string;
 export type GetEnvironmentConfigResult = JsonSerializable;
 export type GetConnectedLinesQuery = string;
 export type GetConnectedLinesResult = string[];
+export type GetCardIntegrationConfigQuery = string;
+export type GetCardIntegrationConfigResult = SerializedCardIntegrationConfig | undefined;
 export type GetCurrentPageQuery = void;
 export type GetCurrentPageResult = string | undefined;
 export type GetCustomShapeQuery = {
@@ -1907,6 +1920,13 @@ export type UnhookTextEditQuery = {
     'n': string;
 };
 export type UnhookTextEditResult = undefined;
+export type UpdateCardIntegrationConfigQuery = {
+    /** The data source ID whose config should be updated */
+    'd': string;
+    /** The serialized card integration config that should be inserted for the given data source ID */
+    'c': SerializedCardIntegrationConfig;
+};
+export type UpdateCardIntegrationConfigResult = void;
 export type WithMutexQuery = {
     /** Name of the intra-document mutex to hold for the duration of this action */
     'n': string;

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -1,3 +1,4 @@
+import { isNumber } from '../checks';
 import { HorizontalBadgePos, VerticalBadgePos } from '../properties/datagraphic/badgeposition';
 /**
  * When configuring a field on a LucidCardBlock to be displayed as a data graphic, one of these values specifies
@@ -67,17 +68,17 @@ export type ImageBadgeSettings = {
     width: number;
 };
 export type TextBadgeSettings = {
-    bold?: boolean;
-    italic?: boolean;
-    underline?: boolean;
-    rounding?: number;
-    minwidth?: number;
-    minheight?: number;
-    maxfontsize?: number;
-    maxtextwidth?: number;
-    iswithinpill?: boolean;
-    usingcarduirefresh?: boolean;
-    hasleadingicon?: boolean;
+    bold?: boolean | undefined;
+    italic?: boolean | undefined;
+    underline?: boolean | undefined;
+    rounding?: number | undefined;
+    minwidth?: number | undefined;
+    minheight?: number | undefined;
+    maxfontsize?: number | undefined;
+    maxtextwidth?: number | undefined;
+    iswithinpill?: boolean | undefined;
+    usingcarduirefresh?: boolean | undefined;
+    hasleadingicon?: boolean | undefined;
 };
 export interface StencilConfig {
     /**
@@ -159,18 +160,48 @@ export type SerializedLucidCardFieldDisplaySettings = {
     'StencilConfig'?: {
         /** Since renamed to displayType, but we can't change the serialized name */
         'getterKey': FieldDisplayType;
-        'fg'?: string;
-        'bg'?: string;
-        'f'?: string;
-        't'?: string;
-        'l'?: string;
-        'h'?: HorizontalBadgePos;
-        'v'?: VerticalBadgePos;
-        'onClickHandlerKey'?: OnClickHandlerKeys;
-        'imageBadgeSettings'?: ImageBadgeSettings;
-        'textBadgeSettings'?: TextBadgeSettings;
-    };
+        'fg'?: string | undefined;
+        'bg'?: string | undefined;
+        'f'?: string | undefined;
+        't'?: string | undefined;
+        'l'?: string | undefined;
+        'h'?: HorizontalBadgePos | undefined;
+        'v'?: VerticalBadgePos | undefined;
+        'onClickHandlerKey'?: OnClickHandlerKeys | undefined;
+        'imageBadgeSettings'?: ImageBadgeSettings | undefined;
+        'textBadgeSettings'?: TextBadgeSettings | undefined;
+    } | undefined;
 };
+export declare const isSerializedLucidCardFieldSettings: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    StencilConfig: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        getterKey: (x: unknown) => x is FieldDisplayType;
+        fg: (x: unknown) => x is string | undefined;
+        bg: (x: unknown) => x is string | undefined;
+        f: (x: unknown) => x is string | undefined;
+        t: (x: unknown) => x is string | undefined;
+        l: (x: unknown) => x is string | undefined;
+        h: (x: unknown) => x is HorizontalBadgePos | undefined;
+        v: (x: unknown) => x is VerticalBadgePos | undefined;
+        onClickHandlerKey: (x: unknown) => x is OnClickHandlerKeys | undefined;
+        imageBadgeSettings: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+            height: typeof isNumber;
+            width: typeof isNumber;
+        }> | undefined;
+        textBadgeSettings: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+            bold: (x: unknown) => x is boolean | undefined;
+            italic: (x: unknown) => x is boolean | undefined;
+            underline: (x: unknown) => x is boolean | undefined;
+            rounding: (x: unknown) => x is number | undefined;
+            minwidth: (x: unknown) => x is number | undefined;
+            minheight: (x: unknown) => x is number | undefined;
+            maxfontsize: (x: unknown) => x is number | undefined;
+            maxtextwidth: (x: unknown) => x is number | undefined;
+            iswithinpill: (x: unknown) => x is boolean | undefined;
+            usingcarduirefresh: (x: unknown) => x is boolean | undefined;
+            hasleadingicon: (x: unknown) => x is boolean | undefined;
+        }> | undefined;
+    }> | undefined;
+}>;
 /** @ignore */
 export declare function serializeLucidCardFieldDisplaySettings(settings: LucidCardFieldDisplaySettings): SerializedLucidCardFieldDisplaySettings;
 /** @ignore */

package/core/cardintegration/cardfielddisplaysettings.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LucidCardFields = exports.StatusValues = exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
+exports.LucidCardFields = exports.StatusValues = exports.deserializeLucidCardFieldDisplaySettings = exports.serializeLucidCardFieldDisplaySettings = exports.isSerializedLucidCardFieldSettings = exports.isOnClickHandlerKey = exports.OnClickHandlerKeys = exports.isFieldDisplayType = exports.FieldDisplayType = void 0;
+const checks_1 = require("../checks");
+const badgeposition_1 = require("../properties/datagraphic/badgeposition");
 const validators_1 = require("../validators/validators");
 /**
  * When configuring a field on a LucidCardBlock to be displayed as a data graphic, one of these values specifies
@@ -67,6 +69,39 @@ var OnClickHandlerKeys;
     OnClickHandlerKeys["CustomEditAction"] = "CustomEditAction";
 })(OnClickHandlerKeys || (exports.OnClickHandlerKeys = OnClickHandlerKeys = {}));
 exports.isOnClickHandlerKey = (0, validators_1.enumValidator)(OnClickHandlerKeys);
+const isImageBadgeSettings = (0, validators_1.objectValidator)({
+    'height': checks_1.isNumber,
+    'width': checks_1.isNumber,
+});
+const isTextBadgeSettings = (0, validators_1.objectValidator)({
+    'bold': (0, validators_1.option)(checks_1.isBoolean),
+    'italic': (0, validators_1.option)(checks_1.isBoolean),
+    'underline': (0, validators_1.option)(checks_1.isBoolean),
+    'rounding': (0, validators_1.option)(checks_1.isNumber),
+    'minwidth': (0, validators_1.option)(checks_1.isNumber),
+    'minheight': (0, validators_1.option)(checks_1.isNumber),
+    'maxfontsize': (0, validators_1.option)(checks_1.isNumber),
+    'maxtextwidth': (0, validators_1.option)(checks_1.isNumber),
+    'iswithinpill': (0, validators_1.option)(checks_1.isBoolean),
+    'usingcarduirefresh': (0, validators_1.option)(checks_1.isBoolean),
+    'hasleadingicon': (0, validators_1.option)(checks_1.isBoolean),
+});
+const isStencilConfig = (0, validators_1.objectValidator)({
+    'getterKey': exports.isFieldDisplayType,
+    'fg': (0, validators_1.option)(checks_1.isString),
+    'bg': (0, validators_1.option)(checks_1.isString),
+    'f': (0, validators_1.option)(checks_1.isString),
+    't': (0, validators_1.option)(checks_1.isString),
+    'l': (0, validators_1.option)(checks_1.isString),
+    'h': (0, validators_1.option)((0, validators_1.enumValidator)(badgeposition_1.HorizontalBadgePos)),
+    'v': (0, validators_1.option)((0, validators_1.enumValidator)(badgeposition_1.VerticalBadgePos)),
+    'onClickHandlerKey': (0, validators_1.option)(exports.isOnClickHandlerKey),
+    'imageBadgeSettings': (0, validators_1.option)(isImageBadgeSettings),
+    'textBadgeSettings': (0, validators_1.option)(isTextBadgeSettings),
+});
+exports.isSerializedLucidCardFieldSettings = (0, validators_1.objectValidator)({
+    'StencilConfig': (0, validators_1.option)(isStencilConfig),
+});
 /** @ignore */
 function serializeLucidCardFieldDisplaySettings(settings) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;

package/core/cardintegration/cardintegrationconfig.d.ts

@@ -1,4 +1,5 @@
 import { TextStyle } from '../../document/text/textstyle';
+import { isBoolean, isString } from '../checks';
 import { LucidCardFieldDisplaySettings, SerializedLucidCardFieldDisplaySettings } from './cardfielddisplaysettings';
 export interface CardIntegrationConfig {
     cardConfig: {
@@ -47,6 +48,57 @@ export type SerializedCardIntegrationConfig = {
         }[];
     };
 };
+export declare const isSerializedCardIntegrationConfig: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    cc: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+        f: (val: unknown) => val is string[];
+        fd: (x: unknown) => x is [string, import("../guards").DestructureGuardedTypeObj<{
+            StencilConfig: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+                getterKey: (x: unknown) => x is import("./cardfielddisplaysettings").FieldDisplayType;
+                fg: (x: unknown) => x is string | undefined;
+                bg: (x: unknown) => x is string | undefined;
+                f: (x: unknown) => x is string | undefined;
+                t: (x: unknown) => x is string | undefined;
+                l: (x: unknown) => x is string | undefined;
+                h: (x: unknown) => x is import("../..").HorizontalBadgePos | undefined;
+                v: (x: unknown) => x is import("../..").VerticalBadgePos | undefined;
+                onClickHandlerKey: (x: unknown) => x is import("./cardfielddisplaysettings").OnClickHandlerKeys | undefined;
+                imageBadgeSettings: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+                    height: typeof import("../checks").isNumber;
+                    width: typeof import("../checks").isNumber;
+                }> | undefined;
+                textBadgeSettings: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+                    bold: (x: unknown) => x is boolean | undefined;
+                    italic: (x: unknown) => x is boolean | undefined;
+                    underline: (x: unknown) => x is boolean | undefined;
+                    rounding: (x: unknown) => x is number | undefined;
+                    minwidth: (x: unknown) => x is number | undefined;
+                    minheight: (x: unknown) => x is number | undefined;
+                    maxfontsize: (x: unknown) => x is number | undefined;
+                    maxtextwidth: (x: unknown) => x is number | undefined;
+                    iswithinpill: (x: unknown) => x is boolean | undefined;
+                    usingcarduirefresh: (x: unknown) => x is boolean | undefined;
+                    hasleadingicon: (x: unknown) => x is boolean | undefined;
+                }> | undefined;
+            }> | undefined;
+        }>][] | undefined;
+        fs: (x: unknown) => x is [string, Partial<import("../guards").DestructureGuardedTypeObj<{
+            font: typeof isString;
+            bold: typeof isBoolean;
+            italic: typeof isBoolean;
+            underline: typeof isBoolean;
+            size: typeof import("../checks").isNumber;
+            color: typeof isString;
+            align: typeof isString;
+        }>>][] | undefined;
+        id: (x: unknown) => x is string | undefined;
+    }>;
+    cdpc: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+        f: (val: unknown) => val is import("../guards").DestructureGuardedTypeObj<{
+            n: typeof isString;
+            l: (x: unknown) => x is boolean | undefined;
+        }>[];
+    }>;
+}>;
 /** @ignore */
 export declare function serializeCardIntegrationConfig(config: CardIntegrationConfig): SerializedCardIntegrationConfig;
 /** @ignore */

package/core/cardintegration/cardintegrationconfig.js

@@ -1,7 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeCardIntegrationConfig = exports.serializeCardIntegrationConfig = void 0;
+exports.deserializeCardIntegrationConfig = exports.serializeCardIntegrationConfig = exports.isSerializedCardIntegrationConfig = void 0;
+const textstyle_1 = require("../../document/text/textstyle");
+const checks_1 = require("../checks");
+const validators_1 = require("../validators/validators");
 const cardfielddisplaysettings_1 = require("./cardfielddisplaysettings");
+exports.isSerializedCardIntegrationConfig = (0, validators_1.objectValidator)({
+    'cc': (0, validators_1.objectValidator)({
+        'f': (0, checks_1.isTypedArray)(checks_1.isString),
+        'fd': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, cardfielddisplaysettings_1.isSerializedLucidCardFieldSettings))),
+        'fs': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, textstyle_1.isPartialTextStyle))),
+        'id': (0, validators_1.option)(checks_1.isString),
+    }),
+    'cdpc': (0, validators_1.objectValidator)({ 'f': (0, checks_1.isTypedArray)((0, validators_1.objectValidator)({ 'n': checks_1.isString, 'l': (0, validators_1.option)(checks_1.isBoolean) })) }),
+});
 /** @ignore */
 function serializeCardIntegrationConfig(config) {
     return {

package/editorclient.d.ts

@@ -1,4 +1,5 @@
 import { CommandArgs, CommandName, HashAlgorithmEnum, TriggerAuthFlowResult, UnionToIntersection } from './commandtypes';
+import { CardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
 import { JsonObject, JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { BinaryXHRResponse, OAuthXHRRequest, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
@@ -381,6 +382,23 @@ export declare class EditorClient {
      * remote API.
      */
     withSilentActions(callback: () => void): void;
+    /**
+     * This method fetches the `CardIntegrationConfig` associated with the given data source ID. If you need to change
+     * the `CardIntegrationConfig`, you can call this method and mutate the returned object, then return it to the
+     * extension API via the `updateCardIntegrationConfig` method. Note that this method has a few best-practices you
+     * should be aware of before using it, as detailed in its comment.
+     */
+    getCardIntegrationConfig(dataSourceId: string): Promise<import("./commandtypes").GetCardIntegrationConfigResult>;
+    /**
+     * Update the current `CardIntegrationConfig` associated with the given data source ID with the data from the new
+     * one provided. This will not remove fields form the fieldDisplaySetings, only add new ones or update existing
+     * ones.
+     *
+     * You should only call this method in response to a user action from the current session, and should be careful
+     * when there are multiple collaborators that you are not repeatedly calling this method for all users. Doing so
+     * could lead to undefined or unexpected behavior.
+     */
+    updateCardIntegrationConfig(dataSourceId: string, newConfig: CardIntegrationConfig): Promise<void>;
     /**
      * Hash a particular string using the given algorithm.
      *

package/editorclient.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditorClient = exports.getResponseBody = void 0;
 const commandtypes_1 = require("./commandtypes");
 const base64_1 = require("./core/base64");
+const cardintegrationconfig_1 = require("./core/cardintegration/cardintegrationconfig");
 const checks_1 = require("./core/checks");
 const unfurldetails_1 = require("./core/unfurl/unfurldetails");
 const unfurlrefresherrortype_1 = require("./core/unfurl/unfurlrefresherrortype");
@@ -684,6 +685,30 @@ class EditorClient {
             this.deleteAction(action);
         }
     }
+    /**
+     * This method fetches the `CardIntegrationConfig` associated with the given data source ID. If you need to change
+     * the `CardIntegrationConfig`, you can call this method and mutate the returned object, then return it to the
+     * extension API via the `updateCardIntegrationConfig` method. Note that this method has a few best-practices you
+     * should be aware of before using it, as detailed in its comment.
+     */
+    async getCardIntegrationConfig(dataSourceId) {
+        return await this.sendCommand("gcic" /* CommandName.GetCardIntegrationConfig */, dataSourceId);
+    }
+    /**
+     * Update the current `CardIntegrationConfig` associated with the given data source ID with the data from the new
+     * one provided. This will not remove fields form the fieldDisplaySetings, only add new ones or update existing
+     * ones.
+     *
+     * You should only call this method in response to a user action from the current session, and should be careful
+     * when there are multiple collaborators that you are not repeatedly calling this method for all users. Doing so
+     * could lead to undefined or unexpected behavior.
+     */
+    async updateCardIntegrationConfig(dataSourceId, newConfig) {
+        return await this.sendCommand("ucic" /* CommandName.UpdateCardIntegrationConfig */, {
+            'd': dataSourceId,
+            'c': (0, cardintegrationconfig_1.serializeCardIntegrationConfig)(newConfig),
+        });
+    }
     /**
      * Hash a particular string using the given algorithm.
      *

package/package.json

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