@airtable/blocks 0.0.0-experimental-20e3506bd-20250428

package/dist/types/src/base/models/table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/table.ts"],"names":[],"mappings":"AAAA,6CAA6C,CAAC,MAAM;AACpD,OAAO,EAAC,SAAS,EAAyB,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AAEvC,OAAO,EAGH,SAAS,EAGT,YAAY,EACf,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAC,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAEjE,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAC,qBAAqB,EAAC,MAAM,mCAAmC,CAAC;AAGxE,OAA0B,EAAC,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAC/E,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,sBAAsB,MAAM,8BAA8B,CAAC;AAClE,OAAO,IAAI,MAAM,QAAQ,CAAC;AAG1B,OAAO,MAAM,MAAM,UAAU,CAAC;AAI9B,eAAO,MAAM,kBAAkB;;;;;EAG7B,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,cAAM,KAAM,SAAQ,SAAS,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAyBzD;;;;;;;;OAQG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAmBD;;;;;;;;OAQG;IACH,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,CAQvB;IACD;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAehD;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAOjC;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAQpD;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAOrC;;;;;;;;;OASG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI;IAG3D;;;;;;;;;;OAUG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAO5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,qBAAqB,GAAG,sBAAsB;IAQnE;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CAAC,IAAI,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKvF;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CACd,gBAAgB,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,QAAQ,EAC5C,qBAAqB,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,GAC7C,IAAI,GAAG,IAAI;IAwDd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,8BAA8B,CAC1B,IAAI,CAAC,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,EAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAC5B,qBAAqB;IAmBxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,0BAA0B,CACtB,IAAI,CAAC,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,EAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAC5B,OAAO;IAIV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACG,gBAAgB,CAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,EACf,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,EAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAC5B,OAAO,CAAC,KAAK,CAAC;IAwBjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACG,iBAAiB,CACnB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,MAAM,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC;IAWhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,+BAA+B,CAC3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,EACpC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GACrD,qBAAqB;IAaxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,2BAA2B,CACvB,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,EACpC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GACrD,OAAO;IAGV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACG,kBAAkB,CACpB,OAAO,EAAE,aAAa,CAAC;QACnB,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;KACzD,CAAC,GACH,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,gCAAgC,CAC5B,OAAO,CAAC,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACxE,CAAC,GACH,qBAAqB;IAcxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,4BAA4B,CACxB,OAAO,CAAC,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACxE,CAAC,GACH,OAAO;IAGV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAG3E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,qBAAqB;IAK5F;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO;IAG1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,kBAAkB,CAAC,kBAAkB,EAAE,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAW7F;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,gCAAgC,CAC5B,kBAAkB,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,GACtD,qBAAqB;IAWxB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,4BAA4B,CAAC,kBAAkB,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,GAAG,OAAO;IAI5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACG,iBAAiB,CAAC,MAAM,GAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAK7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,+BAA+B,CAC3B,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GACrD,qBAAqB;IAOxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,2BAA2B,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,OAAO;IAG1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACG,kBAAkB,CACpB,OAAO,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,CAAC,CAAA;KAAC,CAAC,GACvE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IA0B3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,gCAAgC,CAC5B,OAAO,CAAC,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACxE,CAAC,GACH,qBAAqB;IAcxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,4BAA4B,CACxB,OAAO,CAAC,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACxE,CAAC,GACH,OAAO;CAsCb;AAED,eAAe,KAAK,CAAC"}

package/dist/types/src/base/models/table_or_view_query_result.d.ts

