@airtable/blocks 1.7.0 → 1.9.0-experimental

package/dist/types/src/types/block_query_spec.d.ts

@@ -0,0 +1,139 @@
+import { ObjectMap } from '../private_utils';
+import { TableId } from './table';
+import { ViewId } from './view';
+import { RecordId } from './record';
+import { FieldId } from './field';
+/**
+ * Specification for data needed by both the Blocks SDK and the blocks iframe
+ * that spans across a few repos and run environments:
+ * +--------------------+--------------------+--------------------+
+ * | airtable.com       | blocks iframe      | blocks sdk         |
+ * +--------------------+--------------------+--------------------+
+ * | repo: hyperbase    | repo: hyperbase    | repo: blocks-sdk   |
+ * | run: airtable.com  | run: iframe        | run: iframe        |
+ * +--------------------+--------------------+--------------------+
+ *
+ * A BlockQuerySpec has a required `source` and one or more `selection`s.
+ * The `source` is a top-level concept that defines where the data comes
+ * from, while the `selection`s define desired properties from the data.
+ * In other words, think of the data as a tree, the `source` defines the
+ * root, and the `selection`s define the branches and leaves.
+ *
+ * Note that instead of a sub-object `source`, we use `source`-prefixed
+ * properties for the same effect. This works around a TypeScript limitation
+ * of not being able to discriminate between the unions for BlockQuerySpec.
+ *
+ * The specification will be used for two parts of the data lifecycle:
+ * 1. An initial response, via BlockQuerySpecResponseForAirtableInterface
+ * 2. Subsequent updates to keep the date updated, via BlockQueryUpdate
+ *
+ * NOTE: Keep this in sync with the hyperbase repo's block_query_spec.tsx file!
+ *
+ * @hidden
+ */
+export declare type BlockQuerySpec = BlockTableQuerySpec | BlockViewQuerySpec;
+/** @hidden */
+export interface BlockTableQuerySpec {
+    sourceType: BlockQuerySourceType.TABLE;
+    sourceTableId: TableId;
+    recordSelection: BlockRecordSelectionSpec;
+}
+/** @hidden */
+export interface BlockViewQuerySpec {
+    sourceType: BlockQuerySourceType.VIEW;
+    sourceTableId: TableId;
+    sourceViewId: ViewId;
+    recordSelection?: BlockRecordSelectionSpec;
+    viewMetadataSelection?: BlockViewMetadataSelectionSpec;
+}
+/** @hidden */
+export declare enum BlockQuerySourceType {
+    TABLE = "table",
+    VIEW = "view"
+}
+/** @hidden */
+export interface BlockRecordSelectionSpec {
+    readonly fieldSelection: BlockFieldSelectionSpec;
+    /** Optionally filter down to more specific recordIds from the source */
+    readonly recordIds?: Array<RecordId>;
+}
+/**
+ * The different ways fields can be queried
+ *
+ * @hidden
+ */
+export declare enum BlockFieldSelectionSpecType {
+    SPECIFIED_FIELDS = "specifiedFields",
+    ALL_FIELDS_FROM_TABLE = "allFieldsFromTable"
+}
+/**
+ * Allows querying for all fields, or a specified set of fields. In the latter
+ * case, we also allow specifying properties of a record like commentCount and
+ * recordCreatedTime that don't have fieldIds (ALL_FIELDS implies including all
+ * of these properties).
+ *
+ * @hidden
+ */
+export declare type BlockFieldSelectionSpec = {
+    readonly type: BlockFieldSelectionSpecType.SPECIFIED_FIELDS;
+    readonly fieldIds: Array<FieldId>;
+    readonly shouldIncludeCommentCount?: boolean;
+    readonly shouldIncludeRecordCreatedTime?: boolean;
+} | {
+    readonly type: BlockFieldSelectionSpecType.ALL_FIELDS_FROM_TABLE;
+};
+/** @hidden */
+export interface BlockViewMetadataSelectionSpec {
+    readonly shouldIncludeVisibleRecordIds?: boolean;
+    readonly shouldIncludeFieldOrder?: boolean;
+    readonly shouldIncludeGroups?: boolean;
+    readonly shouldIncludeGroupingLevels?: boolean;
+    readonly shouldIncludeColorsForRecordId?: boolean;
+}
+/**
+ * Response recieved from an executed query.
+ *
+ * @hidden
+ */
+export declare type QuerySpecsResponse = {
+    readonly success: true;
+    readonly blockQueryId: BlockQueryId;
+} | {
+    readonly success: false;
+};
+/**
+ * An id returned from airtable for an active and executing query. If two queries sent
+ * to airtable return the same queryId this means the queries are semantically the same.
+ * It is however possible for two canonically identical queries to be tracked via two
+ * separate blockQueryIds (in the case realtime subscriptions are made with different
+ * callbacks).
+ *
+ * @hidden
+ */
+export declare type BlockQueryId = string;
+/** @hidden */
+export declare enum BlockQuerySubscriptionChangeType {
+    ADDED_RECORD_IDS = "addedRecordIds",
+    REMOVED_RECORD_IDS = "removedRecordIds",
+    MODIFIED_CELL_VALUES_FOR_TABLE = "modifiedCellValuesForTable",
+    CHANGED_COLORS_BY_RECORD_ID_FOR_VIEW = "changedColorsByRecordIdForView"
+}
+/** @hidden */
+export declare type BlockQuerySubscriptionChange = {
+    type: BlockQuerySubscriptionChangeType.ADDED_RECORD_IDS | BlockQuerySubscriptionChangeType.REMOVED_RECORD_IDS;
+    tableId: TableId;
+    recordIds: Array<RecordId>;
+} | {
+    type: BlockQuerySubscriptionChangeType.MODIFIED_CELL_VALUES_FOR_TABLE;
+    tableId: TableId;
+    fieldIdsByRecordId: ObjectMap<RecordId, Array<FieldId>>;
+    fieldIds: Array<FieldId>;
+} | {
+    type: BlockQuerySubscriptionChangeType.CHANGED_COLORS_BY_RECORD_ID_FOR_VIEW;
+    tableId: TableId;
+    viewId: ViewId;
+    recordIds: Array<RecordId>;
+};
+/** @hidden */
+export declare type BlockQuerySubscriptionOnChangeCallback = (changes: Array<BlockQuerySubscriptionChange>) => void;
+//# sourceMappingURL=block_query_spec.d.ts.map

