@airtable/blocks 1.11.1-experimental-68738f2-20220526 → 1.13.0

package/README.md

@@ -1,7 +1,7 @@
 # @airtable/blocks
 
-With the Blocks SDK, you can create your own custom apps on top of Airtable. These apps can be
-integrations, visualizations, internal tools, and more!
+With the Blocks SDK, you can create your own custom extensions on top of Airtable. These extensions
+can be integrations, visualizations, internal tools, and more!
 
 To get started, check out the
 [official Blocks SDK documentation website](https://airtable.com/developers/blocks). If you have any

package/dist/cjs/error_utils.js

@@ -9,7 +9,6 @@ exports.spawnError = spawnError;
 exports.logErrorToSentry = logErrorToSentry;
 exports.invariant = invariant;
 exports.spawnUnknownSwitchCaseError = spawnUnknownSwitchCaseError;
-exports.spawnExhaustiveSwitchError = spawnExhaustiveSwitchError;
 exports.spawnAbstractMethodError = spawnAbstractMethodError;
 
 // If errorOriginFn is specified, all frames above and including the call to errorOriginFn
@@ -57,8 +56,7 @@ function spawnError(errorMessageFormat) {
 } // istanbul ignore next
 
 /**
- * Logs an error to Sentry. This is currently unused while the SDK is in the experimental status,
- * but we leave the definition here for future usage needs.
+ * Logs an error to Sentry
  *
  * @hidden
  */
@@ -98,22 +96,6 @@ function spawnUnknownSwitchCaseError(valueDescription, providedValue, key) {
   var providedValueKeyString = providedValueKey !== null && providedValueKey !== undefined ? providedValueKey : 'null';
   return spawnErrorWithOriginOmittedFromStackTrace('Unknown value %s for %s', [providedValueKeyString, valueDescription], spawnUnknownSwitchCaseError);
 }
-/**
- * Forces TypeScript to prove that calling this function is impossible at a
- * type level by accepting `never`. In the unlikely case this function is
- * called we infer a useful error message.
- *
- * @internal
- */
-
-
-function spawnExhaustiveSwitchError(impossibleValue) {
-  if (impossibleValue === null) {
-    return spawnErrorWithOriginOmittedFromStackTrace('Unexpected null in exhaustive switch', undefined, spawnExhaustiveSwitchError);
-  } else {
-    return spawnErrorWithOriginOmittedFromStackTrace("Unexpected %s in exhaustive switch", [typeof impossibleValue], spawnExhaustiveSwitchError);
-  }
-}
 /**
  * @internal
  */

package/dist/cjs/global_config.js

@@ -59,7 +59,7 @@ var _private_utils = require("./private_utils");
 //    as a name seems a bit too vague in terms of intended usage).
 
 /**
- * A key-value store for persisting configuration options for an app installation.
+ * A key-value store for persisting configuration options for an extension installation.
  *
  * The contents will be synced in real-time to all logged-in users of the installation.
  * Contents will not be updated in real-time when the installation is running in
@@ -287,7 +287,7 @@ function (_Watchable) {
      *     if (globalConfig.hasPermissionToSetPaths('favoriteColor', color)) {
      *         globalConfig.setAsync('favoriteColor', color);
      *     }
-     *     // The update is now applied within your app (eg will be
+     *     // The update is now applied within your extension (eg will be
      *     // reflected in globalConfig) but are still being saved to
      *     // Airtable servers (e.g. may not be updated for other users yet)
      * }
@@ -423,7 +423,7 @@ function (_Watchable) {
      *     if (globalConfig.hasPermissionToSetPaths(updates)) {
      *         globalConfig.setPathsAsync(updates);
      *     }
-     *     // The updates are now applied within your app (eg will be reflected in
+     *     // The updates are now applied within your extension (eg will be reflected in
      *     // globalConfig) but are still being saved to Airtable servers (e.g. they
      *     // may not be updated for other users yet)
      * }

package/dist/cjs/injected/airtable_interface.js

@@ -9,7 +9,7 @@ var _error_utils = require("../error_utils");
 
 var AIRTABLE_INTERFACE_VERSION = 0;
 var airtableInterface = null;
-var missingAirtableInterfaceErrorMessage = ['Error: App environment misconfigured', '\n\n', 'Airtable Apps can only run in the presence of an Airtable Base. If you ', 'are trying to run your App with a Base hosted on airtable.com, then be ', 'sure you are using the Airtable CLI to serve your code and accessing it ', 'through a Custom App installed inside a Base on airtable.com.', '\n\n', 'If you are trying to run automated tests for your App, then make sure ', 'you have loaded the `@airtable/testing-library` module *before* the ', '`@airtable/blocks` module.'].join('');
+var missingAirtableInterfaceErrorMessage = ['Error: Extension environment misconfigured', '\n\n', 'Airtable Extensions can only run in the presence of an Airtable Base. If you ', 'are trying to run your Extension with a Base hosted on airtable.com, then be ', 'sure you are using the Airtable CLI to serve your code and accessing it ', 'through a Custom Extension installed inside a Base on airtable.com.', '\n\n', 'If you are trying to run automated tests for your Extension, then make sure ', 'you have loaded the `@airtable/testing-library` module *before* the ', '`@airtable/blocks` module.'].join('');
 /** @hidden */
 
 function getAirtableInterface() {

package/dist/cjs/models/base.js

@@ -186,8 +186,8 @@ function (_AbstractModel) {
      * The user matching the given ID, name, or email address. Returns null if that user does not
      * exist or does not have access to this base.
      *
-     * This method is convenient when building an app for a specific base, but for more generic
-     * apps the best practice is to use the {@link getCollaboratorByIdIfExists} method instead.
+     * This method is convenient when building an extension for a specific base, but for more generic
+     * extensions the best practice is to use the {@link getCollaboratorByIdIfExists} method instead.
      *
      * @param collaboratorIdOrNameOrEmail The ID of the user.
      */
@@ -254,8 +254,8 @@ function (_AbstractModel) {
      * or does not have access to this base. Use {@link getCollaboratorIfExists} instead if you are
      * unsure whether a collaborator with the given ID exists and has access to this base.
      *
-     * This method is convenient when building an app for a specific base, but for more generic
-     * apps the best practice is to use the {@link getCollaboratorById} method instead.
+     * This method is convenient when building an extension for a specific base, but for more generic
+     * extensions the best practice is to use the {@link getCollaboratorById} method instead.
      *
      * @param collaboratorIdOrNameOrEmail The ID of the user.
      */
@@ -397,8 +397,8 @@ function (_AbstractModel) {
      * The table matching the given ID or name. Returns `null` if no matching table exists within
      * this base.
      *
-     * This method is convenient when building an app for a specific base, but for more generic
-     * apps the best practice is to use the {@link getTableByIdIfExists} or
+     * This method is convenient when building an extension for a specific base, but for more generic
+     * extensions the best practice is to use the {@link getTableByIdIfExists} or
      * {@link getTableByNameIfExists} methods instead.
      *
      * @param tableIdOrName The ID or name of the table you're looking for.
@@ -416,8 +416,8 @@ function (_AbstractModel) {
      * Use {@link getTableIfExists} instead if you are unsure whether a table exists with the given
      * name/ID.
      *
-     * This method is convenient when building an app for a specific base, but for more generic
-     * apps the best practice is to use the {@link getTableById} or {@link getTableByName} methods
+     * This method is convenient when building an extension for a specific base, but for more generic
+     * extensions the best practice is to use the {@link getTableById} or {@link getTableByName} methods
      * instead.
      *
      * @param tableIdOrName The ID or name of the table you're looking for.
@@ -521,7 +521,7 @@ function (_AbstractModel) {
      *
      * This action is asynchronous. Unlike new records, new tables are **not** created
      * optimistically locally. You must `await` the returned promise before using the new
-     * table in your app.
+     * table in your extension.
      *
      * @param name name for the table. must be case-insensitive unique
      * @param fields array of fields to create in the table: see below for an example. `name` and

package/dist/cjs/models/cursor.js

@@ -268,7 +268,7 @@ function (_AbstractModelWithAsy) {
     key: "setActiveTable",
 
     /**
-     * Sets the specified table to active in the Airtable UI. If the app installation or apps pane
+     * Sets the specified table to active in the Airtable UI. If the extension installation or extensions pane
      * is fullscreen, fullscreen mode will be exited.
      *
      * @param tableOrTableId The target table or table ID to set as active in the Airtable main page.
@@ -279,8 +279,8 @@ function (_AbstractModelWithAsy) {
       this._sdk.__airtableInterface.setActiveViewOrTable(tableId);
     }
     /**
-     * Sets the specified view (and corresponding table) to active in the Airtable UI. If the app
-     * installation or apps pane is fullscreen, fullscreen mode will be exited.
+     * Sets the specified view (and corresponding table) to active in the Airtable UI. If the extension
+     * installation or extensions pane is fullscreen, fullscreen mode will be exited.
      *
      * @param tableOrTableId The table or table ID that the target view belongs to.
      * @param viewOrViewId The target view or view ID to set as active in the Airtable main page.

package/dist/cjs/models/field.js

@@ -225,7 +225,7 @@ function (_AbstractModel) {
      *
      * This action is asynchronous. Unlike updates to cell values, updates to field options are
      * **not** applied optimistically locally. You must `await` the returned promise before
-     * relying on the change in your app.
+     * relying on the change in your extension.
      *
      * Optionally, you can pass an `opts` object as the second argument. See {@link UpdateFieldOptionsOpts}
      * for available options.
@@ -342,7 +342,7 @@ function (_AbstractModel) {
      *
      * This action is asynchronous. Unlike updates to cell values, updates to field name are
      * **not** applied optimistically locally. You must `await` the returned promise before
-     * relying on the change in your app.
+     * relying on the change in your extension.
      *
      * @param name new name for the field
      *
@@ -440,7 +440,7 @@ function (_AbstractModel) {
      *
      * This action is asynchronous. Unlike updates to cell values, updates to field descriptions are
      * **not** applied optimistically locally. You must `await` the returned promise before
-     * relying on the change in your app.
+     * relying on the change in your extension.
      *
      * @param description new description for the field
      *

package/dist/cjs/models/grouped_record_query_result.js

@@ -245,13 +245,19 @@ function (_RecordQueryResult) {
         while (1) {
           switch (_context2.prev = _context2.next) {
             case 0:
-              // TODO: This entire class assumes it is torn down and re-created by the parent whenever
-              // a change to the group is made.
-              this._parentQueryResult.__groupedRecordQueryResultPool.registerObjectForReuseStrong(this);
+              this._parentQueryResult.__groupedRecordQueryResultPool.registerObjectForReuseStrong(this); // Ensure we invalidate our memoized computed recordIds whenever a relevant hook changes
+              // TODO: (SeanKeenan) At the moment this should never be relevant, because groups are recreated
+              // anytime the groups change - but this is how it should work once groups persist AND
+              // watching recordIds only changes if records in this group change.
+              // In the meantime this does ensure that a deleted GroupedRecordQuery with stale recordIds
+              // doesn't return the cached array.
 
+
+              this.watch(['recordIds', 'groups', 'groupLevels'], this._invalidateComputedRecordIds, this);
+              this.watch(['recordIds'], this._invalidateRecordIdsSet, this);
               return _context2.abrupt("return", this._getChangedKeysOnLoad());
 
-            case 2:
+            case 4:
             case "end":
               return _context2.stop();
           }
@@ -263,7 +269,10 @@ function (_RecordQueryResult) {
   }, {
     key: "_unloadData",
     value: function _unloadData() {
-      // Invalidate both of the caches, as this object can no longer be accessed
+      // Ensure we invalidate our memoized computed recordIds whenever a relevant hook changes
+      this.unwatch(['recordIds', 'groups', 'groupLevels'], this._invalidateComputedRecordIds, this);
+      this.unwatch(['recordIds'], this._invalidateRecordIdsSet, this); // Invalidate both of the caches, as this object can no longer be accessed
+
       this._invalidateComputedRecordIds();
 
       this._invalidateRecordIdsSet();

package/dist/cjs/models/linked_records_query_result.js

@@ -29,8 +29,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.getLinkedTableId = void 0;
 
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
 require("regenerator-runtime/runtime");
@@ -55,14 +53,8 @@ var _field = require("../types/field");
 
 var _error_utils = require("../error_utils");
 
-var _block_query_spec = require("../types/block_query_spec");
-
-var _airtable_interface = require("../types/airtable_interface");
-
 var _record_query_result = _interopRequireDefault(require("./record_query_result"));
 
-var _record_store = require("./record_store");
-
 /** @module @airtable/blocks/models: RecordQueryResult */
 
 /** */
@@ -126,8 +118,6 @@ function (_RecordQueryResult) {
 
   /** @internal */
 
-  /** @internal */
-
   /** @internal */
   function LinkedRecordsQueryResult(record, field, normalizedOpts, sdk) {
     var _this;
@@ -144,7 +134,6 @@ function (_RecordQueryResult) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "_computedRecordIdsSet", null);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "_computedFilteredSortedRecordIds", null);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "_cellValueChangeHandlerByFieldId", {});
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "_recordStoreQueryId", null);
     (0, _error_utils.invariant)(record.parentTable === field.parentTable, 'record and field must belong to the same table');
     _this._record = record;
     _this._field = field;
@@ -290,7 +279,7 @@ function (_RecordQueryResult) {
   }, {
     key: "_loadDataAsync",
     value: function _loadDataAsync() {
-      var initiallyLoaded, _ref, _ref2, recordStoreQueryId, changedKeys, fieldIds, _iteratorNormalCompletion3, _didIteratorError3, _iteratorError3, _iterator3, _step3, fieldId;
+      var initiallyLoaded, changedKeys, fieldIds, _iteratorNormalCompletion3, _didIteratorError3, _iteratorError3, _iterator3, _step3, fieldId;
 
       return _regenerator.default.async(function _loadDataAsync$(_context2) {
         while (1) {
@@ -302,21 +291,11 @@ function (_RecordQueryResult) {
 
               this._watchLinkedQueryResult();
 
-              initiallyLoaded = this._linkedQueryResult.isDataLoaded; // https://airtable.com/appahuJQw7qfQTBBU/tblSbpimM8Spp9txp/viweAFIus3MhU9Gxa/recNjFYJpeV23LPhH?blocks=hide
-              // TODO: (#proj-blocks-sdk-record-limits) Currently queries all cell values in a table
-              // when loading linked record data. Must add a LinkedRecord query type in the future.
-              // Since _loadDataAsync can only be called once, this recordStoreQueryId is only set once,
-              // although it is guaranteed to be stable if needed (so long as this._field.id is stable)
-
+              initiallyLoaded = this._linkedQueryResult.isDataLoaded;
               _context2.next = 6;
-              return _regenerator.default.awrap(Promise.all([this._sdk.base.__getRecordStore(this._record.parentTable.id).loadAllCellValuesInFieldIdsAsync([this._field.id]), this._linkedQueryResult.loadDataAsync(), this._loadRecordColorsAsync()]));
+              return _regenerator.default.awrap(Promise.all([this._sdk.base.__getRecordStore(this._record.parentTable.id).loadCellValuesInFieldIdsAsync([this._field.id]), this._linkedQueryResult.loadDataAsync(), this._loadRecordColorsAsync()]));
 
             case 6:
-              _ref = _context2.sent;
-              _ref2 = (0, _slicedToArray2.default)(_ref, 1);
-              recordStoreQueryId = _ref2[0];
-              this._recordStoreQueryId = recordStoreQueryId;
-
               this._invalidateComputedData();
 
               changedKeys = ['records', 'recordIds', 'recordColors']; // If the linked query result was not initially loaded, then the
@@ -332,55 +311,55 @@ function (_RecordQueryResult) {
               _iteratorNormalCompletion3 = true;
               _didIteratorError3 = false;
               _iteratorError3 = undefined;
-              _context2.prev = 17;
+              _context2.prev = 13;
 
               for (_iterator3 = fieldIds[Symbol.iterator](); !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
                 fieldId = _step3.value;
                 changedKeys.push(_record_query_result.default.WatchableCellValuesInFieldKeyPrefix + fieldId);
               }
 
-              _context2.next = 25;
+              _context2.next = 21;
               break;
 
-            case 21:
-              _context2.prev = 21;
-              _context2.t0 = _context2["catch"](17);
+            case 17:
+              _context2.prev = 17;
+              _context2.t0 = _context2["catch"](13);
               _didIteratorError3 = true;
               _iteratorError3 = _context2.t0;
 
-            case 25:
-              _context2.prev = 25;
-              _context2.prev = 26;
+            case 21:
+              _context2.prev = 21;
+              _context2.prev = 22;
 
               if (!_iteratorNormalCompletion3 && _iterator3.return != null) {
                 _iterator3.return();
               }
 
-            case 28:
-              _context2.prev = 28;
+            case 24:
+              _context2.prev = 24;
 
               if (!_didIteratorError3) {
-                _context2.next = 31;
+                _context2.next = 27;
                 break;
               }
 
               throw _iteratorError3;
 
-            case 31:
-              return _context2.finish(28);
+            case 27:
+              return _context2.finish(24);
 
-            case 32:
-              return _context2.finish(25);
+            case 28:
+              return _context2.finish(21);
 
-            case 33:
+            case 29:
               return _context2.abrupt("return", changedKeys);
 
-            case 34:
+            case 30:
             case "end":
               return _context2.stop();
           }
         }
-      }, null, this, [[17, 21, 25, 33], [26,, 28, 32]]);
+      }, null, this, [[13, 17, 21, 29], [22,, 24, 28]]);
     }
     /** @internal */
 
@@ -397,9 +376,7 @@ function (_RecordQueryResult) {
 
         this._unwatchLinkedQueryResult();
 
-        (0, _error_utils.invariant)(this._recordStoreQueryId, 'Unsubscribing from linked record record store without queryId');
-
-        this._originRecordStore.unloadCellValuesForQueryIdsThatAreSubscribedToAllCells([this._recordStoreQueryId]);
+        this._originRecordStore.unloadCellValuesInFieldIds([this._field.id]);
 
         this._linkedQueryResult.unloadData();
 
@@ -471,13 +448,7 @@ function (_RecordQueryResult) {
       // result
 
 
-      this._originRecordStore.watchWithRecordQueryResult({
-        priority: _airtable_interface.BlockQueryCallbackPriority.SDK,
-        recordQueryResult: this,
-        keys: _record_store.WatchableRecordStoreKeys.recordIds,
-        callbackForRegistration: this._onOriginRecordsChange,
-        context: this
-      }); // if the linked field in the origin table is deleted, we need to
+      this._originRecordStore.watch('recordIds', this._onOriginRecordsChange, this); // if the linked field in the origin table is deleted, we need to
       // invalidate this result
 
 
@@ -626,12 +597,11 @@ function (_RecordQueryResult) {
           if (Array.isArray(recordIds)) {
             var recordIdsSet = this._getOrGenerateRecordIdsSet();
 
-            var filteredRecordIds = recordIds.filter(id => typeof id === 'string' && recordIdsSet[id] === true); // There should always be a filteredRecordIds found for this query
-            // type - not finding any is a fundamental mistake in our query engine
+            var filteredRecordIds = recordIds.filter(id => typeof id === 'string' && recordIdsSet[id] === true);
 
-            (0, _error_utils.invariant)(filteredRecordIds.length, 'Filtered record change on incorrect record, query engine issue');
-
-            this._onChange(_record_query_result.default.WatchableCellValuesInFieldKeyPrefix + fieldId, filteredRecordIds);
+            if (filteredRecordIds.length) {
+              this._onChange(_record_query_result.default.WatchableCellValuesInFieldKeyPrefix + fieldId, filteredRecordIds);
+            }
           } else {
             this._onChange(_record_query_result.default.WatchableCellValuesInFieldKeyPrefix + fieldId);
           }
@@ -815,27 +785,6 @@ function (_RecordQueryResult) {
       (0, _error_utils.invariant)(recordIdsSet, 'recordIdsSet must exist');
       return recordIdsSet;
     }
-    /**
-     * This allows a record query result to specify the source of the query
-     * eg: View, Table, Linked record when watching fields.
-     * This scopes the watch to those fields + rows in the query.
-     *
-     * @internal
-     */
-
-  }, {
-    key: "__constructQuerySpecForBlockFieldSelectionSpec",
-    value: function __constructQuerySpecForBlockFieldSelectionSpec(fieldSelection) {
-      // The origin tableId is always the one referred to here as we must watch the origin record for deletion
-      var originTableId = this._record.parentTable.id;
-      return {
-        sourceType: _block_query_spec.BlockQuerySourceType.TABLE,
-        sourceTableId: originTableId,
-        recordSelection: {
-          fieldSelection
-        }
-      };
-    }
   }, {
     key: "isValid",
     get: function get() {