@airtable/blocks 1.8.0 → 1.9.0-experimental

package/dist/cjs/models/mutations.js

@@ -6,18 +6,12 @@ require("core-js/modules/es.symbol");
 
 require("core-js/modules/es.symbol.description");
 
-require("core-js/modules/es.array.filter");
-
-require("core-js/modules/es.array.flat-map");
-
 require("core-js/modules/es.array.includes");
 
 require("core-js/modules/es.array.iterator");
 
 require("core-js/modules/es.array.map");
 
-require("core-js/modules/es.array.unscopables.flat-map");
-
 require("core-js/modules/es.object.to-string");
 
 require("core-js/modules/es.promise");
@@ -28,15 +22,11 @@ require("core-js/modules/es.string.includes");
 
 require("core-js/modules/web.dom-collections.iterator");
 
-require("core-js/modules/web.url.to-json");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
 require("regenerator-runtime/runtime");
@@ -51,8 +41,6 @@ var _airtable_interface = require("../types/airtable_interface");
 
 var _mutations = require("../types/mutations");
 
-var _private_utils = require("../private_utils");
-
 var _error_utils = require("../error_utils");
 
 var _mutation_constants = require("./mutation_constants");
@@ -81,22 +69,18 @@ function () {
 
   /** @internal */
 
-  /** @internal */
-
   /** @hidden */
-  function Mutations(sdk, session, base, applyModelChanges, applyGlobalConfigUpdates) {
+  function Mutations(sdk, session, base, applyGlobalConfigUpdates) {
     (0, _classCallCheck2.default)(this, Mutations);
     (0, _defineProperty2.default)(this, "_airtableInterface", void 0);
     (0, _defineProperty2.default)(this, "_session", void 0);
     (0, _defineProperty2.default)(this, "_sdk", void 0);
     (0, _defineProperty2.default)(this, "_base", void 0);
-    (0, _defineProperty2.default)(this, "_applyModelChanges", void 0);
     (0, _defineProperty2.default)(this, "_applyGlobalConfigUpdates", void 0);
     this._airtableInterface = sdk.__airtableInterface;
     this._session = session;
     this._sdk = sdk;
     this._base = base;
-    this._applyModelChanges = applyModelChanges;
     this._applyGlobalConfigUpdates = applyGlobalConfigUpdates;
   }
   /** @hidden */
@@ -270,9 +254,12 @@ function () {
             try {
               for (var _iterator = records[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
                 var record = _step.value;
-                var existingRecord = null;
+                var existingRecord = null; // Note - if isSubscribedToAllRecordsInTable is true then we know the record
+                // doesn't exist (or is deleted) but otherwise we can issue a mutation to a record
+                // that does not exist, having to deal with the error thrown by PublicAirtableInterfaceFrontend
+                // TODO: (#proj-blocks-sdk-record-limits) Write tests around this behavior
 
-                if (recordStore.isRecordMetadataLoaded) {
+                if (recordStore.isSubscribedToAllRecordsInTable || recordStore.isRecordLoaded(record.id)) {
                   existingRecord = recordStore.getRecordByIdIfExists(record.id);
 
                   if (!existingRecord) {
@@ -294,7 +281,7 @@ function () {
                     checkedFieldIds.add(fieldId);
                   }
 
-                  if (existingRecord && recordStore.areCellValuesLoadedForFieldId(fieldId)) {
+                  if (existingRecord && recordStore.isRecordCellValueLoadedForFieldId(record.id, fieldId)) {
                     var validationResult = this._airtableInterface.fieldTypeProvider.validateCellValueForUpdate(appInterface, record.cellValuesByFieldId[fieldId], existingRecord._getRawCellValue(field), field._data);
 
                     if (!validationResult.isValid) {
@@ -332,9 +319,15 @@ function () {
               throw (0, _error_utils.spawnError)("Can't delete records: No table with id %s exists", _tableId);
             }
 
-            var _recordStore = this._base.__getRecordStore(_tableId);
+            var _recordStore = this._base.__getRecordStore(_tableId); // TODO: (#proj-blocks-sdk-record-limits) We substantially weaken our check here
+            // because we can only be sure if the record exists inside the SDK if we've loaded
+            // all records. It is possible to change this logic to ensure we don't double-delete
+            // records by caching previously deleted records (if the delete is undone, but
+            // we're not watching the record be re-created from the undo we would have to fail
+            // the delete if we detect double deletion). TODO to add tests around this behavior.
+
 
-            if (_recordStore.isRecordMetadataLoaded) {
+            if (_recordStore.isSubscribedToAllRecordsInTable) {
               var _iteratorNormalCompletion2 = true;
               var _didIteratorError2 = false;
               var _iteratorError2 = undefined;
@@ -442,7 +435,8 @@ function () {
           {
             var _tableId3 = mutation.tableId,
                 name = mutation.name,
-                config = mutation.config;
+                config = mutation.config,
+                description = mutation.description;
 
             var _table3 = this._base.getTableByIdIfExists(_tableId3);
 
@@ -475,6 +469,10 @@ function () {
               throw (0, _error_utils.spawnError)("Can't create field: invalid field config.\n%s", _validationResult2.reason);
             }
 
+            if (description && description.length > _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH) {
+              throw (0, _error_utils.spawnError)("Can't create field: description exceeds maximum length of %s characters", _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH);
+            }
+
             return;
           }
 
@@ -511,6 +509,31 @@ function () {
             return;
           }
 
+        case _mutations.MutationTypes.UPDATE_SINGLE_FIELD_DESCRIPTION:
+          {
+            var _tableId5 = mutation.tableId,
+                _id = mutation.id,
+                _description = mutation.description;
+
+            var _table5 = this._base.getTableByIdIfExists(_tableId5);
+
+            if (!_table5) {
+              throw (0, _error_utils.spawnError)("Can't update field: No table with id %s exists", _tableId5);
+            }
+
+            var _field3 = _table5.getFieldByIdIfExists(_id);
+
+            if (!_field3) {
+              throw (0, _error_utils.spawnError)("Can't update field: No field with id %s exists", _id);
+            }
+
+            if (_description && _description.length > _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH) {
+              throw (0, _error_utils.spawnError)("Can't update field: description exceeds maximum length of %s characters", _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH);
+            }
+
+            return;
+          }
+
         case _mutations.MutationTypes.CREATE_SINGLE_TABLE:
           {
             var _name = mutation.name,
@@ -545,28 +568,32 @@ function () {
 
             try {
               for (var _iterator4 = fields[Symbol.iterator](), _step4; !(_iteratorNormalCompletion4 = (_step4 = _iterator4.next()).done); _iteratorNormalCompletion4 = true) {
-                var _field3 = _step4.value;
+                var _field4 = _step4.value;
 
-                if (!_field3.name) {
+                if (!_field4.name) {
                   throw (0, _error_utils.spawnError)("Can't create table: must provide non-empty name for every field");
                 }
 
-                if (_field3.name.length > _mutation_constants.MAX_FIELD_NAME_LENGTH) {
-                  throw (0, _error_utils.spawnError)("Can't create table: field name '%s' exceeds maximum length of %s characters", _field3.name, _mutation_constants.MAX_FIELD_NAME_LENGTH);
+                if (_field4.name.length > _mutation_constants.MAX_FIELD_NAME_LENGTH) {
+                  throw (0, _error_utils.spawnError)("Can't create table: field name '%s' exceeds maximum length of %s characters", _field4.name, _mutation_constants.MAX_FIELD_NAME_LENGTH);
                 }
 
-                var lowercaseFieldName = _field3.name.toLowerCase();
+                var lowercaseFieldName = _field4.name.toLowerCase();
 
                 if (lowercaseFieldNames.has(lowercaseFieldName)) {
-                  throw (0, _error_utils.spawnError)("Can't create table: duplicate field name '%s'", _field3.name);
+                  throw (0, _error_utils.spawnError)("Can't create table: duplicate field name '%s'", _field4.name);
                 }
 
                 lowercaseFieldNames.add(lowercaseFieldName); // Current config / field data is null since the field doesn't exist.
 
-                var _validationResult4 = this._airtableInterface.fieldTypeProvider.validateConfigForUpdate(appInterface, _field3.config, null, null, billingPlanGrouping);
+                var _validationResult4 = this._airtableInterface.fieldTypeProvider.validateConfigForUpdate(appInterface, _field4.config, null, null, billingPlanGrouping);
 
                 if (!_validationResult4.isValid) {
-                  throw (0, _error_utils.spawnError)("Can't create table: invalid field config for field '%s'.\n%s", _field3.name, _validationResult4.reason);
+                  throw (0, _error_utils.spawnError)("Can't create table: invalid field config for field '%s'.\n%s", _field4.name, _validationResult4.reason);
+                }
+
+                if (_field4.description && _field4.description.length > _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH) {
+                  throw (0, _error_utils.spawnError)("Can't create table: description for field '%s' exceeds maximum length of %s characters", _field4.name, _mutation_constants.MAX_FIELD_DESCRIPTION_LENGTH);
                 }
               }
             } catch (err) {
@@ -595,7 +622,7 @@ function () {
 
         case _mutations.MutationTypes.UPDATE_VIEW_METADATA:
           {
-            var _tableId5 = mutation.tableId,
+            var _tableId6 = mutation.tableId,
                 viewId = mutation.viewId;
             var runContext = this._airtableInterface.sdkInitData.runContext;
 
@@ -603,17 +630,17 @@ function () {
               throw (0, _error_utils.spawnError)('Setting view metadata is only valid for views');
             }
 
-            if (runContext.viewId !== viewId || runContext.tableId !== _tableId5) {
+            if (runContext.viewId !== viewId || runContext.tableId !== _tableId6) {
               throw (0, _error_utils.spawnError)('Custom views can only set view metadata on themselves');
             }
 
-            var _table5 = this._base.getTableByIdIfExists(_tableId5);
+            var _table6 = this._base.getTableByIdIfExists(_tableId6);
 
-            if (!_table5) {
-              throw (0, _error_utils.spawnError)("Can't update metadata: No table with id %s exists", _tableId5);
+            if (!_table6) {
+              throw (0, _error_utils.spawnError)("Can't update metadata: No table with id %s exists", _tableId6);
             }
 
-            var view = _table5.getViewByIdIfExists(viewId);
+            var view = _table6.getViewByIdIfExists(viewId);
 
             if (!view) {
               throw (0, _error_utils.spawnError)("Can't update metadata: No view with id %s exists", viewId);
@@ -638,149 +665,13 @@ function () {
         this._applyGlobalConfigUpdates(mutation.updates);
 
         return true;
-      }
+      } // https://airtable.com/appahuJQw7qfQTBBU/tblSbpimM8Spp9txp/viweAFIus3MhU9Gxa/recHOckY4V9QmM6JV?blocks=hide
+      // TODO: (#proj-blocks-sdk-record-limits) Fix this in a future stacked diff where optimistic
+      // updates are re-enabled https://docs.google.com/document/d/1CVZ4ZoPWEtpzKq_9cRLASGwgY71WI4nl6RVvs8S7Ubw/edit#
 
-      var modelChanges = this._getOptimisticModelChangesForMutation(mutation);
-
-      if (modelChanges.length > 0) {
-        this._applyModelChanges(modelChanges);
-
-        return true;
-      }
 
       return false;
     }
-    /** @internal */
-
-  }, {
-    key: "_getOptimisticModelChangesForMutation",
-    value: function _getOptimisticModelChangesForMutation(mutation) {
-      switch (mutation.type) {
-        case _mutations.MutationTypes.SET_MULTIPLE_RECORDS_CELL_VALUES:
-          {
-            var tableId = mutation.tableId,
-                records = mutation.records;
-
-            var recordStore = this._base.__getRecordStore(tableId);
-
-            return records.flatMap(record => Object.keys(record.cellValuesByFieldId).filter(fieldId => recordStore.areCellValuesLoadedForFieldId(fieldId)).map(fieldId => ({
-              path: ['tablesById', tableId, 'recordsById', record.id, 'cellValuesByFieldId', fieldId],
-              value: record.cellValuesByFieldId[fieldId]
-            })));
-          }
-
-        case _mutations.MutationTypes.DELETE_MULTIPLE_RECORDS:
-          {
-            var _tableId6 = mutation.tableId,
-                recordIds = mutation.recordIds;
-
-            var _recordStore2 = this._base.__getRecordStore(_tableId6);
-
-            if (!_recordStore2.isRecordMetadataLoaded) {
-              return [];
-            }
-
-            return [...recordIds.map(recordId => ({
-              path: ['tablesById', _tableId6, 'recordsById', recordId],
-              value: undefined
-            })), ...this._base.getTableById(_tableId6).views.flatMap(view => {
-              var viewDataStore = _recordStore2.getViewDataStore(view.id);
-
-              if (!viewDataStore.isDataLoaded) {
-                return [];
-              }
-
-              return viewDataStore.__generateChangesForParentTableDeleteMultipleRecords(recordIds);
-            })];
-          }
-
-        case _mutations.MutationTypes.CREATE_MULTIPLE_RECORDS:
-          {
-            var _tableId7 = mutation.tableId,
-                _records2 = mutation.records;
-
-            var _recordStore3 = this._base.__getRecordStore(_tableId7);
-
-            if (!_recordStore3.isRecordMetadataLoaded) {
-              return [];
-            }
-
-            return [..._records2.map(record => {
-              // Only apply optimistic changes for fields that are loaded
-              var filteredCellValuesByFieldId = {};
-              var _iteratorNormalCompletion5 = true;
-              var _didIteratorError5 = false;
-              var _iteratorError5 = undefined;
-
-              try {
-                for (var _iterator5 = (0, _private_utils.entries)(record.cellValuesByFieldId)[Symbol.iterator](), _step5; !(_iteratorNormalCompletion5 = (_step5 = _iterator5.next()).done); _iteratorNormalCompletion5 = true) {
-                  var _step5$value = (0, _slicedToArray2.default)(_step5.value, 2),
-                      fieldId = _step5$value[0],
-                      cellValue = _step5$value[1];
-
-                  if (_recordStore3.areCellValuesLoadedForFieldId(fieldId)) {
-                    filteredCellValuesByFieldId[fieldId] = cellValue;
-                  }
-                }
-              } catch (err) {
-                _didIteratorError5 = true;
-                _iteratorError5 = err;
-              } finally {
-                try {
-                  if (!_iteratorNormalCompletion5 && _iterator5.return != null) {
-                    _iterator5.return();
-                  }
-                } finally {
-                  if (_didIteratorError5) {
-                    throw _iteratorError5;
-                  }
-                }
-              }
-
-              return {
-                path: ['tablesById', _tableId7, 'recordsById', record.id],
-                value: {
-                  id: record.id,
-                  cellValuesByFieldId: filteredCellValuesByFieldId,
-                  commentCount: 0,
-                  createdTime: new Date().toJSON()
-                }
-              };
-            }), ...this._base.getTableById(_tableId7).views.flatMap(view => {
-              var viewDataStore = _recordStore3.getViewDataStore(view.id);
-
-              if (!viewDataStore.isDataLoaded) {
-                return [];
-              }
-
-              return viewDataStore.__generateChangesForParentTableAddMultipleRecords(_records2.map(record => record.id));
-            })];
-          }
-        // The following branch is unreachable because this method's only
-        // call site is preceded by an explicit guard for this condition.
-        // istanbul ignore next
-
-        case _mutations.MutationTypes.SET_MULTIPLE_GLOBAL_CONFIG_PATHS:
-          {
-            throw (0, _error_utils.spawnError)('attempting to generate model updates for SET_MULTIPLE_GLOBAL_CONFIG_PATH');
-          }
-
-        case _mutations.MutationTypes.CREATE_SINGLE_FIELD:
-        case _mutations.MutationTypes.UPDATE_SINGLE_FIELD_CONFIG:
-        case _mutations.MutationTypes.UPDATE_VIEW_METADATA:
-        case _mutations.MutationTypes.CREATE_SINGLE_TABLE:
-          {
-            // No optimistic updates for field, view metadata, or table mutations.
-            return [];
-          }
-        // The following branch is unreachable because this method's only
-        // call site is preceded by an explicit guard for this condition.
-        // istanbul ignore next
-
-        default:
-          throw (0, _error_utils.spawnUnknownSwitchCaseError)('mutation type', mutation, 'type');
-      }
-    }
   }]);
   return Mutations;
 }();