package/dist/types/src/types/block_query_spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_query_spec.d.ts","sourceRoot":"","sources":["../../../../src/types/block_query_spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAC,QAAQ,EAAC,MAAM,UAAU,CAAC;AAClC,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,oBAAY,cAAc,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AACtE,cAAc;AACd,MAAM,WAAW,mBAAmB;IAChC,UAAU,EAAE,oBAAoB,CAAC,KAAK,CAAC;IACvC,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,wBAAwB,CAAC;CAC7C;AACD,cAAc;AACd,MAAM,WAAW,kBAAkB;IAC/B,UAAU,EAAE,oBAAoB,CAAC,IAAI,CAAC;IACtC,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C,qBAAqB,CAAC,EAAE,8BAA8B,CAAC;CAC1D;AACD,cAAc;AACd,oBAAY,oBAAoB;IAC5B,KAAK,UAAU;IACf,IAAI,SAAS;CAChB;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACrC,QAAQ,CAAC,cAAc,EAAE,uBAAuB,CAAC;IACjD,wEAAwE;IACxE,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAGxC;AAED;;;;GAIG;AACH,oBAAY,2BAA2B;IACnC,gBAAgB,oBAAoB;IACpC,qBAAqB,uBAAuB;CAC/C;AAED;;;;;;;GAOG;AACH,oBAAY,uBAAuB,GAC7B;IACI,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC,gBAAgB,CAAC;IAC5D,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAElC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;CACrD,GACD;IACI,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC,qBAAqB,CAAC;CACpE,CAAC;AAER,cAAc;AACd,MAAM,WAAW,8BAA8B;IAK3C,QAAQ,CAAC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACjD,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAC3C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAC/C,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;GAIG;AACH,oBAAY,kBAAkB,GACxB;IACI,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACvC,GACD;IACI,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;CAC3B,CAAC;AAER;;;;;;;;GAQG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC,cAAc;AACd,oBAAY,gCAAgC;IACxC,gBAAgB,mBAAmB;IACnC,kBAAkB,qBAAqB;IACvC,8BAA8B,+BAA+B;IAC7D,oCAAoC,mCAAmC;CAC1E;AAED,cAAc;AACd,oBAAY,4BAA4B,GAClC;IAII,IAAI,EACE,gCAAgC,CAAC,gBAAgB,GACjD,gCAAgC,CAAC,kBAAkB,CAAC;IAC1D,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B,GACD;IAGI,IAAI,EAAE,gCAAgC,CAAC,8BAA8B,CAAC;IACtE,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC5B,GACD;IACI,IAAI,EAAE,gCAAgC,CAAC,oCAAoC,CAAC;IAC5E,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC9B,CAAC;AAER,cAAc;AACd,oBAAY,sCAAsC,GAAG,CACjD,OAAO,EAAE,KAAK,CAAC,4BAA4B,CAAC,KAC3C,IAAI,CAAC"}

package/dist/types/src/types/field.d.ts

@@ -137,7 +137,7 @@ export declare enum FieldType {
      *     color?: Color
      * }
      * ```
-     * The currently selected choices.
+     * The currently selected choice.
      *
      * **Cell write format**
      * ```js
@@ -170,9 +170,10 @@ export declare enum FieldType {
      *     >,
      * }
      * ```
-     * You must pass all pre-existing choices in `choices` when updating a `SINGLE_SELECT` field
-     * (similar to updating a `MULTIPLE` field type cell value). You can do this by spreading
-     * the current choices:
+     * The default behavior of calling `updateOptionsAsync` on a `SINGLE_SELECT` field allows
+     * choices to be added or updated, but not deleted. Therefore, you should pass all pre-existing
+     * choices in `choices` (similar to updating a `MULTIPLE_SELECTS` field type cell value). You can
+     * do this by spreading the current choices:
      * ```js
      * const selectField = table.getFieldByName('My select field');
      * await selectField.updateOptionsAsync({
@@ -180,7 +181,22 @@ export declare enum FieldType {
      *         ...selectField.options.choices,
      *         {name: 'My new choice'},
      *     ],
-     * })
+     * });
+     *
+     * ```
+     *
+     * If you want to allow choices to be deleted, you can pass an object with
+     * `enableSelectFieldChoiceDeletion: true` as the second argument. By passing this argument,
+     * any existing choices which are not passed again via `choices` will be deleted, and any
+     * cells which referenced a now-deleted choice will be cleared.
+     * ```js
+     * const selectField = table.getFieldByName('My select field');
+     * await selectField.updateOptionsAsync(
+     *     {
+     *         choices: selectField.options.choices.filter((choice) => choice.name !== 'Choice to delete'),
+     *     },
+     *     {enableSelectFieldChoiceDeletion: true},
+     * );
      *
      * ```
      */
@@ -228,9 +244,10 @@ export declare enum FieldType {
      *     >,
      * }
      * ```