@@ -0,0 +1,61 @@
+import { FlowAnyObject, FlowAnyFunction } from '../../shared/private_utils';
+import { NormalizedGroupLevel } from '../types/airtable_interface';
+import RecordQueryResult, { WatchableRecordQueryResultKey } from './record_query_result';
+import Field from './field';
+import GroupedRecordQueryResult from './grouped_record_query_result';
+import { GroupLevels } from './view_metadata_query_result';
+/** @hidden */
+interface TableOrViewQueryResultData {
+    recordIds: Array<string> | null;
+    groups: Array<GroupedRecordQueryResult> | null;
+    groupLevels: Array<NormalizedGroupLevel> | null;
+}
+/**
+ * Represents a set of records directly from a view or table. See {@link RecordQueryResult} for main
+ * documentation.
+ *
+ * Do not instantiate. You can get instances of this class by calling
+ * `table.selectRecords` or `view.selectRecords`.
+ *
+ * @docsPath models/query results/TableOrViewQueryResult
+ */
+declare class TableOrViewQueryResult extends RecordQueryResult<TableOrViewQueryResultData> {
+    /**
+     * The record IDs in this RecordQueryResult.
+     * Throws if data is not loaded yet.
+     * Can be watched.
+     */
+    get recordIds(): Array<string>;
+    /**
+     * The ordered GroupedRecordQueryResult's in this RecordQueryResult.
+     * Throws if data is not loaded yet.
+     * Can be watched.
+     *
+     * @hidden
+     */
+    get groups(): Array<GroupedRecordQueryResult> | null;
+    /**
+     * The GroupLevels in this RecordQueryResult.
+     * Throws if data is not loaded yet.
+     * Can be watched.
+     *
+     * @hidden
+     */
+    get groupLevels(): GroupLevels | null;
+    /**
+     * The fields that were used to create this RecordQueryResult.
+     * Null if fields were not specified, which means the RecordQueryResult
+     * will load all fields in the table.
+     */
+    get fields(): Array<Field> | null;
+    /** @inheritdoc */
+    watch(keys: WatchableRecordQueryResultKey | ReadonlyArray<WatchableRecordQueryResultKey>, callback: FlowAnyFunction, context?: FlowAnyObject | null): Array<WatchableRecordQueryResultKey>;
+    /** @inheritdoc */
+    unwatch(keys: WatchableRecordQueryResultKey | ReadonlyArray<WatchableRecordQueryResultKey>, callback: FlowAnyFunction, context?: FlowAnyObject | null): Array<WatchableRecordQueryResultKey>;
+    /** @inheritdoc */
+    loadDataAsync(): Promise<void>;
+    /** @inheritdoc */
+    unloadData(): void;
+}
+export default TableOrViewQueryResult;
+//# sourceMappingURL=table_or_view_query_result.d.ts.map

package/dist/types/src/base/models/table_or_view_query_result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table_or_view_query_result.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/table_or_view_query_result.ts"],"names":[],"mappings":"AAGA,OAAO,EAGH,aAAa,EAEb,eAAe,EAElB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAU,oBAAoB,EAAC,MAAM,6BAA6B,CAAC;AAI1E,OAAO,iBAAiB,EAAE,EACtB,6BAA6B,EAGhC,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,MAAM,SAAS,CAAC;AAK5B,OAAO,wBAAwB,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAEzD,cAAc;AACd,UAAU,0BAA0B;IAChC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAChC,MAAM,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;IAC/C,WAAW,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;CACnD;AAED;;;;;;;;GAQG;AACH,cAAM,sBAAuB,SAAQ,iBAAiB,CAAC,0BAA0B,CAAC;IA4J9E;;;;OAIG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,CAO7B;IACD;;;;;;OAMG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAMnD;IACD;;;;;;OAMG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,IAAI,CASpC;IAkBD;;;;OAIG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAkBhC;IAqED,kBAAkB;IAClB,KAAK,CACD,IAAI,EAAE,6BAA6B,GAAG,aAAa,CAAC,6BAA6B,CAAC,EAClF,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI,GAC/B,KAAK,CAAC,6BAA6B,CAAC;IA0CvC,kBAAkB;IAClB,OAAO,CACH,IAAI,EAAE,6BAA6B,GAAG,aAAa,CAAC,6BAA6B,CAAC,EAClF,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI,GAC/B,KAAK,CAAC,6BAA6B,CAAC;IA8BvC,kBAAkB;IACZ,aAAa;IAyHnB,kBAAkB;IAClB,UAAU;CAqZb;AAED,eAAe,sBAAsB,CAAC"}

