lucid-extension-sdk 0.0.5 → 0.0.9

package/interop.d.ts

@@ -1,8 +1,10 @@
+/** @ignore */
 declare namespace lucid {
     export function executeCommand(name: string, params: any): any;
     export function listen(msg: any): void;
 }
 
+/** @ignore */
 declare namespace console {
     export function log(...args: any[]): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.5",
+    "version": "0.0.9",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "sdk/index.js",
     "types": "sdk/index.d.ts",
@@ -8,10 +8,10 @@
     "license": "Apache-2.0",
     "declaration": true,
     "devDependencies": {
-        "@bazel/typescript": "2.0.1",
         "@types/jasmine": "^3.10.3",
         "@types/node": "^16.11.11",
-        "typedoc": "^0.22.11",
+        "typedoc": "^0.22.15",
+        "typedoc-plugin-markdown": "^3.12.1",
         "typescript": "4.3.5"
     }
 }

package/sdk/commandtypes.d.ts

@@ -7,10 +7,19 @@ import { SerializedDataError } from './core/serializeddataerror';
 import { ShapeDataInheritance } from './core/shapedatainheritance';
 import { Box, Point } from './math';
 import { MenuLocation, MenuType } from './ui/menu';
+import { PanelLocation } from './ui/panel';
+/**
+ * The lucid-extension-sdk library interacts with core Lucid products through this set of possible commands.
+ * Typically, an extension author will not need to access any of these commands directly, as they are all
+ * exposed through appropriate classes and methods elsewhere in this SDK.
+ *
+ * To use these directly, use [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand).
+ */
 export declare const enum CommandName {
     AddMenuItem = "ami",
     AddShapeData = "asd",
     AnimateViewport = "av",
+    Bootstrap = "b",
     CreateBlock = "cb",
     CreateCollection = "cc",
     CreateDataSource = "cds",
@@ -34,6 +43,7 @@ export declare const enum CommandName {
     GetSelection = "gs",
     GetShapeData = "gsd",
     HideModal = "hm",
+    HidePanel = "hp",
     KillExtension = "k",
     ListBlocks = "lb",
     ListCollectionFields = "lcf",
@@ -51,15 +61,24 @@ export declare const enum CommandName {
     LogForTestCase = "log",
     OffsetItems = "oi",
     PatchDataItems = "pdi",
+    RegisterPanel = "rp",
     ReloadExtension = "r",
+    SendOAuthRequest = "oauth",
     SendUIMessage = "suim",
     SendXHR = "xhr",
     SetCurrentPage = "scp",
     SetProperty = "sp",
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
-    ShowModal = "sm"
+    ShowModal = "sm",
+    ShowPanel = "spn",
+    SleepForTestCase = "sleep"
 }
+/**
+ * This is a type declaration whose purpose is to allow TypeScript to enforce the correct parameter and
+ * return types from [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand) based on
+ * which command name you pass in as the first parameter.
+ */
 export declare type CommandArgs = {
     [CommandName.AnimateViewport]: {
         query: AnimateViewportQuery;
@@ -73,6 +92,10 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.Bootstrap]: {
+        query: BootstrapQuery;
+        result: BootstrapResult;
+    };
     [CommandName.CreateBlock]: {
         query: CreateBlockQuery;
         result: CreateBlockResult;
@@ -165,6 +188,10 @@ export declare type CommandArgs = {
         query: HideModalQuery;
         result: HideModalResult;
     };
+    [CommandName.HidePanel]: {
+        query: HidePanelQuery;
+        result: HidePanelResult;
+    };
     [CommandName.KillExtension]: {
         query: KillExtensionQuery;
         result: KillExtensionResult;
@@ -223,7 +250,7 @@ export declare type CommandArgs = {
     };
     [CommandName.LogForTestCase]: {
         query: JsonSerializable;
-        result: undefined;
+        result: JsonSerializable;
     };
     [CommandName.OffsetItems]: {
         query: OffsetItemsQuery;
@@ -233,10 +260,18 @@ export declare type CommandArgs = {
         query: PatchDataItemsQuery;
         result: PatchDataItemsResult;
     };
+    [CommandName.RegisterPanel]: {
+        query: RegisterPanelQuery;
+        result: RegisterPanelResult;
+    };
     [CommandName.ReloadExtension]: {
         query: ReloadExtensionQuery;
         result: ReloadExtensionResult;
     };
+    [CommandName.SendOAuthRequest]: {
+        query: SendOAuthRequestQuery;
+        result: SendOAuthRequestResponse;
+    };
     [CommandName.SendUIMessage]: {
         query: SendUIMessageQuery;
         result: SendUIMessageResult;
@@ -265,49 +300,94 @@ export declare type CommandArgs = {
         query: ShowModalQuery;
         result: ShowModalResult;
     };
+    [CommandName.ShowPanel]: {
+        query: ShowPanelQuery;
+        result: ShowPanelResult;
+    };
+    [CommandName.SleepForTestCase]: {
+        query: SleepForTestCaseQuery;
+        result: SleepForTestCaseResult;
+    };
 };
+/** @ignore */
 export declare type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never) extends (x: infer R) => unknown ? R : never;
 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;
+    /** Named action that returns whether the menu item should be visible */
     'v'?: string;
+    /** Named action that returns whether the menu item should be disabled */
     'd'?: string;
+    /** Which menu to put the item in */
     't': MenuType;
+    /** If specified, where to place the menu item; defaults to MenuLocation.Extension */
     'loc'?: MenuLocation;
 };
 export declare type AddMenuItemResult = undefined;
 export declare type AddShapeDataQuery = {
+    /** ID of the element to add this shape data to */
     'id'?: string | undefined;
+    /** Name for this shape data */
     'n': string;
+    /** Inheritance setting for the new shape data */
     'i': ShapeDataInheritance;
+    /** Initial value of this shape data; use a string beginning with '=' for a formula */
     'v'?: SerializedFieldType;
 };
 export declare type AddShapeDataResult = undefined;
+export declare type BootstrapQuery = {
+    /**
+     * Named action that accepts the bootstrap data, and which may return a Promise or void. After awaiting\
+     * the result of the callback, the bootstrap data is cleared.
+     */
+    'c': string;
+};
+export declare type BootstrapResult = Promise<void>;
 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;
+    /** 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' */
     's'?: JsonSerializable | undefined;
 };
 export declare type CreateBlockResult = string;
 export declare type CreateCollectionFieldDefinition = {
+    /** Name of the field */
     'n': string;
+    /** Type of the values in this field */
     't': SerializedFieldTypeDefinition;
 };
 export declare type CreateCollectionQuery = {
+    /** ID of the data source to add this collection to */
     's': string;
+    /** Name of the collection */
     'n': string;
+    /** Fields that can be set on data items in this collection */
     'f': CreateCollectionFieldDefinition[];
+    /** Field(s) to use as the primary key of this collection */
     'p': string[];
 };
 export declare type CreateCollectionResult = string;
 export declare type CreateDataSourceQuery = {
+    /** Name of the data source */
     'n': string;
+    /** Source configuration for this data source--information about where it came from, or any metadata that might be useful */
     's': {
         [key: string]: JsonSerializable;
     };
 };
 export declare type CreateDataSourceResult = string;
 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;
 };
 export declare type CreateLineResult = string;
@@ -318,14 +398,20 @@ export declare type DeleteItemResult = boolean;
 export declare type DeletePageQuery = string;
 export declare type DeletePageResult = boolean;
 export declare type DeleteShapeDataQuery = {
+    /** ID of the element to delete this shape data from */
     'id'?: string | undefined;
+    /** Name for this shape data */
     'n': string;
 };
 export declare type DeleteShapeDataResult = undefined;
 export declare type DownloadQuery = {
+    /** Filename of the download */
     'f': string;
+    /** Data to put in the file */
     'd': string;
+    /** MIME type for the download */
     'm': string;
+    /** If true, data is base64-encoded and should be converted to binary for download */
     'b64': boolean;
 };
 export declare type DownloadResult = undefined;
@@ -334,12 +420,16 @@ export declare type ElementExistsQuery = {
 };
 export declare type ElementExistsResult = boolean;
 export declare type ExecuteFormulaQuery = {
+    /** ID of the element to execute a formula on */
     'id': string;
+    /** Formula to execute, e.g. '@a + @b' or 'CONTAINEDBY' */
     'f': string;
 };
 export declare type ExecuteFormulaResult = SerializedFieldType | SerializedDataError;
 export declare type AnimateViewportQuery = {
+    /** ID of the page to view */
     'p': string;
+    /** Bounding box on that page that will fill as much of the viewport as possible */
     'bb': Box;
 };
 export declare type AnimateViewportResult = Promise<void>;
@@ -352,66 +442,94 @@ export declare type GetConnectedLinesResult = string[];
 export declare type GetCurrentPageQuery = void;
 export declare type GetCurrentPageResult = string | undefined;
 export declare type GetCustomShapeQuery = {
+    /** Name of the custom shape library in this same extension package */
     'l': string;
+    /** Name of the shape in that library to find */
     's': string;
 };
 export declare type GetCustomShapeResult = Promise<{
+    /** Value which can be used as the Stencil property on a dynamic shape */
     's': JsonSerializable;
+    /** Default size (x:0, y:0) of this custom shape */
     'bb': Box;
+    /** Other default property values */
     'p': JsonObject;
 } | undefined>;
 export declare type GetDataItemFieldQuery = {
+    /** Collection ID to query */
     'c': string;
+    /** Primary key of the data item to read */
     'pk': string;
+    /** Name of field to read */
     'f': string;
 };
 export declare type GetDataItemFieldResult = SerializedFieldType;
 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;
+    /** Reference key to get */
     'k': number | string;
 };
 export declare type GetReferenceKeyResult = SerializedReferenceKeyType;
 export declare type GetPropertyQuery = {
+    /** ID of the LucidElement to read a property from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;
+    /** Name of the property to read */
     'p': string;
 };
 export declare type GetPropertyResult = JsonSerializable;
 export declare type GetRelativeLinePositionQuery = {
+    /** Block or line ID to check the connections on */
     'id': string;
+    /** Relative position in range of [0,1] along the line */
     'p': number;
 };
 export declare type GetRelativeLinePositionResult = Point;
 export declare type GetSelectionQuery = {
+    /** If set, additionally return all items inside selected groups */
     'd'?: boolean;
 };
 export declare type GetSelectionResult = string[];
 export declare type GetShapeDataQuery = {
+    /** ID of the element to query shape data from */
     'id'?: string | undefined;
+    /** Name of the shape data to read */
     'n': string;
 };
 export declare type GetShapeDataResult = SerializedFieldType | SerializedDataError;
 export declare type HideModalQuery = {
+    /** Name of the modal's action for receiving events, i.e. ShowModalQuery['n'] */
     'n': string;
 };
 export declare type HideModalResult = undefined;
+export declare type HidePanelQuery = {
+    /** Name of the panel's action for receiving events, i.e. RegisterPanelQuery['n'] */
+    'n': string;
+};
+export declare type HidePanelResult = undefined;
 export declare type KillExtensionQuery = void;
 export declare type KillExtensionResult = undefined;
 export declare type ListChildrenQuery = {
+    /** Parent ID to search inside */
     'id': string;
+    /** "deep" - If true, get all children at any level of group nesting; otherwise only immediate children */
     'd'?: boolean;
 };
 export declare type ListChildrenResult = string[];
 export declare type ListCollectionsQuery = {
+    /** ID of the data source to list collections for */
     'id': string;
 };
 export declare type ListCollectionsResult = string[];
 export declare type ListDataItemsQuery = {
+    /** Collection ID to list items from */
     'id': string;
 };
 export declare type ListDataItemsResult = string[];
 export declare type ListCollectionFieldsQuery = {
+    /** Collection ID to query */
     'id': string;
 };
 export declare type ListCollectionFieldsResult = string[];
@@ -420,8 +538,10 @@ export declare type ListDataSourcesResult = string[];
 export declare type ListPagesQuery = void;
 export declare type ListPagesResult = string[];
 export declare type ListReferenceKeysQuery = {
+    /** ID of the element to list reference keys for, or undefined for the document */
     'id'?: string | undefined;
 };
+/** Reference key IDs */
 export declare type ListReferenceKeysResult = (string | number)[];
 export declare type ListPropertiesQuery = {
     'id'?: string | undefined;
@@ -429,6 +549,7 @@ export declare type ListPropertiesQuery = {
 export declare type ListPropertiesResult = string[];
 export declare type ListShapeDataQuery = {
     'id'?: string | undefined;
+    /** True to include inherited shape data from containing groups and/or page */
     'i'?: boolean | undefined;
 };
 export declare type ListShapeDataResult = string[];
@@ -437,27 +558,57 @@ export declare type ListTextAreasResult = string[];
 export declare type LoadBlockClassesQuery = string[];
 export declare type LoadBlockClassesResult = Promise<undefined>;
 export declare type OffsetItemsQuery = {
+    /** IDs of the items (blocks, lines, groups) to move */
     'ids': string[];
+    /** What kind of offset to perform */
     't': LinearOffsetType;
+    /** How far to offset */
     'o': Point;
 };
 export declare type OffsetItemsResult = undefined;
 export declare type PatchDataItemsQuery = {
+    /** ID of the data collection to patch */
     'id': string;
+    /** Data items to add to the collection */
     'a': Record<string, SerializedFieldType>[];
+    /** Data items to change field values on, keyed by primary key */
     'c': Record<string, Record<string, SerializedFieldType>>;
+    /** Primary keys of items to delete */
     'd': string[];
 };
 export declare type PatchDataItemsResult = undefined;
+export declare type RegisterPanelQuery = {
+    /** Name of the panel's action for receiving events; generated automatically by Panel base class */
+    'n': string;
+    /** Title to show on the panel */
+    't': string;
+    /** Where to display the panel */
+    'l': PanelLocation;
+    /** Named action that returns whether the button to open the panel should be visible */
+    'v'?: string;
+    /** Content to display in the panel; full HTML page preferred */
+    'c': string;
+    /** Icon URL, preferably a base64-encoded URL */
+    'i': string;
+};
+export declare type RegisterPanelResult = undefined;
 export declare type ReloadExtensionQuery = void;
 export declare type ReloadExtensionResult = undefined;
+export declare type SendOAuthRequestQuery = SendXHRQuery & {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
+export declare type SendOAuthRequestResponse = SendXHRResponse;
 export declare type SendUIMessageQuery = {
+    /** Name of the UI component's action for receiving events, e.g. ShowModalQuery['n'] */
     'n': string;
+    /** Content of the message to send to the custom UI component */
     'd'?: JsonSerializable;
 };
 export declare type SendUIMessageResult = undefined;
 export declare type SendXHRQuery = {
     'url': string;
+    /** HTTP method, e.g. 'GET', 'FETCH', etc. Defaults to GET */
     'm'?: string;
     /**
      * The data to send with the request.
@@ -468,46 +619,74 @@ export declare type SendXHRQuery = {
      *   no 'Content-Type' header is specified, a 'text/plain; charset=utf-8' content type is sent.
      */
     'd'?: string;
+    /** Headers to send with the request */
     'h'?: {
         [key: string]: string | string[];
     };
+    /** Timeout in milliseconds, if specified */
     'ms'?: number;
 };
 export declare type RawSendXHRResponse = {
+    /** URL of the response after any redirects */
     'url': string;
+    /** Plain-text response body */
     't': string;
+    /** Status code of the response */
     's': number;
+    /** Headers sent with the response */
     'h': {
         [key: string]: string;
     };
+    /** true if the request timed out */
     'to'?: boolean;
 };
 export declare type SendXHRResponse = Promise<RawSendXHRResponse>;
 export declare type SetCurrentPageQuery = string;
 export declare type SetCurrentPageResult = Promise<void>;
 export declare type SetPropertyQuery = {
+    /** ID of the element to change */
     'id'?: string | undefined;
+    /** Name of the property to change */
     'p': string;
+    /** New value of the property */
     'v'?: JsonSerializable;
 };
 export declare type SetPropertyResult = undefined;
 export declare type SetReferenceKeyQuery = {
+    /** ID of the element to set the reference key on */
     'id'?: string | undefined;
+    /** ID of the reference key to set */
     'k': string | number;
+    /** New reference key settings, or undefined to remove the reference key */
     'v'?: SerializedReferenceKeyType;
 };
 export declare type SetReferenceKeyResult = undefined;
 export declare type SetShapeDataQuery = {
+    /** ID of the element to set this shape data on */
     'id'?: string | undefined;
+    /** Name for the already-existing shape data to update */
     'n': string;
+    /** Value to set; use a string beginning with '=' for a formula */
     'v'?: SerializedFieldType;
 };
 export declare type SetShapeDataResult = undefined;
 export declare type ShowModalQuery = {
+    /** Name of the modal's action for receiving events; generated automatically by Modal base class */
     'n': string;
+    /** Title to show on the modal */
     't': string;
+    /** Desired modal width */
     'w': number;
+    /** Desired modal height */
     'h': number;
+    /** Content to display in the modal; full HTML page preferred */
     'c': string;
 };
 export declare type ShowModalResult = undefined;
+export declare type ShowPanelQuery = {
+    /** Name of the panel's action for receiving events, i.e. RegisterPanelQuery['n'] */
+    'n': string;
+};
+export declare type ShowPanelResult = undefined;
+export declare type SleepForTestCaseQuery = number;
+export declare type SleepForTestCaseResult = Promise<void>;

package/sdk/core/jsonserializable.d.ts

@@ -2,6 +2,10 @@ export declare type JsonArray = Array<JsonSerializable>;
 export interface JsonObject {
     [key: string]: JsonSerializable;
 }
+/**
+ * 'json-able' but specificallyfor json objects
+ * @ignore
+ */
 export interface JsonObjectConvertible {
     toJsonObject(): JsonObject;
 }

package/sdk/data/collectionproxy.d.ts

@@ -1,13 +1,13 @@
 import { SerializedFieldType } from '../core/data/serializedfield/serializedfields';
-import { ElementProxy } from '../document/elementproxy';
 import { MapProxy } from '../document/mapproxy';
+import { PropertyStoreProxy } from '../document/propertystoreproxy';
 import { EditorClient } from '../editorclient';
 import { DataItemProxy } from './dataitemproxy';
 /**
  * A collection is a set of data items, each with the same set of fields (though some data items may not have all
  * fields defined).
  */
-export declare class CollectionProxy extends ElementProxy {
+export declare class CollectionProxy extends PropertyStoreProxy {
     readonly id: string;
     /**
      *

package/sdk/data/collectionproxy.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CollectionProxy = void 0;
-const elementproxy_1 = require("../document/elementproxy");
 const mapproxy_1 = require("../document/mapproxy");
+const propertystoreproxy_1 = require("../document/propertystoreproxy");
 const dataitemproxy_1 = require("./dataitemproxy");
 /**
  * A collection is a set of data items, each with the same set of fields (though some data items may not have all
  * fields defined).
  */
-class CollectionProxy extends elementproxy_1.ElementProxy {
+class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
     /**
      *
      * @param id ID of this collection on the current document

package/sdk/data/datasourceproxy.d.ts

@@ -1,6 +1,6 @@
 import { JsonSerializable } from '../core/jsonserializable';
-import { ElementProxy } from '../document/elementproxy';
 import { MapProxy } from '../document/mapproxy';
+import { PropertyStoreProxy } from '../document/propertystoreproxy';
 import { EditorClient } from '../editorclient';
 import { CollectionProxy } from './collectionproxy';
 import { SchemaDefinition } from './schemadefinition';
@@ -8,7 +8,7 @@ import { SchemaDefinition } from './schemadefinition';
  * A data source represents a set of related data collections on a document. Typically one data source
  * is produced for each data import.
  */
-export declare class DataSourceProxy extends ElementProxy {
+export declare class DataSourceProxy extends PropertyStoreProxy {
     readonly id: string;
     /**
      * @param id ID of the collection on the current document
@@ -21,9 +21,15 @@ export declare class DataSourceProxy extends ElementProxy {
      * the collection ID on other documents if the same data is imported there.
      */
     readonly collections: MapProxy<string, CollectionProxy>;
+    /**
+     * Create a new collection as part of this data source.
+     * @param name
+     * @param schema
+     * @returns The newly created collection
+     */
     addCollection(name: string, schema: SchemaDefinition): CollectionProxy;
     /**
-     * @returns a human-readable name for this data source
+     * @returns A human-readable name for this data source
      */
     getName(): string;
     /**

package/sdk/data/datasourceproxy.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataSourceProxy = void 0;
 const checks_1 = require("../core/checks");
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
-const elementproxy_1 = require("../document/elementproxy");
 const mapproxy_1 = require("../document/mapproxy");
+const propertystoreproxy_1 = require("../document/propertystoreproxy");
 const collectionproxy_1 = require("./collectionproxy");
 /**
  * A data source represents a set of related data collections on a document. Typically one data source
  * is produced for each data import.
  */
-class DataSourceProxy extends elementproxy_1.ElementProxy {
+class DataSourceProxy extends propertystoreproxy_1.PropertyStoreProxy {
     /**
      * @param id ID of the collection on the current document
      * @param client
@@ -25,6 +25,12 @@ class DataSourceProxy extends elementproxy_1.ElementProxy {
          */
         this.collections = new mapproxy_1.MapProxy(() => this.client.sendCommand("lc" /* ListCollections */, { 'id': this.id }), (id) => new collectionproxy_1.CollectionProxy(id, this.client));
     }
+    /**
+     * Create a new collection as part of this data source.
+     * @param name
+     * @param schema
+     * @returns The newly created collection
+     */
     addCollection(name, schema) {
         return new collectionproxy_1.CollectionProxy(this.client.sendCommand("cc" /* CreateCollection */, {
             's': this.id,
@@ -34,7 +40,7 @@ class DataSourceProxy extends elementproxy_1.ElementProxy {
         }), this.client);
     }
     /**
-     * @returns a human-readable name for this data source
+     * @returns A human-readable name for this data source
      */
     getName() {
         return this.properties.get('Name');

package/sdk/data/referencekeydefinition.d.ts

@@ -1,17 +1,43 @@
 import { SerializedReferenceKeyType } from '../core/data/referencekeys/serializedreferencekey';
 import { SerializedFieldType } from '../core/data/serializedfield/serializedfields';
 import { SchemaDefinition } from './schemadefinition';
+/**
+ * A reference key that points to a [DataItem](#classes_data_dataitemproxy-DataItemProxy) in a
+ * [Collection](#classes_data_collectionproxy-CollectionProxy). This is the most common type of
+ * reference key to create.
+ *
+ * For more information, see the [Developer Guide](/extension-api#guide-reference-keys).
+ */
 export interface CollectionReferenceKeyDefinition {
+    /** The ID of the collection referenced */
     collectionId: string;
+    /** The [primary key](#classes_data_dataitemproxy-DataItemProxy_primarykey) of the data item referenced */
     primaryKey: string;
-    fieldWhitelist?: string[];
+    /** If true, prevent the user from editing the field values of this reference key through the normal UI */
     readonly?: boolean;
+    /**
+     * 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[];
 }
+/**
+ * A reference key that has the field values embedded directly in the reference definition. This can be
+ * useful in cases when you want to have a standard schema of data associated with an element but do not
+ * for whatever reason want to construct an actual [Collection](#classes_data_collectionproxy-CollectionProxy)
+ * to house that data.
+ */
 export interface FlattenedReferenceDefinition {
+    /** Name to display to the user for the reference key (what would normally be the collection name) */
     name: string;
+    /** Schema of the data stored at this key */
     schema: SchemaDefinition;
+    /** Field values available at this reference key */
     data: Record<string, SerializedFieldType>;
 }
 export declare type ReferenceKeyDefinition = CollectionReferenceKeyDefinition | FlattenedReferenceDefinition;
+/** @ignore */
 export declare function isCollectionReferenceKeyDefinition(def: ReferenceKeyDefinition): def is CollectionReferenceKeyDefinition;
+/** @ignore */
 export declare function serializeReferenceKeyDefinition(def: ReferenceKeyDefinition): SerializedReferenceKeyType;