-     * You must pass all pre-existing choices in `choices` when updating a `MULTIPLE_SELECT` field
-     * (similar to updating a `MULTIPLE` field type cell value). You can do this by spreading
-     * the current choices:
+     * The default behavior of calling `updateOptionsAsync` on a `MULTIPLE_SELECTS` field allows
+     * choices to be added or updated, but not deleted. Therefore, you should pass all pre-existing
+     * choices in `choices` (similar to updating a `SINGLE_SELECT` field type cell value). You can
+     * do this by spreading the current choices:
      * ```js
      * const multipleSelectField = table.getFieldByName('My multiple select field');
      * await multipleSelectField.updateOptionsAsync({
@@ -238,7 +255,22 @@ export declare enum FieldType {
      *         ...multipleSelectField.options.choices,
      *         {name: 'My new choice'},
      *     ],
-     * })
+     * });
+     *
+     * ```
+     *
+     * If you want to allow choices to be deleted, you can pass an object with
+     * `enableSelectFieldChoiceDeletion: true` as the second argument. By passing this argument,
+     * any existing choices which are not passed again via `choices` will be deleted, and any
+     * cells which referenced a now-deleted choice will be cleared.
+     * ```js
+     * const multipleSelectField = table.getFieldByName('My multiple select field');
+     * await multipleSelectField.updateOptionsAsync(
+     *     {
+     *         choices: multipleSelectField.options.choices.filter((choice) => choice.name !== 'Choice to delete'),
+     *     },
+     *     {enableSelectFieldChoiceDeletion: true},
+     * );
      *
      * ```
      */
@@ -343,7 +375,7 @@ export declare enum FieldType {
      *         ...myRecord.getCellValue('myLinkedRecordField'),
      *         { id: newForeignRecordIdToLink }
      *     ]
-     * })
+     * });
      * ```
      *
      * Similarly, you can clear the current cell value by passing an empty array, or
@@ -379,6 +411,11 @@ export declare enum FieldType {
      *     // Airtable UI (i.e. most recent first)
      *     // You generally do not need to rely on this option.
      *     isReversed: boolean,
+     *     // Whether this field prefers to only have a single linked record. While this preference
+     *     // is enforced in the Airtable UI, it is possible for a field that prefers single linked
+     *     // records to have multiple record links (for example, via copy-and-paste or programmatic
+     *     // updates).
+     *     prefersSingleRecordLink: boolean,
      * }
      * ```
      *
@@ -390,6 +427,8 @@ export declare enum FieldType {
      *     // The ID of the view in the linked table to use when showing
      *     // a list of records to select from
      *     viewIdForRecordSelection?: ViewId,
+     *     // Note: prefersSingleRecordLink cannot be specified via programmatic field creation
+     *     // and will be false for fields created within an app
      * }
      * ```
      *
@@ -421,22 +460,25 @@ export declare enum FieldType {
      * **Field options read format**
      * ```js
      * {
-     *     dateFormat: {
-     *         name: 'local' | 'friendly' | 'us' | 'european' | 'iso',
-     *         // Will correspond to name (e.g. {name: 'friendly', format: 'LL'}
-     *         format: 'l' | 'LL' | 'M/D/YYYY' | 'D/M/YYYY' | 'YYYY-MM-DD',
-     *     }
+     *     dateFormat:
+     *          | {name: 'local', format: 'l'}
+     *          | {name: 'friendly', format: 'LL'}
+     *          | {name: 'us', format: 'M/D/YYYY'}
+     *          | {name: 'european', format: 'D/M/YYYY'}
+     *          | {name: 'iso', format: 'YYYY-MM-DD'}
      * }
      * ```
      *
      * **Field options write format**
      * ```js
      * {
-     *     dateFormat: {
-     *         name: 'local' | 'friendly' | 'us' | 'european' | 'iso',
-     *         // Format is optional, but must match name if provided.
-     *         format?: 'l' | 'LL' | 'M/D/YYYY' | 'D/M/YYYY' | 'YYYY-MM-DD',
-     *     }
+     *     dateFormat:
+     *          // Format is optional, but must match name if provided.
+     *          | {name: 'local', format?: 'l'}
+     *          | {name: 'friendly', format?: 'LL'}
+     *          | {name: 'us', format?: 'M/D/YYYY'}
+     *          | {name: 'european', format?: 'D/M/YYYY'}
+     *          | {name: 'iso', format?: 'YYYY-MM-DD'}
      * }
      * ```
      */
@@ -465,16 +507,15 @@ export declare enum FieldType {
      * **Field options read format**
      * ```js
      * {
-     *     dateFormat: {
-     *         name: 'local' | 'friendly' | 'us' | 'european' | 'iso',
-     *         // Will correspond to name (e.g. {name: 'friendly', format: 'LL'}
-     *         format: 'l' | 'LL' | 'M/D/YYYY' | 'D/M/YYYY' | 'YYYY-MM-DD',
-     *     },
-     *     timeFormat: {
-     *         name: '12hour' | '24hour',
-     *         // Will correspond to name
-     *         format: 'h:mma' | 'HH:mm',
-     *     },
+     *     dateFormat:
+     *          | {name: 'local', format: 'l'}
+     *          | {name: 'friendly', format: 'LL'}
+     *          | {name: 'us', format: 'M/D/YYYY'}
+     *          | {name: 'european', format: 'D/M/YYYY'}
+     *          | {name: 'iso', format: 'YYYY-MM-DD'},
+     *     timeFormat:
+     *          | {name: '12hour', format: 'h:mma'}
+     *          | {name: '24hour', format: 'HH:mm'},
      *     timeZone: 'utc' | 'client',
      * }
      * ```
@@ -482,16 +523,17 @@ export declare enum FieldType {
      * **Field options write format**
      * ```js
      * {
-     *     dateFormat: {
-     *         name: 'local' | 'friendly' | 'us' | 'european' | 'iso',
-     *         // Format is optional, but must match name if provided.
-     *         format?: 'l' | 'LL' | 'M/D/YYYY' | 'D/M/YYYY' | 'YYYY-MM-DD',
-     *     },
-     *     timeFormat: {
-     *         name: '12hour' | '24hour',
-     *         // Format is optional, but must match name if provided.
-     *         format?: 'h:mma' | 'HH:mm',
-     *     },
+     *     dateFormat:
+     *          // Format is optional, but must match name if provided.
+     *          | {name: 'local', format?: 'l'}
+     *          | {name: 'friendly', format?: 'LL'}
+     *          | {name: 'us', format?: 'M/D/YYYY'}
+     *          | {name: 'european', format?: 'D/M/YYYY'}
+     *          | {name: 'iso', format?: 'YYYY-MM-DD'},
+     *     timeFormat:
+     *          // Format is optional, but must match name if provided.
+     *          | {name: '12hour', format?: 'h:mma'}
+     *          | {name: '24hour', format?: 'HH:mm'},
      *     timeZone: 'utc' | 'client',
      * }
      * ```
@@ -523,7 +565,7 @@ export declare enum FieldType {
      *         ...myRecord.getCellValue('myAttachmentField'),
      *         { url: newAttachmentUrl }
      *     ]
-     * })
+     * });
      * ```
      *
      * Similarly, you can clear the current cell value by passing an empty array, or