package/dist/types/src/base/models/view.d.ts

@@ -0,0 +1,203 @@
+import { ViewData, ViewType } from '../types/view';
+import { ObjectValues } from '../../shared/private_utils';
+import AbstractModel from '../../shared/models/abstract_model';
+import { PermissionCheckResult } from '../../shared/types/mutations_core';
+import { BaseSdkMode } from '../../sdk_mode';
+import { RecordQueryResultOpts, ViewMetadataForUpdate } from './record_query_result';
+import TableOrViewQueryResult from './table_or_view_query_result';
+import ViewMetadataQueryResult from './view_metadata_query_result';
+declare const WatchableViewKeys: Readonly<{
+    name: "name";
+    isLockedView: "isLockedView";
+}>;
+/**
+ * A key in {@link View} that can be watched.
+ * - `name`
+ */
+export type WatchableViewKey = ObjectValues<typeof WatchableViewKeys>;
+/**
+ * A class that represents an Airtable view. Every {@link Table} has one or more views.
+ *
+ * @docsPath models/View
+ */
+declare class View extends AbstractModel<BaseSdkMode, ViewData, WatchableViewKey> {
+    /**
+     * The name of the view. Can be watched.
+     *
+     * @example
+     * ```js
+     * console.log(myView.name);
+     * // => 'Grid view'
+     * ```
+     */
+    get name(): string;
+    /**
+     * The type of the view, such as Grid, Calendar, or Kanban. Should never change because view types cannot be modified.
+     *
+     * @example
+     * ```js
+     * console.log(myView.type);
+     * // => 'kanban'
+     * ```
+     */
+    get type(): ViewType;
+    /**
+     * If the view is locked. Can be watched.
+     *
+     * @example
+     * ```js
+     * console.log(myView.isLockedView);
+     * // => false
+     * ```
+     */
+    get isLockedView(): boolean;
+    /**
+     * The URL for the view. You can visit this URL in the browser to be taken to the view in the Airtable UI.
+     *
+     * @example
+     * ```js
+     * console.log(myView.url);
+     * // => 'https://airtable.com/appxxxxxxxxxxxxxx/tblxxxxxxxxxxxxxx/viwxxxxxxxxxxxxxx'
+     * ```
+     */
+    get url(): string;
+    /**
+     * Select records from the view. Returns a {@link RecordQueryResult}.
+     *
+     * Consider using {@link useRecords} or {@link useRecordIds} instead, unless you need the
+     * features of a QueryResult (e.g. `queryResult.getRecordById`). Record hooks handle
+     * loading/unloading and updating your UI automatically, but manually `select`ing records is
+     * useful for one-off data processing.
+     *
+     * @param opts Options for the query, such as sorts, fields, and record coloring. By
+     * default, records will be coloured according to the view.
+     * @example
+     * ```js
+     * import {useBase, useRecords} from '@airtable/blocks/UI';
+     * import React from 'react';
+     *
+     * function TodoList() {
+     *     const base = useBase();
+     *     const table = base.getTableByName('Tasks');
+     *     const view = table.getViewByName('Grid view');
+     *
+     *     const queryResult = view.selectRecords();
+     *     const records = useRecords(queryResult);
+     *
+     *     return (
+     *         <ul>
+     *             {records.map(record => (
+     *                 <li key={record.id}>
+     *                     {record.name || 'Unnamed record'}
+     *                 </li>
+     *             ))}
+     *         </ul>
+     *     );
+     * }
+     * ```
+     */
+    selectRecords(opts?: RecordQueryResultOpts): TableOrViewQueryResult;
+    /**
+     * Select and load records from the view. Returns a {@link RecordQueryResult} promise where
+     * record data has been loaded.
+     *
+     * Consider using {@link useRecords} or {@link useRecordIds} instead, unless you need the
+     * features of a QueryResult (e.g. `queryResult.getRecordById`). Record hooks handle
+     * loading/unloading and updating your UI automatically, but manually `select`ing records is
+     * useful for one-off data processing.
+     *
+     * Once you've finished with your query, remember to call `queryResult.unloadData()`.
+     *
+     * @param opts Options for the query, such as sorts, fields, and record coloring. By
+     * default, records will be coloured according to the view.
+     * @example
+     * ```js
+     * async function getRecordCountAsync(view) {
+     *     const query = await view.selectRecordsAsync();
+     *     const recordCount = query.recordIds.length;
+     *     query.unloadData();
+     *     return recordCount;
+     * }
+     * ```
+     */
+    selectRecordsAsync(opts?: RecordQueryResultOpts): Promise<TableOrViewQueryResult>;
+    /**
+     * Select the field order and visible fields from the view. Returns a
+     * {@link ViewMetadataQueryResult}.
+     *
+     * Consider using {@link useViewMetadata} instead if you're creating a React UI. The
+     * {@link useViewMetadata} hook handles loading/unloading and updating your UI automatically,
+     * but manually `select`ing data is useful for one-off data processing.
+     *
+     * @example
+     * ```js
+     * async function loadMetadataForViewAsync(view) {
+     *     const viewMetadata = view.selectMetadata();
+     *     await viewMetadata.loadDataAsync();
+     *
+     *     console.log('Visible fields:');
+     *     console.log(viewMetadata.visibleFields.map(field => field.name));
+     *     // => ['Field 1', 'Field 2', 'Field 3']
+     *
+     *     console.log('All fields:');
+     *     console.log(viewMetadata.allFields.map(field => field.name));
+     *     // => ['Field 1', 'Field 2', 'Field 3', 'Hidden field 4']
+     *
+     *     viewMetadata.unloadData();
+     * }
+     * ```
+     */
+    selectMetadata(): ViewMetadataQueryResult;
+    /**
+     * Select and load the field order and visible fields from the view. Returns a
+     * {@link ViewMetadataQueryResult} promise where the metadata has already been loaded.
+     *
+     * Consider using {@link useViewMetadata} instead if you're creating a React UI. The
+     * {@link useViewMetadata} hook handles loading/unloading and updating your UI automatically,
+     * but manually `select`ing data is useful for one-off data processing.
+     *
+     * @example
+     * ```js
+     * async function loadMetadataForViewAsync(view) {
+     *     const viewMetadata = await view.selectMetadata();
+     *
+     *     console.log('Visible fields:');
+     *     console.log(viewMetadata.visibleFields.map(field => field.name));
+     *     // => ['Field 1', 'Field 2', 'Field 3']
+     *
+     *     console.log('All fields:');
+     *     console.log(viewMetadata.allFields.map(field => field.name));
+     *     // => ['Field 1', 'Field 2', 'Field 3', 'Hidden field 4']
+     *
+     *     viewMetadata.unloadData();
+     * }
+     * ```
+     */
+    selectMetadataAsync(): Promise<ViewMetadataQueryResult>;
+    /**
+     * Checks whether the current user has permission to update view metadata.
+     *
+     * @param viewMetadata
+     * @hidden
+     */
+    checkPermissionsForUpdateMetadata(viewMetadata: ViewMetadataForUpdate): PermissionCheckResult;
+    /**
+     * An alias for `checkPermissionsForUpdateMetadata(viewMetadata).hasPermission`.
+     *
+     * Checks whether the current user has permission to update view metadata.
+     *
+     * @param viewMetadata
+     * @hidden
+     */
+    hasPermissionToUpdateMetadata(viewMetadata: ViewMetadataForUpdate): boolean;
+    /**
+     * Updates view metadata, this is currently only supported from block views
+     * altering their own view's grouping config.
+     *
+     * @param ViewMetadataForUpdate
+     * @hidden
+     */
+    updateMetadataAsync(viewMetadata: ViewMetadataForUpdate): Promise<void>;
+}
+export default View;
+//# sourceMappingURL=view.d.ts.map

