lucid-extension-sdk 0.0.456 → 0.0.457

package/commandtypes.d.ts

@@ -757,7 +757,7 @@ export type AddCardsActions = {
 };
 export type DependencyMappingSettings = {
     /** Whether to enable dependency mapping for this integration */
-    'sdm'?: boolean;
+    'sdm'?: boolean | undefined;
     /**
      * Import dependencies action
      * Inconsistent naming convention, to avoid calling this "ID"
@@ -769,60 +769,60 @@ export type DependencyMappingSettings = {
      */
     'dmp'?: {
         /** Entrypoint text */
-        'ep'?: string;
+        'ep'?: string | undefined;
         /**
          * Text for on-card badge for dependency mapping
          * String, not a function itself; this is the name of the client's registered action hook
          */
-        'cl'?: string;
+        'cl'?: string | undefined;
         /** Text for the dependency manager */
         'm'?: {
             /** Header */
-            'h'?: string;
+            'h'?: string | undefined;
             /** All links label */
-            'all'?: string;
+            'all'?: string | undefined;
             /** Show all links button text */
-            'salb'?: string;
+            'salb'?: string | undefined;
             /** Hide all links button text */
-            'halb'?: string;
+            'halb'?: string | undefined;
             /** Show all links tooltip text (when disabled) */
-            'dsalt'?: string;
+            'dsalt'?: string | undefined;
             /** Hide all links tooltip text (when disabled) */
-            'dhalt'?: string;
+            'dhalt'?: string | undefined;
             /** Text for various empty states */
             'es'?: {
                 /** Create link instruction text */
-                'cli'?: string;
+                'cli'?: string | undefined;
                 /** Instructional text when no items are selected */
-                'nssi'?: string;
+                'nssi'?: string | undefined;
                 /** Heading text when no items are selected */
-                'nssh'?: string;
+                'nssh'?: string | undefined;
                 /**
                  * Heading text when selected item has no links
                  * String, not a function itself; this is the name of the client's registered action hook
                  */
-                'ndh'?: string;
+                'ndh'?: string | undefined;
                 /** Text when multiple items are selected and have no links */
-                'mikwnl'?: string;
-            };
-        };
+                'mikwnl'?: string | undefined;
+            } | undefined;
+        } | undefined;
         /** Text for editing a dependency */
         'ed'?: {
-            'ch'?: string;
-            'cnlo'?: string;
-            'dh'?: string;
-            'dd'?: string;
-            'dab'?: string;
+            'ch'?: string | undefined;
+            'cnlo'?: string | undefined;
+            'dh'?: string | undefined;
+            'dd'?: string | undefined;
+            'dab'?: string | undefined;
             /**
              * Selected issue heading
              * String, not a function itself; this is the name of the client's registered action hook
              */
-            'sih'?: string;
-        };
+            'sih'?: string | undefined;
+        } | undefined;
         /**
          * Item label phrase
          */