@@ -531,7 +573,13 @@ export declare enum FieldType {
      * value.
      *
      * Note: when you pass an existing attachment, you must pass the full attachment
-     * object. New attachments only require the `url` property.
+     * object. New attachments only require the `url` property. You can optionally
+     * pass the \`filename\` property to give it a readable name.
+     *
+     * Additionally, the Airtable generated attachment URLs do not currently expire,
+     * but this will change in the future. If you want to persist the attachments, we
+     * recommend downloading them instead of saving the URL. Before this change is
+     * rolled out, we will post a more detailed deprecation timeline.
      *
      * **Cell read format**
      * ```js
@@ -600,11 +648,19 @@ export declare enum FieldType {
     /**
      * A checkbox.
      *
-     * This field is "true" when checked and otherwise empty.
+     * This field is "true" when checked and "null" when unchecked.
      *
-     * **Cell format**
+     * **Cell read format**
      * ```js
-     * boolean
+     * true | null
+     * ```
+     *
+     * You can write to the cell with "false", but the read value will be still be "null"
+     * (unchecked).
+     *
+     * **Cell write format**
+     * ```js
+     * boolean | null
      * ```
      *
      * **Field options**
@@ -1043,7 +1099,43 @@ export declare enum FieldType {
      * Creating or updating `BUTTON` fields is not supported.
      *
      */
-    BUTTON = "button"
+    BUTTON = "button",
+    /**
+     * Shows the name of the source that a record is synced from. This field is only available on
+     * synced tables.
+     *
+     * **Cell read format**
+     * ```js
+     * {
+     *     id: string,
+     *     name: string,
+     *     color?: Color
+     * }
+     * ```
+     *
+     * **Cell write format**
+     *
+     * n/a
+     *
+     * **Field options read format**
+     * ```js
+     * {
+     *     choices: Array<{
+     *         id: string,
+     *         name: string,
+     *         color?: {@link Color}, // Color is not provided when field coloring is disabled.
+     *     }>,
+     * }
+     * ```
+     * Every choice represents a sync source, and choices are added or removed automatically as
+     * sync sources are added or removed. Choice names and colors are user-configurable.
+     *
+     * **Field options write format**
+     *
+     * Creating or updating `EXTERNAL_SYNC_SOURCE` fields is not supported.
+     *
+     */
+    EXTERNAL_SYNC_SOURCE = "externalSyncSource"
 }
 /** @hidden */
 export declare type FieldLock = unknown;
@@ -1100,19 +1192,35 @@ interface LinkedRecordFieldOptions {
     inverseLinkFieldId?: FieldId;
     viewIdForRecordSelection?: ViewId;
     isReversed: boolean;
+    prefersSingleRecordLink: boolean;
 }
 /** @hidden */
 interface DateFieldOptions {
     dateFormat: {
-        name: 'local' | 'friendly' | 'us' | 'european' | 'iso';
-        format: 'l' | 'LL' | 'M/D/YYYY' | 'D/M/YYYY' | 'YYYY-MM-DD';
+        name: 'local';
+        format: 'l';
+    } | {
+        name: 'friendly';
+        format: 'LL';
+    } | {
+        name: 'us';
+        format: 'M/D/YYYY';
+    } | {
+        name: 'european';
+        format: 'D/M/YYYY';
+    } | {
+        name: 'iso';
+        format: 'YYYY-MM-DD';
     };
 }
 /** @hidden */
 interface DateTimeFieldOptions extends DateFieldOptions {
     timeFormat: {
-        name: '12hour' | '24hour';
-        format: 'h:mma' | 'HH:mm';
+        name: '12hour';
+        format: 'h:mma';
+    } | {
+        name: '24hour';
+        format: 'HH:mm';
     };
     timeZone: 'utc' | 'client';
 }
@@ -1181,6 +1289,9 @@ interface LastModifiedByFieldOptions extends CreatedByFieldOptions {
     referencedFieldIds: Array<FieldId>;
 }
 /** @hidden */
+interface ExternalSyncSourceFieldOptions extends SelectFieldOptions {
+}
+/** @hidden */
 interface OptionlessFieldConfig {
     type: FieldType.SINGLE_LINE_TEXT | FieldType.EMAIL | FieldType.URL | FieldType.MULTILINE_TEXT | FieldType.PHONE_NUMBER | FieldType.AUTO_NUMBER | FieldType.BARCODE | FieldType.RICH_TEXT | FieldType.BUTTON;
     options: null;
@@ -1280,6 +1391,11 @@ interface LastModifiedByFieldConfig {
     type: FieldType.LAST_MODIFIED_BY;
     options: LastModifiedByFieldOptions;
 }
+/** @hidden */
+interface ExternalSyncSourceFieldConfig {
+    type: FieldType.EXTERNAL_SYNC_SOURCE;
+    options: ExternalSyncSourceFieldOptions;
+}
 /**
  * A type for use with Field objects to make type narrowing FieldOptions easier.
  *
@@ -1294,6 +1410,6 @@ interface LastModifiedByFieldConfig {
  * }
  * return DEFAULT_CHOICES;
  */
-export declare type FieldConfig = OptionlessFieldConfig | NumericFieldConfig | CurrencyFieldConfig | SelectFieldConfig | CollaboratorFieldConfig | LinkedRecordFieldConfig | DateFieldConfig | DateTimeFieldConfig | AttachmentsFieldConfig | CheckboxFieldConfig | FormulaFieldConfig | CreatedTimeFieldConfig | RollupFieldConfig | CountFieldConfig | LookupFieldConfig | RatingFieldConfig | DurationFieldConfig | LastModifiedTimeFieldConfig | CreatedByFieldConfig | LastModifiedByFieldConfig;
+export declare type FieldConfig = OptionlessFieldConfig | NumericFieldConfig | CurrencyFieldConfig | SelectFieldConfig | CollaboratorFieldConfig | LinkedRecordFieldConfig | DateFieldConfig | DateTimeFieldConfig | AttachmentsFieldConfig | CheckboxFieldConfig | FormulaFieldConfig | CreatedTimeFieldConfig | RollupFieldConfig | CountFieldConfig | LookupFieldConfig | RatingFieldConfig | DurationFieldConfig | LastModifiedTimeFieldConfig | CreatedByFieldConfig | LastModifiedByFieldConfig | ExternalSyncSourceFieldConfig;
 export {};
 //# sourceMappingURL=field.d.ts.map

package/dist/types/src/types/field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../../src/types/field.ts"],"names":[],"mappings":"AAAA,6CAA6C,CAAC,MAAM;AACpD,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AAChC,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAE9B,MAAM;AACN,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,cAAc;AACd,oBAAY,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;;;;;;;;;GAUG;AACH,oBAAY,SAAS;IACjB;;;;;;;;;;;OAWG;IACH,gBAAgB,mBAAmB;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,UAAU;IACf;;;;;;;;;;;OAWG;IACH,GAAG,QAAQ;IACX;;;;;;;;;;;;OAYG;IACH,cAAc,kBAAkB;IAChC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,aAAa,iBAAiB;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,gBAAgB,oBAAoB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,mBAAmB,uBAAuB;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,sBAAsB,0BAA0B;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,qBAAqB,wBAAwB;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,SAAS;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,SAAS,aAAa;IACtB;;;;;;;;;;;OAWG;IACH,YAAY,gBAAgB;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqFG;IACH,oBAAoB,wBAAwB;IAC5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,YAAY,gBAAgB;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,UAAU;IACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,sBAAsB,yBAAyB;IAC/C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;OAcG;IACH,SAAS,aAAa;IACtB;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,kBAAkB,qBAAqB;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,cAAc;IACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,gBAAgB,mBAAmB;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,WAAW;CACpB;AAED,cAAc;AACd,oBAAY,SAAS,GAAG,OAAO,CAAC;AAChC,cAAc;AACd,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;IACxB,WAAW,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IACzD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;CACnC;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAID,cAAc;AACd,UAAU,mBAAmB;IACzB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,cAAc;AACd,UAAU,oBAAqB,SAAQ,mBAAmB;IACtD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,OAAO,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;KACjB,CAAC,CAAC;CACN;AAED,cAAc;AACd,UAAU,wBAAwB;IAC9B,OAAO,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;CACN;AAED,cAAc;AACd,UAAU,wBAAwB;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,cAAc;AACd,UAAU,gBAAgB;IACtB,UAAU,EAAE;QACR,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,GAAG,UAAU,GAAG,KAAK,CAAC;QACvD,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;KAC/D,CAAC;CACL;AAED,cAAc;AACd,UAAU,oBAAqB,SAAQ,gBAAgB;IACnD,UAAU,EAAE;QACR,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAC1B,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC;KAC7B,CAAC;IACF,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;CAC9B;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IACvD,KAAK,EACC,cAAc,GACd,cAAc,GACd,WAAW,GACX,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;CACtB;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,WAAW,CAAC;CACvB;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAC;CACjD;AAED,cAAc;AACd,UAAU,kBAAmB,SAAQ,mBAAmB;IACpD,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,CAAC;CACjC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,EAAE,OAAO,CAAC;CAC9B;AAED,cAAc;AACd,aAAK,kBAAkB,GACjB;IACI,OAAO,EAAE,IAAI,CAAC;IACd,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,WAAW,CAAC;CACvB,GACD;IACI,OAAO,EAAE,KAAK,CAAC;IACf,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAER,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EACC,cAAc,GACd,cAAc,GACd,WAAW,GACX,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;CACtB;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,cAAc,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;CACnF;AAED,cAAc;AACd,UAAU,4BAA4B;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAC;CACjD;AAED,cAAc;AACd,UAAU,qBAAsB,SAAQ,wBAAwB;CAAG;AAEnE,cAAc;AACd,UAAU,0BAA2B,SAAQ,qBAAqB;IAC9D,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACtC;AAED,cAAc;AACd,UAAU,qBAAqB;IAC3B,IAAI,EACE,SAAS,CAAC,gBAAgB,GAC1B,SAAS,CAAC,KAAK,GACf,SAAS,CAAC,GAAG,GACb,SAAS,CAAC,cAAc,GACxB,SAAS,CAAC,YAAY,GACtB,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,OAAO,GACjB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,IAAI,CAAC;CACjB;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;IAC3C,OAAO,EAAE,mBAAmB,CAAC;CAChC;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAC3D,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,IAAI,EAAE,SAAS,CAAC,mBAAmB,GAAG,SAAS,CAAC,sBAAsB,GAAG,SAAS,CAAC,UAAU,CAAC;IAC9F,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,IAAI,EAAE,SAAS,CAAC,qBAAqB,CAAC;IACtC,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED,cAAc;AACd,UAAU,eAAe;IACrB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,OAAO,EAAE,gBAAgB,CAAC;CAC7B;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,sBAAsB;IAC5B,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC;IACrC,OAAO,EAAE,uBAAuB,CAAC;CACpC;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC;IACxB,OAAO,EAAE,mBAAmB,CAAC;CAChC;AAED,cAAc;AACd,UAAU,sBAAsB;IAC5B,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;IAC7B,OAAO,EAAE,uBAAuB,CAAC;CACpC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,gBAAgB;IACtB,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACtB,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC;IACvC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,2BAA2B;IACjC,IAAI,EAAE,SAAS,CAAC,kBAAkB,CAAC;IACnC,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,cAAc;AACd,UAAU,yBAAyB;IAC/B,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC;IACjC,OAAO,EAAE,0BAA0B,CAAC;CACvC;AAED;;;;;;;;;;;;;GAaG;AACH,oBAAY,WAAW,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,uBAAuB,GACvB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,kBAAkB,GAClB,sBAAsB,GACtB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,2BAA2B,GAC3B,oBAAoB,GACpB,yBAAyB,CAAC"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../../src/types/field.ts"],"names":[],"mappings":"AAAA,6CAA6C,CAAC,MAAM;AACpD,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AAChC,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAChC,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAE9B,MAAM;AACN,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,cAAc;AACd,oBAAY,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;;;;;;;;;GAUG;AACH,oBAAY,SAAS;IACjB;;;;;;;;;;;OAWG;IACH,gBAAgB,mBAAmB;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,UAAU;IACf;;;;;;;;;;;OAWG;IACH,GAAG,QAAQ;IACX;;;;;;;;;;;;OAYG;IACH,cAAc,kBAAkB;IAChC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,aAAa,iBAAiB;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,gBAAgB,oBAAoB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,mBAAmB,uBAAuB;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,sBAAsB,0BAA0B;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,qBAAqB,wBAAwB;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,SAAS;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,SAAS,aAAa;IACtB;;;;;;;;;;;OAWG;IACH,YAAY,gBAAgB;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2FG;IACH,oBAAoB,wBAAwB;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,YAAY,gBAAgB;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,UAAU;IACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,sBAAsB,yBAAyB;IAC/C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,YAAY;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;OAcG;IACH,SAAS,aAAa;IACtB;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,aAAa;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,kBAAkB,qBAAqB;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,cAAc;IACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,gBAAgB,mBAAmB;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,WAAW;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,oBAAoB,uBAAuB;CAC9C;AAED,cAAc;AACd,oBAAY,SAAS,GAAG,OAAO,CAAC;AAChC,cAAc;AACd,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;IACxB,WAAW,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IACzD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;CACnC;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAID,cAAc;AACd,UAAU,mBAAmB;IACzB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,cAAc;AACd,UAAU,oBAAqB,SAAQ,mBAAmB;IACtD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,OAAO,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;KACjB,CAAC,CAAC;CACN;AAED,cAAc;AACd,UAAU,wBAAwB;IAC9B,OAAO,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;CACN;AAED,cAAc;AACd,UAAU,wBAAwB;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,UAAU,EAAE,OAAO,CAAC;IACpB,uBAAuB,EAAE,OAAO,CAAC;CACpC;AAED,cAAc;AACd,UAAU,gBAAgB;IACtB,UAAU,EACJ;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAC,GAC5B;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAC,GAChC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAC,GAChC;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAC,GACtC;QAAC,IAAI,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,YAAY,CAAA;KAAC,CAAC;CAC7C;AAED,cAAc;AACd,UAAU,oBAAqB,SAAQ,gBAAgB;IACnD,UAAU,EAAE;QAAC,IAAI,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAC,GAAG;QAAC,IAAI,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAC,CAAC;IAClF,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;CAC9B;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IACvD,KAAK,EACC,cAAc,GACd,cAAc,GACd,WAAW,GACX,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;CACtB;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,WAAW,CAAC;CACvB;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAC;CACjD;AAED,cAAc;AACd,UAAU,kBAAmB,SAAQ,mBAAmB;IACpD,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,CAAC;CACjC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,EAAE,OAAO,CAAC;CAC9B;AAED,cAAc;AACd,aAAK,kBAAkB,GACjB;IACI,OAAO,EAAE,IAAI,CAAC;IACd,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,WAAW,CAAC;CACvB,GACD;IACI,OAAO,EAAE,KAAK,CAAC;IACf,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAER,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EACC,cAAc,GACd,cAAc,GACd,WAAW,GACX,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,YAAY,CAAC;CACtB;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,cAAc,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;CACnF;AAED,cAAc;AACd,UAAU,4BAA4B;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAC;CACjD;AAED,cAAc;AACd,UAAU,qBAAsB,SAAQ,wBAAwB;CAAG;AAEnE,cAAc;AACd,UAAU,0BAA2B,SAAQ,qBAAqB;IAC9D,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACtC;AAED,cAAc;AACd,UAAU,8BAA+B,SAAQ,kBAAkB;CAAG;AAEtE,cAAc;AACd,UAAU,qBAAqB;IAC3B,IAAI,EACE,SAAS,CAAC,gBAAgB,GAC1B,SAAS,CAAC,KAAK,GACf,SAAS,CAAC,GAAG,GACb,SAAS,CAAC,cAAc,GACxB,SAAS,CAAC,YAAY,GACtB,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,OAAO,GACjB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,IAAI,CAAC;CACjB;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;IAC3C,OAAO,EAAE,mBAAmB,CAAC;CAChC;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAC3D,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,IAAI,EAAE,SAAS,CAAC,mBAAmB,GAAG,SAAS,CAAC,sBAAsB,GAAG,SAAS,CAAC,UAAU,CAAC;IAC9F,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED,cAAc;AACd,UAAU,uBAAuB;IAC7B,IAAI,EAAE,SAAS,CAAC,qBAAqB,CAAC;IACtC,OAAO,EAAE,wBAAwB,CAAC;CACrC;AAED,cAAc;AACd,UAAU,eAAe;IACrB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,OAAO,EAAE,gBAAgB,CAAC;CAC7B;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,sBAAsB;IAC5B,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC;IACrC,OAAO,EAAE,uBAAuB,CAAC;CACpC;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,kBAAkB;IACxB,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC;IACxB,OAAO,EAAE,mBAAmB,CAAC;CAChC;AAED,cAAc;AACd,UAAU,sBAAsB;IAC5B,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;IAC7B,OAAO,EAAE,uBAAuB,CAAC;CACpC;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,gBAAgB;IACtB,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACtB,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,sBAAsB,CAAC;IACvC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,cAAc;AACd,UAAU,mBAAmB;IACzB,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,oBAAoB,CAAC;CACjC;AAED,cAAc;AACd,UAAU,2BAA2B;IACjC,IAAI,EAAE,SAAS,CAAC,kBAAkB,CAAC;IACnC,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,cAAc;AACd,UAAU,oBAAoB;IAC1B,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,cAAc;AACd,UAAU,yBAAyB;IAC/B,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC;IACjC,OAAO,EAAE,0BAA0B,CAAC;CACvC;AAED,cAAc;AACd,UAAU,6BAA6B;IACnC,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC;IACrC,OAAO,EAAE,8BAA8B,CAAC;CAC3C;AAED;;;;;;;;;;;;;GAaG;AACH,oBAAY,WAAW,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,uBAAuB,GACvB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,kBAAkB,GAClB,sBAAsB,GACtB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,2BAA2B,GAC3B,oBAAoB,GACpB,yBAAyB,GACzB,6BAA6B,CAAC"}