package/dist/types/src/base/models/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/view.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACjD,OAAO,EAAc,YAAY,EAAgB,MAAM,4BAA4B,CAAC;AAEpF,OAAO,aAAa,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAAC,qBAAqB,EAAC,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAG3C,OAA0B,EAEtB,qBAAqB,EACrB,qBAAqB,EACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,sBAAsB,MAAM,8BAA8B,CAAC;AAElE,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AAKnE,QAAA,MAAM,iBAAiB;;;EAGrB,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,cAAM,IAAK,SAAQ,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,gBAAgB,CAAC;IAiDrE;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IACD;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,QAAQ,CAEnB;IACD;;;;;;;;OAQG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IACD;;;;;;;;OAQG;IACH,IAAI,GAAG,IAAI,MAAM,CAKhB;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,aAAa,CAAC,IAAI,GAAE,qBAA0B,GAAG,sBAAsB;IAmBvE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,kBAAkB,CAAC,IAAI,GAAE,qBAA0B,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAK3F;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAAc,IAAI,uBAAuB;IAOzC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,mBAAmB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAM7D;;;;;OAKG;IACH,iCAAiC,CAAC,YAAY,EAAE,qBAAqB,GAAG,qBAAqB;IAY7F;;;;;;;OAOG;IACH,6BAA6B,CAAC,YAAY,EAAE,qBAAqB,GAAG,OAAO;IAI3E;;;;;;OAMG;IACG,mBAAmB,CAAC,YAAY,EAAE,qBAAqB;CA4BhE;AAED,eAAe,IAAI,CAAC"}