-        'ilp'?: string;
+        'ilp'?: string | undefined;
     } | undefined;
 };
 export type AutoSyncSettings = {
@@ -869,7 +869,7 @@ export type SerializedFieldConfiguration = {
     /** Default search callback for searching for legal field values in an enum */
     'dsc'?: string | undefined;
     /** Custom field display settings */
-    'cfds'?: SerializedCustomFieldDisplaySettings;
+    'cfds'?: SerializedCustomFieldDisplaySettings | undefined;
     /** Non-customizable fields */
     'ncf'?: string[] | undefined;
     /** Callback to get fields to edit related to a field passed as an argument */
@@ -1080,9 +1080,9 @@ export type AddShapeDataResult = undefined;
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationQuery = {
     /** Item label */
-    'il'?: string;
+    'il'?: string | undefined;
     /** Items label */
-    'isl'?: string;
+    'isl'?: string | undefined;
     /** labelDescription */
     'ld': string;
     /** labelIconUrl */
@@ -1100,20 +1100,22 @@ export type AddSpreadsheetIntegrationQuery = {
         /** Primary Icon Url */
         'pi': string;
         /** Light Icon URl */
-        'li'?: string;
+        'li'?: string | undefined;
         /** Dark Icon URl */
-        'di'?: string;
+        'di'?: string | undefined;
     } | undefined;
     /** importDescription */
     'id'?: string | undefined;
     /** addCardsIntegration */
-    'c'?: boolean;
+    'c'?: boolean | undefined;
     /** getUpstreamSourceUrl */
-    'gu'?: string;
+    'gu'?: string | undefined;
     /** If specified, add-card settings */
     'ac'?: AddCardsActions | undefined;
     /** fieldConfiguration */
-    'fc'?: Partial<SerializedFieldConfiguration>;
+    'fc'?: {
+        [K in keyof SerializedFieldConfiguration]?: SerializedFieldConfiguration[K] | undefined;
+    } | undefined;
     'dm'?: DependencyMappingSettings | undefined;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
@@ -1844,9 +1846,9 @@ export type RegisterPanelQuery = {
     /** Icon URL, preferably a base64-encoded URL */
     'i': string;
     /** tooltip */
-    'to'?: string;
+    'to'?: string | undefined;
     /** If true, we will persist the panel's iframe */
-    'p'?: boolean;
+    'p'?: boolean | undefined;
     /** Desired panel width */
     'w'?: number | undefined;
     /** Desired panel height */

package/core/cardintegration/lucidcardintegration.d.ts

@@ -120,7 +120,7 @@ export declare abstract class LucidCardIntegration implements CardIntegrationDep
      * @deprecated Use AuthorizationFlowHandlerRegistry.registerAuthorizationFlowHandler.
      * WARNING: Currently unused and does nothing.
      */
-    showIntro?: () => void;
+    showIntro?: (() => void) | undefined;
     /**
      * Provide the default configuration for a new import
      */
@@ -129,7 +129,7 @@ export declare abstract class LucidCardIntegration implements CardIntegrationDep
      * This allows the user to import cards by selecting items from within a modal. You can either create a custom
      * import modal or the standard import modal can be used.
      */
-    importModal?: LucidCardIntegrationStandardImportModal | LucidCardIntegrationCustomImportModal;
+    importModal?: LucidCardIntegrationStandardImportModal | LucidCardIntegrationCustomImportModal | undefined;
     /**
      * If specified, allow the user to create new cards and convert other shapes to cards
      */
@@ -147,11 +147,11 @@ export declare abstract class LucidCardIntegration implements CardIntegrationDep
             collection: CollectionProxy;
             primaryKey: string;
         }>;
-    };
+    } | undefined;
     /**
      * If specified, allows the user to use query to sync with timelines.
      */
-    autoSync?: CardIntegrationAutoSyncConfig;
+    autoSync?: CardIntegrationAutoSyncConfig | undefined;
     showCardImport(name: string): ImportCardsResult;
     showDependencyMapping?: boolean;
     /**

package/core/data/datasource/sourceforeignkeys.d.ts

@@ -38,18 +38,18 @@ export type HierarchicalRelationshipFilterConfig = {
      * Example: ADO "Child" FK shows parent on child cards (has inward),
      * but is filtered out on parent cards (no inward).
      */
-    showOnlyIfHasInward?: boolean;
+    showOnlyIfHasInward?: boolean | undefined;
     /**
      * @deprecated Use `suppressLinkedItems` instead.
      * If true, skip outward relationships in linked items display.
      */
-    skipOutwardRelationships?: boolean;
+    skipOutwardRelationships?: boolean | undefined;
     /**
      * If true, only show this FK when the item has outward relationships.
      * Example: Jira "Child" FK shows parent on child cards (child has outward "parent" field),
      * but is filtered out on parent cards (parent has no outward "parent" field).
      */
-    showOnlyIfHasOutward?: boolean;
+    showOnlyIfHasOutward?: boolean | undefined;
     /**
      * Controls which directions of this foreign key relationship are hidden from
      * the linked items panel.
@@ -64,29 +64,29 @@ export type HierarchicalRelationshipFilterConfig = {
      *
      * When omitted, both directions are shown normally.
      */
-    suppressLinkedItems?: SuppressLinkedItems;
+    suppressLinkedItems?: SuppressLinkedItems | undefined;
 };
 export type SourceForeignKey = {
     id: string;
     sourceFields: string[];
-    relationshipType?: string;
-    represents?: string;
+    relationshipType?: string | undefined;
+    represents?: string | undefined;
     outwardLabel: string;
     inwardLabel: string;
     /**
      * This exists to handle the rare situation when there are fields on the target item that reference the source item.
      * Please reach out to #dev-data-platform before setting this to a defined value.
      */
-    targetFields?: string[];
+    targetFields?: string[] | undefined;
     /**
      * Indicates whether this relationship is bi-directional.
      * "Related To" is a good example of a bi-directional relationship.
      */
-    isBidirectional?: boolean;
+    isBidirectional?: boolean | undefined;
     /**
      * @experimental Optional configuration for filtering hierarchical relationships.
      */
-    hierarchicalFilterConfig?: HierarchicalRelationshipFilterConfig;
+    hierarchicalFilterConfig?: HierarchicalRelationshipFilterConfig | undefined;
 };
 export declare function serializeHierarchicalFilterConfig(config: HierarchicalRelationshipFilterConfig): SerializedHierarchicalRelationshipFilterConfig;
 export declare function deserializeHierarchicalFilterConfig(config: SerializedHierarchicalRelationshipFilterConfig): HierarchicalRelationshipFilterConfig;