package/dist/types/src/types/mutations.d.ts

@@ -14,6 +14,7 @@ export declare const MutationTypes: Readonly<{
     SET_MULTIPLE_GLOBAL_CONFIG_PATHS: "setMultipleGlobalConfigPaths";
     CREATE_SINGLE_FIELD: "createSingleField";
     UPDATE_SINGLE_FIELD_CONFIG: "updateSingleFieldConfig";
+    UPDATE_SINGLE_FIELD_DESCRIPTION: "updateSingleFieldDescription";
     CREATE_SINGLE_TABLE: "createSingleTable";
     UPDATE_VIEW_METADATA: "updateViewMetadata";
 }>;
@@ -124,6 +125,8 @@ export interface CreateSingleFieldMutation {
     readonly name: string;
     /** The configuration for the Field being created */
     readonly config: FieldTypeConfig;
+    /** The description for the Field being created */
+    readonly description: string | null;
 }
 /** @hidden */
 export interface PartialCreateSingleFieldMutation {
@@ -132,9 +135,10 @@ export interface PartialCreateSingleFieldMutation {
     readonly id: FieldId | undefined;
     readonly name: string | undefined;
     readonly config: FieldTypeConfig | undefined;
+    readonly description: string | null | undefined;
 }
 /**
- * The Mutation emitted when the App modifies a {@link Field}.
+ * The Mutation emitted when the App modifies the options of a {@link Field}.
  *
  * @docsPath testing/mutations/UpdateSingleFieldConfigMutation
  */
@@ -147,6 +151,8 @@ export interface UpdateSingleFieldConfigMutation {
     readonly id: FieldId;
     /** The new configuration for the Field being modified */
     readonly config: FieldTypeConfig;
+    /** Optional options to affect the behavior of the update */
+    readonly opts?: UpdateFieldOptionsOpts;
 }
 /** @hidden */
 export interface PartialUpdateSingleFieldConfigMutation {
@@ -154,6 +160,41 @@ export interface PartialUpdateSingleFieldConfigMutation {
     readonly tableId: TableId | undefined;
     readonly id: FieldId | undefined;
     readonly config: FieldTypeConfig | undefined;
+    readonly opts?: UpdateFieldOptionsOpts | undefined;
+}
+/**
+ * The Mutation emitted when the App modifies the description of a {@link Field}.
+ *
+ * @docsPath testing/mutations/UpdateSingleFieldDescriptionMutation
+ */
+export interface UpdateSingleFieldDescriptionMutation {
+    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
+    readonly type: typeof MutationTypes.UPDATE_SINGLE_FIELD_DESCRIPTION;
+    /** The identifier for the Table in which a Field is being modified */
+    readonly tableId: TableId;
+    /** The identifier for the Field being modified */
+    readonly id: FieldId;
+    /** The new description for the Field being created */
+    readonly description: string | null;
+}
+/** @hidden */
+export interface PartialUpdateSingleFieldDescriptionMutation {
+    readonly type: typeof MutationTypes.UPDATE_SINGLE_FIELD_DESCRIPTION;
+    readonly tableId: TableId | undefined;
+    readonly id: FieldId | undefined;
+    readonly description: string | null | undefined;
+}
+/**
+ * Options that affect the behavior of an `UpdateSingleFieldConfigMutation`
+ */
+export interface UpdateFieldOptionsOpts {
+    /**
+     * Allowing select field choices to be deleted  is dangerous since any
+     * records which use that choice will lose their cell value. By default,
+     * calling `updateOptionsAsync` on a select field only allows choices to be
+     *  added or modified. Passing this option will allow choices to be deleted.
+     */
+    enableSelectFieldChoiceDeletion?: boolean;
 }
 /**
  * The Mutation emitted when the App creates a {@link Table}
@@ -171,6 +212,7 @@ export interface CreateSingleTableMutation {
     readonly fields: ReadonlyArray<{
         name: string;
         config: FieldTypeConfig;
+        description: string | null;
     }>;
 }
 /** @hidden */
@@ -181,6 +223,7 @@ export interface PartialCreateSingleTableMutation {
     readonly fields: ReadonlyArray<{
         name: string | undefined;
         config: FieldTypeConfig | undefined;
+        description: string | null | undefined;
     }> | undefined;
 }
 /**
@@ -206,9 +249,9 @@ export interface PartialUpdateViewMetadataMutation {
     readonly metadata: NormalizedViewMetadata | undefined;
 }
 /** @hidden */
-export declare type Mutation = SetMultipleRecordsCellValuesMutation | DeleteMultipleRecordsMutation | CreateMultipleRecordsMutation | SetMultipleGlobalConfigPathsMutation | CreateSingleFieldMutation | UpdateSingleFieldConfigMutation | CreateSingleTableMutation | UpdateViewMetadataMutation;
+export declare type Mutation = SetMultipleRecordsCellValuesMutation | DeleteMultipleRecordsMutation | CreateMultipleRecordsMutation | SetMultipleGlobalConfigPathsMutation | CreateSingleFieldMutation | UpdateSingleFieldConfigMutation | UpdateSingleFieldDescriptionMutation | CreateSingleTableMutation | UpdateViewMetadataMutation;
 /** @hidden */
-export declare type PartialMutation = PartialSetMultipleRecordsCellValuesMutation | PartialDeleteMultipleRecordsMutation | PartialCreateMultipleRecordsMutation | PartialSetMultipleGlobalConfigPathsMutation | PartialCreateSingleFieldMutation | PartialUpdateSingleFieldConfigMutation | PartialCreateSingleTableMutation | PartialUpdateViewMetadataMutation;
+export declare type PartialMutation = PartialSetMultipleRecordsCellValuesMutation | PartialDeleteMultipleRecordsMutation | PartialCreateMultipleRecordsMutation | PartialSetMultipleGlobalConfigPathsMutation | PartialCreateSingleFieldMutation | PartialUpdateSingleFieldConfigMutation | PartialUpdateSingleFieldDescriptionMutation | PartialCreateSingleTableMutation | PartialUpdateViewMetadataMutation;
 /** */
 export interface SuccessfulPermissionCheckResult {
     /** */