package/dist/types/src/base/models/view_data_store.d.ts

@@ -0,0 +1,10 @@
+export declare const WatchableViewDataStoreKeys: Readonly<{
+    visibleRecords: "visibleRecords";
+    visibleRecordIds: "visibleRecordIds";
+    groups: "groups";
+    groupLevels: "groupLevels";
+    recordColors: "recordColors";
+    allFieldIds: "allFieldIds";
+    visibleFieldIds: "visibleFieldIds";
+}>;
+//# sourceMappingURL=view_data_store.d.ts.map

package/dist/types/src/base/models/view_data_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view_data_store.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/view_data_store.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,0BAA0B;;;;;;;;EAQrC,CAAC"}

package/dist/types/src/base/models/view_metadata_query_result.d.ts

@@ -0,0 +1,79 @@
+import { FieldId } from '../../shared/types/hyper_ids';
+import { NormalizedGroupLevel } from '../types/airtable_interface';
+import { ObjectValues } from '../../shared/private_utils';
+import AbstractModelWithAsyncData from './abstract_model_with_async_data';
+import View from './view';
+import Field from './field';
+declare const WatchableViewMetadataKeys: {
+    allFields: "allFields";
+    visibleFields: "visibleFields";
+    isDataLoaded: "isDataLoaded";
+    groupLevels: "groupLevels";
+};
+/**
+ * A key in {@link ViewMetadataQueryResult} that can be watched.
+ * - `allFields`
+ * - `visibleFields`
+ * - `isDataLoaded`
+ */
+type WatchableViewMetadataKey = ObjectValues<typeof WatchableViewMetadataKeys>;
+/** @hidden */
+interface ViewMetadata {
+    visibleFieldIds: Array<FieldId> | null;
+    allFieldIds: Array<FieldId> | null;
+    groupLevels: Array<NormalizedGroupLevel> | null;
+}
+/**
+ * @hidden
+ */
+interface GroupLevel {
+    field: Field;
+    fieldId: FieldId;
+    direction: 'asc' | 'desc';
+}
+/**
+ * @hidden
+ */
+export type GroupLevels = Array<GroupLevel>;
+/**
+ * Contains information about a view that isn't loaded by default e.g. field order and visible fields.
+ *
+ * In a React component, we recommend using {@link useViewMetadata} instead.
+ *
+ * @example
+ * ```js
+ * async function loadMetadataForViewAsync(view) {
+ *     const viewMetadata = view.selectMetadata();
+ *     await viewMetadata.loadDataAsync();
+ *
+ *     console.log(viewMetadata.visibleFields);
+ *     // => [Field, Field, Field]
+ *
+ *     console.log(viewMetadata.allFields);
+ *     // => [Field, Field, Field, Field, Field]
+ *
+ *     viewMetadata.unloadData();
+ * }
+ * ```
+ * @docsPath models/query results/ViewMetadataQueryResult
+ */
+declare class ViewMetadataQueryResult extends AbstractModelWithAsyncData<ViewMetadata, WatchableViewMetadataKey> {
+    /** */
+    readonly parentView: View;
+    /**
+     * Returns every field in the table in the order they appear in this view. Watchable.
+     */
+    get allFields(): Array<Field>;
+    /**
+     * Returns every field visible in this view. Watchable.
+     */
+    get visibleFields(): Array<Field>;
+    /**
+     * Returns group levels for this view. Watchable.
+     *
+     * @hidden
+     */
+    get groupLevels(): GroupLevels | null;
+}
+export default ViewMetadataQueryResult;
+//# sourceMappingURL=view_metadata_query_result.d.ts.map