package/core/data/fieldspecification.d.ts

@@ -29,7 +29,7 @@ type TsTypeOf<X> = X extends typeof ScalarFieldTypeEnum.ANY ? unknown : X extend
 export declare function declareSchema<Names extends string, Types extends Readonly<FieldTypeDefinition>, Constraint extends FieldConstraintDefinition, DisplayOption extends DisplayOptionDefinition, Fields extends {
     [Name in Names]: {
         type: Types;
-        constraints?: readonly Constraint[];
+        constraints?: readonly Constraint[] | undefined;
         mapping?: readonly SemanticKind[] | readonly SemanticFields[] | readonly LucidFields[] | undefined;
         displayOptions?: DisplayOption[] | undefined;
         syncSchema?: string | undefined;

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

@@ -16,11 +16,11 @@ export type SerializedMapEnumFieldType = {
 };
 export declare function isSerializedMapEnumFieldType(fieldType: any): fieldType is SerializedMapEnumFieldType;
 export interface DeserializedMapEnumFieldTypeEntry {
-    name?: string | null;
-    description?: string | null;
-    color?: string | null;
-    iconUrl?: string | null;
-    category?: string | null;
+    name?: string | null | undefined;
+    description?: string | null | undefined;
+    color?: string | null | undefined;
+    iconUrl?: string | null | undefined;
+    category?: string | null | undefined;
 }
 export interface SerializedEnumEntry {
     'Id': EnumKeyType;

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

@@ -23,11 +23,11 @@ export type SerializedFields = {
 };
 export type SerializedIsoDateObject = {
     'isoDate': string;
-    'displayTimezone'?: string | null;
+    'displayTimezone'?: string | null | undefined;
 };
 export type SerializedMillisecondsDateObject = {
     'ms': number;
-    'isDateOnly'?: boolean;
+    'isDateOnly'?: boolean | undefined;
 };
 export type SerializedLucidDateObject = SerializedMillisecondsDateObject | SerializedIsoDateObject;
 export type SerializedLucidDateRangeObject = {

package/core/iframe/iframeutils.d.ts

@@ -29,15 +29,15 @@ export type IframeAttributes =
     /**
      * The iFrame height
      */
-    height?: number;
+    height?: number | undefined;
     /**
      * The iFrame width
      */
-    width?: number;
+    width?: number | undefined;
     /**
      * The iFrame title for accessibility
      */
-    title?: string;
+    title?: string | undefined;
 };
 /**
  * Generate iframe HTML from the IFrameAttributes object

package/core/rules/serializeddatagraphic.d.ts

@@ -4,8 +4,8 @@ export type SerializedDataGraphic = {
     'Set': DataGraphicIconSets;
     'Index': number;
     'Position': SerializedBadgeEnumPosition;
-    'Color'?: string;
-    'Image'?: SerializedDataGraphicImage;
+    'Color'?: string | undefined;
+    'Image'?: SerializedDataGraphicImage | undefined;
 };
 export type SerializedDataGraphicImage = {
     'url': string;

package/core/rules/serializedstencilgraphic.d.ts

@@ -9,8 +9,8 @@ export type SerializedStencilGraphic = {
      * AutoHide used to be an undefined property that should default to true.
      * Either continue handling undefined case when deserializing, or write a BCU that changes undefined to true.
      */
-    'AutoHide'?: boolean;
-    'Badge'?: SerializedBadgeEnumPosition;
-    'BoxFit'?: BadgeBoxFit;
+    'AutoHide'?: boolean | undefined;
+    'Badge'?: SerializedBadgeEnumPosition | undefined;
+    'BoxFit'?: BadgeBoxFit | undefined;
 };
 export declare const isSerializedStencilGraphic: (v: unknown) => v is SerializedStencilGraphic;

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -286,8 +286,8 @@ export declare function deserializeExtensionCardFieldsGroupArray(serializedGroup
 export interface SearchResultPerCollection {
     partialImportMetadata?: {
         collectionId: string;
-        syncDataSourceId?: string;
-    };
+        syncDataSourceId?: string | undefined;
+    } | undefined;
     data: CollectionDefinition;
     fields: ExtensionCardFieldDefinition[];
     fieldNameTakesRemainingWidth?: string | undefined;

package/core/unfurl/unfurldetails.d.ts

@@ -17,21 +17,21 @@ export interface UnfurlDetails {
     /**
      * The title associated with the link being unfurled. For example, the document or web page title.
      */
-    unfurlTitle?: string;
+    unfurlTitle?: string | undefined;
     /**
      * If the unfurl supports an expandable iframe, this configuration defines its properties.
      */
-    iframe?: UnfurlIframe;
+    iframe?: UnfurlIframe | undefined;
     /**
      * If the unfurl contains one or more images, this configuration defines those properties.
      */
-    thumbnails?: UnfurlThumbnail[];
+    thumbnails?: UnfurlThumbnail[] | undefined;
     /**
      * The url to show if there are no thumbnails.
      *
      * This can be useful to show an initial image while using other mechanisms to add all thumbnails after the unfurl is created.
      */
-    previewImageUrl?: string;
+    previewImageUrl?: string | undefined;
 }
 /** @ignore */
 export interface SerializedUnfurlDetails {

package/core/unfurl/unfurliframe.d.ts

@@ -40,11 +40,11 @@ export interface UnfurlIframe {
      * The size of the iframe requested
      * If not provided, 16:9
      */
-    aspectRatio?: UnfurlIframeAspectRatio;
+    aspectRatio?: UnfurlIframeAspectRatio | undefined;
     /**
      * The iframe title for accessibility
      */
-    iframeTitle?: string;
+    iframeTitle?: string | undefined;
 }
 /** @ignore */
 export interface SerializedUnfurlIframe {

package/core/validators/compactvalidatorsandpruners.d.ts

@@ -32,7 +32,7 @@ export interface PrunerResult {
  */
 export interface ValidatorWithOptionalPruner<TO = unknown> {
     'validator': Validator<TO>;
-    'pruner'?: Pruner;
+    'pruner'?: Pruner | undefined;
 }
 export interface ValidatorWithPruner<TO = unknown> {
     'validator': Validator<TO>;

package/core/xhr.d.ts

@@ -45,7 +45,7 @@ export interface BaseXHRResponse {
         [key: string]: string;
     };
     /** True if this request failed due to a timeout */
-    timeout?: boolean;
+    timeout?: boolean | undefined;
 }
 export interface TextXHRResponse extends BaseXHRResponse {
     responseFormat: 'utf8';

package/data/displayoptiondefinition.d.ts

@@ -5,7 +5,7 @@ export interface DisplayMultiUserEditDisplayOptionDefinition {
 }
 export interface HelperTextDisplayOptionDefinition {
     type: typeof DisplayOptionType.HelperText;
-    value?: string;
+    value?: string | undefined;
 }
 export type DisplayOptionDefinition = DisplayMultiUserEditDisplayOptionDefinition | HelperTextDisplayOptionDefinition;
 export declare function createDisplayOptionDefinition(type: DisplayOptionType, value?: number | string): DisplayOptionDefinition;

package/data/referencekeydefinition.d.ts

@@ -14,13 +14,13 @@ export interface CollectionReferenceKeyDefinition {
     /** The [primary key](#classes_data_dataitemproxy-DataItemProxy_primarykey) of the data item referenced */
     primaryKey: string;
     /** If true, prevent the user from editing the field values of this reference key through the normal UI */
-    readonly?: boolean;
+    readonly?: boolean | undefined;
     /**
      * If specified, only expose this list of fields through this reference key. This can be used to limit
      * namespace pollution in shape data from lots of unnecessary fields, or just to hide information you'd
      * prefer not to be visible in the UI or through formulas.
      */
-    fieldWhitelist?: string[];
+    fieldWhitelist?: string[] | undefined;
 }
 /**
  * A reference key that has the field values embedded directly in the reference definition. This can be
@@ -30,7 +30,7 @@ export interface CollectionReferenceKeyDefinition {
  */
 export interface FlattenedReferenceDefinition {
     /** Name to display to the user for the reference key (what would normally be the collection name) */
-    name?: string;
+    name?: string | undefined;
     /** Schema of the data stored at this key */
     schema: SchemaDefinition;
     /** Field values available at this reference key */

package/data/schemadefinition.d.ts

@@ -37,7 +37,7 @@ export interface SchemaDefinition {
      * Maps field names to labels to display in the UI when necessary. If any field name
      * is not present as a key in this label map, the field name itself will be the label.
      */
-    fieldLabels?: Record<string, string>;
+    fieldLabels?: Record<string, string> | undefined;
 }
 /** @ignore */
 export declare function serializeFieldDefinition(field: FieldDefinition): SerializedFieldDefinition;

package/dataconnector/datasourceupdatetypes.d.ts

@@ -47,9 +47,9 @@ type SerializedFieldDefinitionForApi = {
     'name': string;
     'type': SerializedFieldTypeDefinition;
     'constraints': SerializedFieldConstraintForApi[];
-    'syncSchema'?: string;
-    'mapping'?: readonly SemanticKind[] | readonly LucidFields[] | readonly SemanticFields[];
-    'displayOptions'?: SerializedDisplayOptionForApi[];
+    'syncSchema'?: string | undefined;
+    'mapping'?: readonly SemanticKind[] | readonly LucidFields[] | readonly SemanticFields[] | undefined;
+    'displayOptions'?: SerializedDisplayOptionForApi[] | undefined;
 };
 export type SerializedSchemaForApi = {
     'fields': SerializedFieldDefinitionForApi[];
@@ -61,9 +61,9 @@ type serializedPropertiesForApi = {
     'Name'?: string;
 };
 export interface SerializedCollectionPatch {
-    'schema'?: SerializedSchemaForApi;
+    'schema'?: SerializedSchemaForApi | undefined;
     'itemsPatch': SerializedItemsPatch;
-    'properties'?: serializedPropertiesForApi;
+    'properties'?: serializedPropertiesForApi | undefined;
 }
 /** Represents a standard, incremental update to a collection. */
 export declare class ItemsPatchInexhaustive {

package/document/linetextareapositioning.d.ts

@@ -15,13 +15,13 @@ export interface LineTextAreaPositioning {
      * Normally text on a line is not allowed to overlap a block that is connected to either end of the
      * line. If `allowOverBlock` is true, then the text is allowed to overlap an attached block.
      */
-    allowOverBlock?: boolean;
+    allowOverBlock?: boolean | undefined;
 }
 /** @ignore */
 export type SerializedLineTextAreaPositioning = {
     'Location': number;
     'Side': -1 | 0 | 1;
-    'AllowOverBlock'?: boolean;
+    'AllowOverBlock'?: boolean | undefined;
 };
 /** @ignore */
 export declare function isSerializedLineTextAreaPositioning(raw: unknown): raw is SerializedLineTextAreaPositioning;

package/message/unfurleventmessage.d.ts

@@ -9,14 +9,14 @@ export interface UnfurlEventMessage {
     /** @ignore */
     unfurlCallbackType: UnfurlCallbackType;
     /** @ignore */
-    blockId?: string;
+    blockId?: string | undefined;
 }
 /** @ignore */
 export interface SerializedUnfurlEventMessage extends JsonObject {
     'id': string;
     'u': string;
     't': UnfurlCallbackType;
-    'b'?: string;
+    'b'?: string | undefined;
 }
 /** @ignore */
 export declare function deserializeUnfurlEventMessage(raw: SerializedUnfurlEventMessage): UnfurlEventMessage;

package/package.json

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

package/ui/menu.d.ts

@@ -84,17 +84,17 @@ export interface CustomMenuItem {
      *
      * NOTE: Not all menuTypes support displaying an icon
      */
-    iconUrl?: string;
+    iconUrl?: string | undefined;
     /** The registered action to run when the menu item is clicked */
-    action?: string;
+    action?: string | undefined;
     /** If specified, what action's return value should determine if this menu item is visible? */
-    visibleAction?: string;
+    visibleAction?: string | undefined;
     /** If specified, what action's return value should determine if this menu item is disabled? */
-    disabledAction?: string;
+    disabledAction?: string | undefined;
     /** Which menu to display this item in */
     menuType: MenuType;
     /** Where in that menu to display this item */
-    location?: MenuLocation;
+    location?: MenuLocation | undefined;
     /** If specified, this menu item should launch a file picker */
     file?: {
         /** An action registered with EditorClient.registerFileUploadAction */
@@ -102,10 +102,10 @@ export interface CustomMenuItem {
         /** An [accept string](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) as specified for HTML file inputs */
         accept: string;
         /** If true, only allow a single file to be selected for upload */
-        singleFileOnly?: boolean;
+        singleFileOnly?: boolean | undefined;
         /** If true, send the file contents to the callback action as a Uint8Array as well as a plain text string */
-        binary?: boolean;
-    };
+        binary?: boolean | undefined;
+    } | undefined;
 }
 export interface FileUploadData {
     fileName: string;