lucid-extension-sdk 0.0.92 → 0.0.94

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -475,10 +475,10 @@ export declare type AddCardIntegrationQuery = {
         /** Callback to get field definitions for all fields supported by the card integration */
         'gf': string;
         /** Callback to handle a change in the fields the user want to be displayed */
-        'osfc'?: string;
+        'osfc'?: string | undefined;
     };
     /** Show intro if user has not yet authorized this integration */
-    'i'?: string;
+    'i'?: string | undefined;
     /** Get default config action */
     'gdc': string;
     /** If specified, import modal settings */
@@ -489,14 +489,14 @@ export declare type AddCardIntegrationQuery = {
         's': string;
         /** Import action */
         'i': string;
-    };
+    } | undefined;
     /** If specified, add-card settings */
     'ac'?: {
         /** Get input fields action */
         'gif': string;
         /** Create card action */
         'cc': string;
-    };
+    } | undefined;
 };
 export declare type AddCardIntegrationResult = undefined;
 export declare type AddLineTextAreaQuery = {
@@ -515,15 +515,15 @@ export declare type AddMenuItemQuery = {
     /** Label to display on the menu item */
     'l': string;
     /** Named action to run when the menu item is clicked */
-    'a'?: string;
+    'a'?: string | undefined;
     /** Named action that returns whether the menu item should be visible */
-    'v'?: string;
+    'v'?: string | undefined;
     /** Named action that returns whether the menu item should be disabled */
-    'd'?: string;
+    'd'?: string | undefined;
     /** Which menu to put the item in */
     't': MenuType;
     /** If specified, where to place the menu item; defaults to MenuLocation.Extension */
-    'loc'?: MenuLocation;
+    'loc'?: MenuLocation | undefined;
     /** If specified, this menu item should launch a file picker */
     'f'?: {
         /** Action to call when files are selected */
@@ -534,7 +534,7 @@ export declare type AddMenuItemQuery = {
         's'?: boolean;
         /** Return content in a binary ArrayBuffer instead of as text */
         'b'?: boolean;
-    };
+    } | undefined;
 };
 export declare type AddMenuItemResult = undefined;
 export declare type AddShapeDataQuery = {
@@ -550,11 +550,11 @@ export declare type AddShapeDataQuery = {
 export declare type AddShapeDataResult = undefined;
 export declare type AlertQuery = {
     /** Title; defaults to extension title */
-    't'?: string;
+    't'?: string | undefined;
     /** Body text */
     'b': string;
     /** Button text; defaults to i18n'ed "OK" */
-    'bt'?: string;
+    'bt'?: string | undefined;
 };
 /** True if they click OK, false otherwise */
 export declare type AlertResult = Promise<boolean>;
@@ -562,7 +562,7 @@ export declare type AwaitImportQuery = {
     /** Data Connector Name */
     'n': string;
     /** Sync data source ID Nonce */
-    's'?: string;
+    's'?: string | undefined;
     /** Sync collection ID */
     'c': string;
     /** Keys to await */
@@ -581,7 +581,7 @@ export declare type BootstrapQuery = {
     /**
      * Marks a document as requiring the editor extension.
      */
-    'm'?: boolean;
+    'm'?: boolean | undefined;
 };
 export declare type BootstrapResult = Promise<void>;
 export declare type CanEditPackageSettingsQuery = undefined;
@@ -590,13 +590,13 @@ export declare type CancelDragBlockToCanvasQuery = void;
 export declare type CancelDragBlockToCanvasResult = undefined;
 export declare type ConfirmQuery = {
     /** Title; defaults to extension title */
-    't'?: string;
+    't'?: string | undefined;
     /** Body text */
     'b': string;
     /** OK button text; defaults to i18n'ed "OK" */
-    'o'?: string;
+    'o'?: string | undefined;
     /** Cancel button text; defaults to i18n'ed "Cancel" */
-    'c'?: string;
+    'c'?: string | undefined;
 };
 /** True if they click OK, false otherwise */
 export declare type ConfirmResult = Promise<boolean>;
@@ -605,7 +605,7 @@ export declare type CreateBlockQuery = {
      * By default, we add the block to the current page & currently active group. If specified, the
      * block will instead be created as a direct child of the given page.
      */
-    'p'?: string;
+    'p'?: string | undefined;
     /** Class name of the block to create */
     'c': string;
     /** If specified, the stencil for a custom shape. Only valid if the class name is 'CustomBlock' */
@@ -643,7 +643,7 @@ export declare type CreateLineQuery = {
      * By default, we add the line to the current page & currently active group. If specified, the
      * line will instead be created as a direct child of the given page.
      */
-    'p'?: string;
+    'p'?: string | undefined;
 };
 export declare type CreateLineResult = string;
 export declare type CreatePageQuery = void;
@@ -667,7 +667,7 @@ export declare type DataActionQuery = {
     /** Flow Data */
     'fd'?: unknown;
     /** Sync data source ID Nonce */
-    's'?: string;
+    's'?: string | undefined;
     /** Data Connector Name */
     'n': string;
 };
@@ -774,7 +774,7 @@ export declare type GetItemPageIdQuery = string;
 export declare type GetItemPageIdResult = string;
 export declare type GetReferenceKeyQuery = {
     /** ID of the LucidElement to read a reference key from, or undefined to read from the LucidDocument */
-    'id'?: string;
+    'id'?: string | undefined;
     /** Reference key to get */
     'k': number | string;
 };
@@ -799,7 +799,7 @@ export declare type GetRelativeLinePositionQuery = {
 export declare type GetRelativeLinePositionResult = Point;
 export declare type GetSelectionQuery = {
     /** If set, additionally return all items inside selected groups */
-    'd'?: boolean;
+    'd'?: boolean | undefined;
 };
 export declare type GetSelectionResult = string[];
 export declare type GetShapeDataQuery = {
@@ -919,7 +919,7 @@ export declare type RegisterPanelQuery = {
     /** Where to display the panel */
     'l': PanelLocation;
     /** Named action that returns whether the button to open the panel should be visible */
-    'v'?: string;
+    'v'?: string | undefined;
     /** Content to display in the panel; full HTML page preferred */
     'c': string;
     /** Icon URL, preferably a base64-encoded URL */
@@ -941,7 +941,7 @@ export declare type SendOAuthRequestQuery = SendXHRQuery & {
     /** OAuth provider name as specified in the package manifest */
     'p': string;
     /** Post Result To */
-    'prt'?: string;
+    'prt'?: string | undefined;
 };
 export declare type SendPermanentTokenRequestQuery = SendXHRQuery & {
     /** Permanent token provider name as specified in the package manifest */
@@ -960,7 +960,7 @@ export declare type SendXHRResponseFormat = 'utf8' | 'binary';
 export declare type SendXHRQuery = {
     'url': string;
     /** HTTP method, e.g. 'GET', 'FETCH', etc. Defaults to GET */
-    'm'?: string;
+    'm'?: string | undefined;
     /**
      * The data to send with the request.
      *
@@ -969,20 +969,20 @@ export declare type SendXHRQuery = {
      * For non-GET requests, this is sent as the body of the request. If this is specified, and
      *   no 'Content-Type' header is specified, a 'text/plain; charset=utf-8' content type is sent.
      */
-    'd'?: string;
+    'd'?: string | undefined;
     /** Headers to send with the request */
     'h'?: {
         [key: string]: string | string[];
-    };
+    } | undefined;
     /** Timeout in milliseconds, if specified */
-    'ms'?: number;
+    'ms'?: number | undefined;
     /**
      * The desired format for the returned response body. Defaults to 'utf8'.
      *
      * - If 'utf8', the response body will be returned as a string.
      * - If 'binary', the response body will be returned as a Uint8Array.
      */
-    'f'?: SendXHRResponseFormat;
+    'f'?: SendXHRResponseFormat | undefined;
 };
 export declare type RawSendXHRResponse = {
     /** URL of the response after any redirects */
@@ -1017,7 +1017,7 @@ export declare type SetReferenceKeyQuery = {
     /** ID of the reference key to set */
     'k': string | number;
     /** New reference key settings, or undefined to remove the reference key */
-    'v'?: SerializedReferenceKeyType;
+    'v'?: SerializedReferenceKeyType | undefined;
 };
 export declare type SetReferenceKeyResult = undefined;
 export declare type SetShapeDataQuery = {

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

@@ -35,12 +35,12 @@ export declare type SerializedCardIntegrationConfig = {
     'cc': {
         'f': string[];
         'fd'?: [string, SerializedLucidCardFieldDisplaySettings][];
-        'id'?: string;
+        'id'?: string | undefined;
     };
     'cdpc': {
         'f': {
             'n': string;
-            'l'?: boolean;
+            'l'?: boolean | undefined;
         }[];
     };
 };

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

@@ -14,20 +14,20 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
     /** If defined, the default value for this field */
     default?: SerializedFieldType;
     /** Additional information we can provide to users, e.g. as a hover tooltip */
-    description?: string;
+    description?: string | undefined;
     /**
      * If specified, the list of options available to choose from, or the name
      * of a registered action that returns the list of options (either directly
      * or as a Promise).
      */
-    options?: ExtensionCardFieldOption[] | string;
+    options?: ExtensionCardFieldOption[] | string | undefined;
     /**
      * If specified, an action that takes the search text and input so far, and
      * returns the list of options that should be displayed. This is useful when
      * there are too many possible options to reasonably use the "options"
      * option for options.
      */
-    search?: string;
+    search?: string | undefined;
 }
 /** @ignore */
 export declare type SerializedCardFieldOption = {
@@ -40,9 +40,9 @@ export declare function serializeCardFieldOption(option: ExtensionCardFieldOptio
 export declare type SerializedExtensionCardFieldDefinition = SerializedFieldDefinition & {
     'l': string;
     'def'?: SerializedFieldType;
-    'd'?: string;
-    'op'?: SerializedCardFieldOption[] | string;
-    's'?: string;
+    'd'?: string | undefined;
+    'op'?: SerializedCardFieldOption[] | string | undefined;
+    's'?: string | undefined;
 };
 /** @ignore */
 export declare function serializeCardFieldDefinition(field: ExtensionCardFieldDefinition): SerializedExtensionCardFieldDefinition;

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -4,9 +4,9 @@ import { SemanticKind } from '../fieldtypedefinition/semantickind';
 export declare type SerializedFieldDefinition = {
     'Name': string;
     'Type': SerializedFieldTypeDefinition;
-    'Constraints'?: SerializedFieldConstraint[];
-    'SyncSchema'?: string;
-    'Mapping'?: readonly SemanticKind[];
+    'Constraints'?: SerializedFieldConstraint[] | undefined;
+    'SyncSchema'?: string | undefined;
+    'Mapping'?: readonly SemanticKind[] | undefined;
 };
 export declare enum FieldConstraintType {
     REQUIRED = "required",

package/sdk/core/unfurl/unfurldetails.d.ts

@@ -37,10 +37,10 @@ export interface UnfurlDetails {
 export interface SerializedUnfurlDetails {
     'ProviderName': string;
     'ProviderFaviconUrl': string;
-    'UnfurlTitle'?: string;
-    'Iframe'?: SerializedUnfurlIframe;
-    'Thumbnails'?: SerializedUnfurlThumbnail[];
-    'PreviewImageUrl'?: string;
+    'UnfurlTitle'?: string | undefined;
+    'Iframe'?: SerializedUnfurlIframe | undefined;
+    'Thumbnails'?: SerializedUnfurlThumbnail[] | undefined;
+    'PreviewImageUrl'?: string | undefined;
 }
 /** @ignore */
 export declare const isValidUnfurlDetails: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
@@ -55,9 +55,6 @@ export declare const isValidUnfurlDetails: (subject: unknown) => subject is impo
     Thumbnails: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
         url: typeof isString;
         width: (x: unknown) => x is number | null | undefined;
-        /**
-         * The title associated with the link being unfurled. For example, the document or web page title.
-         */
         height: (x: unknown) => x is number | null | undefined;
     }>[] | undefined;
     PreviewImageUrl: (x: unknown) => x is string | undefined;

package/sdk/core/unfurl/unfurlthumbnail.d.ts

@@ -10,11 +10,11 @@ export interface UnfurlThumbnail {
     /**
      * The width of the image. This is not the height it will be displayed at, but rather the width the image actually is.
      */
-    width?: number;
+    width?: number | undefined;
     /**
      * The height of the image. This is not the height it will be displayed at, but rather the height the image actually is.
      */
-    height?: number;
+    height?: number | undefined;
 }
 /** @ignore */
 export interface SerializedUnfurlThumbnail {

package/sdk/data/schemadefinition.d.ts

@@ -46,8 +46,8 @@ export declare const isFieldConstraintDefinition: (x: unknown) => x is {
 export interface FieldDefinition {
     name: string;
     type: FieldTypeDefinition;
-    constraints?: FieldConstraintDefinition[];
-    mapping?: readonly SemanticKind[];
+    constraints?: FieldConstraintDefinition[] | undefined;
+    mapping?: readonly SemanticKind[] | undefined;
 }
 /**
  * Definition of a schema for creating a [Collection](#classes_data_collectionproxy-CollectionProxy)