package/dist/types/src/base/models/view_metadata_query_result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view_metadata_query_result.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/view_metadata_query_result.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,OAAO,EAAC,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAC,oBAAoB,EAAC,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAkC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AACzF,OAAO,0BAA0B,MAAM,kCAAkC,CAAC;AAE1E,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,QAAA,MAAM,yBAAyB;;;;;CAK9B,CAAC;AAEF;;;;;GAKG;AACH,KAAK,wBAAwB,GAAG,YAAY,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE/E,cAAc;AACd,UAAU,YAAY;IAClB,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACnC,WAAW,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;CACnD;AAED;;GAEG;AACH,UAAU,UAAU;IAChB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAM,uBAAwB,SAAQ,0BAA0B,CAC5D,YAAY,EACZ,wBAAwB,CAC3B;IAkBG,MAAM;IACN,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IA8E1B;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAI5B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,CAIhC;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,IAAI,CAQpC;CACJ;AAED,eAAe,uBAAuB,CAAC"}

package/dist/types/src/base/perform_record_action.d.ts

@@ -0,0 +1,72 @@
+import { RecordActionDataCallback } from './types/record_action_data';
+import Sdk from './sdk';
+/** @hidden */
+export declare const WatchablePerformRecordActionKeys: Readonly<{
+    isDataLoaded: "isDataLoaded";
+    recordActionData: "recordActionData";
+}>;
+/**
+ * Returned by {@link registerRecordActionDataCallback}. Call it to unregister the previously
+ * registered function. Do this before registering another function or unmounting the component.
+ * */
+type UnsubscribeFunction = () => void;
+/**
+ * Registers a callback to handle "open block" / "perform record action" events (from button field).
+ *
+ * Returns a unsubscribe function that should be used to unregister the callback for cleanup on
+ * component unmount, or if you wish to register a different function.
+ *
+ * Also see {@link useRecordActionData}, which subscribes to the same events in a synchronous way.
+ *
+ * Your block will not receive "perform record action" events until a callback is registered -
+ * they're held until registration to ensure the block is ready to handle the event (e.g. has
+ * finished loading).
+ *
+ * Because of this, we recommend only registering a callback once, in your top level component -
+ * otherwise, messages could be received while not all callbacks have been successfully registered.
+ * Similarly, using both `registerRecordActionDataCallback` and `useRecordActionData` is not
+ * supported.
+ *
+ * You can test your block in development by sending "perform record action" events to your block
+ * in the "Advanced" panel of the block developer tools.
+ *
+ * After releasing your block, you can use it with a button field by choosing the "Open custom
+ * block" action and selecting your block.
+ *
+ * @example
+ * ```js
+ * import React, {useEffect, useState} from 'react';
+ * import {registerRecordActionDataCallback} from '@airtable/blocks/ui';
+ *
+ * function LatestRecordAction() {
+ *     const [recordActionData, setRecordActionData] = useState(null);
+ *
+ *     const callback = (data) => {
+ *         console.log('Record action received', data);
+ *         setRecordActionData(data);
+ *     }
+ *
+ *     useEffect(() => {
+ *         // Return the unsubscribe function so it's run on cleanup.
+ *         return registerRecordActionDataCallback(callback);
+ *     }, [callback]);
+ *
+ *     if (recordActionData === null) {
+ *         return <span>No events yet</span>;
+ *     }
+ *
+ *     return (
+ *         <ul>
+ *             <li>Record id: {recordActionData.recordId}</li>
+ *             <li>View id: {recordActionData.viewId}</li>
+ *             <li>Table id: {recordActionData.tableId}</li>
+ *         </ul>
+ *     );
+ * }
+ * ```
+ *
+ */
+export declare function registerRecordActionDataCallback(callback: RecordActionDataCallback): UnsubscribeFunction;
+export declare function __injectSdkIntoPerformRecordAction(_sdk: Sdk): void;
+export {};
+//# sourceMappingURL=perform_record_action.d.ts.map

package/dist/types/src/base/perform_record_action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perform_record_action.d.ts","sourceRoot":"","sources":["../../../../src/base/perform_record_action.ts"],"names":[],"mappings":"AAGA,OAAO,EAAmB,wBAAwB,EAAC,MAAM,4BAA4B,CAAC;AAEtF,OAAO,GAAG,MAAM,OAAO,CAAC;AAExB,cAAc;AACd,eAAO,MAAM,gCAAgC;;;EAI3C,CAAC;AAKH;;;KAGK;AACL,KAAK,mBAAmB,GAAG,MAAM,IAAI,CAAC;AAiItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,wBAAgB,gCAAgC,CAC5C,QAAQ,EAAE,wBAAwB,GACnC,mBAAmB,CAiBrB;AAMD,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,GAAG,QAE3D"}

package/dist/types/src/base/sdk.d.ts

@@ -0,0 +1,35 @@
+/** @hidden */ /** */
+import { BlockSdkCore } from '../shared/sdk_core';
+import { BaseSdkMode } from '../sdk_mode';
+import Viewport from './viewport';
+import Cursor from './models/cursor';
+import SettingsButton from './settings_button';
+import UndoRedo from './undo_redo';
+import { AirtableInterface, BlockRunContext } from './types/airtable_interface';
+import { RequestJson, ResponseJson } from './types/backend_fetch_types';
+/**
+ * We document this manually.
+ *
+ * @hidden
+ */
+export default class BaseBlockSdk extends BlockSdkCore<BaseSdkMode> {
+    /** Controls the block's viewport. You can fullscreen the block and add size
+     * constrains using `viewport`.
+     */
+    viewport: Viewport;
+    /** Returns information about the active table, active view, and selected records. */
+    cursor: Cursor;
+    /**
+     * Controls the block's {@link settingsButton settings button}.
+     */
+    settingsButton: SettingsButton;
+    /** @hidden */
+    undoRedo: UndoRedo;
+    /** @hidden */
+    constructor(airtableInterface: AirtableInterface);
+    /** @hidden */
+    unstable_fetchAsync(requestJson: RequestJson): Promise<ResponseJson>;
+    /** @hidden */
+    getBlockRunContext(): BlockRunContext;
+}
+//# sourceMappingURL=sdk.d.ts.map

package/dist/types/src/base/sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../../src/base/sdk.ts"],"names":[],"mappings":"AAAA,cAAc,CAAC,MAAM;AAarB,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,QAAQ,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,6BAA6B,CAAC;AActE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY,CAAC,WAAW,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B,cAAc;IACd,QAAQ,EAAE,QAAQ,CAAC;IAoBnB,cAAc;gBACF,iBAAiB,EAAE,iBAAiB;IAsGhD,cAAc;IACR,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAI1E,cAAc;IACd,kBAAkB,IAAI,eAAe;CAGxC"}

package/dist/types/src/base/settings_button.d.ts

@@ -0,0 +1,66 @@
+/** @module @airtable/blocks: settingsButton */ /** */
+import Watchable from '../shared/watchable';
+import { ObjectValues } from '../shared/private_utils';
+declare const WatchableSettingsButtonKeys: Readonly<{
+    isVisible: "isVisible";
+    click: "click";
+}>;
+/**
+ * A watchable key in {@link SettingsButton}.
+ * - `isVisible`
+ * - `click`
+ */
+type WatchableSettingsButtonKey = ObjectValues<typeof WatchableSettingsButtonKeys>;
+/**
+ * Interface to the settings button that lives outside the extension's viewport.
+ *
+ * The {@link useSettingsButton} hook is the recommended way to use the settings button, but you can
+ * also use it with {@link useWatchable} if you want more granular control (for example, to only
+ * show the button conditionally).
+ *
+ * @alias settingsButton
+ * @example
+ * ```js
+ * import {settingsButton} from '@airtable/blocks';
+ * import {useWatchable} from '@airtable/blocks/ui';
+ *
+ * function AppWithSettings({shouldShowSettingsButton}) {
+ *     useEffect(() => {
+ *         // A count of calls to `show()` and `hide()` is maintained internally. The button will
+ *         // stay visible if there are more calls to `show()` than `hide()` - so here, we check
+ *         // `isVisible` so we only we only call them when necessary.
+ *         // The button is not visible by default.
+ *         if (shouldShowSettingsButton && !settingsButton.isVisible) {
+ *             settingsButton.show();
+ *         } else if (!shouldShowSettingsButton && settingsButton.isVisible) {
+ *             settingsButton.hide();
+ *         }
+ *     });
+ *
+ *     useWatchable(settingsButton, 'click', function() {
+ *         alert('Clicked!');
+ *     });
+ * }
+ * ```
+ * @docsPath models/SettingsButton
+ */
+declare class SettingsButton extends Watchable<WatchableSettingsButtonKey> {
+    /**
+     * Whether the settings button is being shown.
+     * Can be watched.
+     */
+    get isVisible(): boolean;
+    /**
+     * Show the settings button.
+     */
+    show(): void;
+    /**
+     * Hide the settings button.
+     *
+     * Note: A count of calls to `show()` and `hide()` is maintained internally. The button will
+     * stay visible if there are more calls to `show()` than `hide()`.
+     */
+    hide(): void;
+}
+export default SettingsButton;
+//# sourceMappingURL=settings_button.d.ts.map

package/dist/types/src/base/settings_button.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings_button.d.ts","sourceRoot":"","sources":["../../../../src/base/settings_button.ts"],"names":[],"mappings":"AAAA,+CAA+C,CAAC,MAAM;AACtD,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAc,YAAY,EAAC,MAAM,yBAAyB,CAAC;AAGlE,QAAA,MAAM,2BAA2B;;;EAG/B,CAAC;AAEH;;;;GAIG;AACH,KAAK,0BAA0B,GAAG,YAAY,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,cAAM,cAAe,SAAQ,SAAS,CAAC,0BAA0B,CAAC;IAmB9D;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI;IAUJ;;;;;OAKG;IACH,IAAI;CAiBP;AAED,eAAe,cAAc,CAAC"}

package/dist/types/src/base/types/aggregators.d.ts

@@ -0,0 +1,4 @@
+/** @module @airtable/blocks/models: Aggregators */ /** */
+/** */
+export type AggregatorKey = string;
+//# sourceMappingURL=aggregators.d.ts.map

package/dist/types/src/base/types/aggregators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregators.d.ts","sourceRoot":"","sources":["../../../../../src/base/types/aggregators.ts"],"names":[],"mappings":"AAAA,mDAAmD,CAAC,MAAM;AAE1D,MAAM;AACN,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}