@airtable/blocks 1.18.1 → 1.19.0

package/dist/cjs/testing/abstract_mock_airtable_interface.js

@@ -1,52 +1,34 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-require("core-js/modules/es.array.concat");
-
-require("core-js/modules/es.array.map");
-
-require("core-js/modules/es.object.to-string");
-
-require("core-js/modules/es.promise");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AbstractMockAirtableInterface = void 0;
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
-
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
-
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
-
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.map.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.promise.js");
 var _private_utils = require("../private_utils");
-
 var _error_utils = require("../error_utils");
-
-// istanbul ignore file
+function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } // istanbul ignore file
 var EventEmitter = require('events');
-/** @internal */
-
 
+/** @internal */
 var aggregators = {
   aggregate(appInterface, summaryFunctionKey, cellValues, fieldData) {
     return null;
   },
-
   aggregateToString(appInterface, summaryFunctionKey, cellValues, fieldData) {
     return '';
   },
-
   getAggregatorConfig(summaryFunctionKey) {
     return {
       key: '',
@@ -54,23 +36,19 @@ var aggregators = {
       shortDisplayName: ''
     };
   },
-
   getAllAvailableAggregatorKeys() {
     return [];
   },
-
   getAvailableAggregatorKeysForField(fieldData) {
     return [];
   }
-
 };
-/** @internal */
 
+/** @internal */
 var fieldTypeProvider = {
   isComputed(fieldData) {
     return false;
   },
-
   validateConfigForUpdate: () => {
     return {
       isValid: true
@@ -85,28 +63,23 @@ var fieldTypeProvider = {
   canBePrimary: () => {
     return true;
   },
-
   convertStringToCellValue(appInterface, string, fieldData) {
     return '';
   },
-
   convertCellValueToString(appInterface, cellValue, fieldData) {
     return '';
   },
-
   getCellRendererData(appInterface, cellValue, fieldData, shouldWrap) {
     return {
       cellValueHtml: "<pre>".concat(JSON.stringify(cellValue), "</pre>"),
       attributes: {}
     };
   },
-
   validateCellValueForUpdate(appInterface, newCellValue, currentCellValue, fieldData) {
     return {
       isValid: true
     };
   },
-
   getUiConfig(appInterface, fieldData) {
     return {
       iconName: '',
@@ -114,90 +87,102 @@ var fieldTypeProvider = {
       minimumCellWidthForRecordCard: 0
     };
   }
-
 };
-/** @internal */
 
+/** @internal */
 var urlConstructor = {
   getTableUrl(tableId) {
     return "https://airtable.test/".concat(tableId);
   },
-
   getViewUrl(viewId, tableId) {
     return "https://airtable.test/".concat(tableId, "/").concat(viewId);
   },
-
   getRecordUrl(recordId, tableId) {
     return "https://airtable.test/".concat(tableId, "/").concat(recordId);
   },
-
   getAttachmentClientUrl(appInterface, attachmentId, attachmentUrl) {
     return attachmentUrl;
   }
-
 };
-/** @internal */
 
+/** @internal */
 var globalConfigHelpers = {
   validatePath(path, store) {
     return {
       isValid: true
     };
   },
-
   validateAndApplyUpdates(updates, store) {
     throw (0, _error_utils.spawnError)('validateAndApplyUpdates unimplemented');
   }
-
 };
-/** @internal */
 
+/** @internal */
 var idGenerator = {
   generateRecordId: () => 'recGeneratedMockId',
   generateFieldId: () => 'fldGeneratedMockId',
   generateTableId: () => 'tblGeneratedMockId'
 };
+
 /**
  * An abstract base class with a common interface exposed to both Blocks SDK's
  * internal automated test suite and the blocks-testing public repo.
  *
  * @hidden
  */
-
-var AbstractMockAirtableInterface =
-/*#__PURE__*/
-function (_EventEmitter) {
-  (0, _inherits2.default)(AbstractMockAirtableInterface, _EventEmitter);
-
+var AbstractMockAirtableInterface = exports.AbstractMockAirtableInterface = /*#__PURE__*/function (_EventEmitter) {
   function AbstractMockAirtableInterface(initData) {
     var _this;
-
     (0, _classCallCheck2.default)(this, AbstractMockAirtableInterface);
-    _this = (0, _possibleConstructorReturn2.default)(this, (0, _getPrototypeOf2.default)(AbstractMockAirtableInterface).call(this));
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "sdkInitData", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "_initData", void 0);
+    _this = _callSuper(this, AbstractMockAirtableInterface);
+    (0, _defineProperty2.default)(_this, "sdkInitData", void 0);
+    (0, _defineProperty2.default)(_this, "_initData", void 0);
     _this._initData = (0, _private_utils.cloneDeep)(initData);
-
     _this.reset();
-
     return _this;
   }
+
   /**
    * Revert the mock interface to its initial state. This includes:
    *
    * - removing all event listeners
    * - restoring the database schema
    */
-
-
-  (0, _createClass2.default)(AbstractMockAirtableInterface, [{
+  (0, _inherits2.default)(AbstractMockAirtableInterface, _EventEmitter);
+  return (0, _createClass2.default)(AbstractMockAirtableInterface, [{
     key: "reset",
     value: function reset() {
       this.removeAllListeners();
       this.sdkInitData = (0, _private_utils.cloneDeep)(this._initData);
-    } // The following properties are defined using accessors in order to
-    // facilitate overriding in subclasses.
+    }
 
+    // The following properties are defined using accessors in order to
+    // facilitate overriding in subclasses.
+  }, {
+    key: "aggregators",
+    get: function get() {
+      return aggregators;
+    }
+  }, {
+    key: "fieldTypeProvider",
+    get: function get() {
+      return fieldTypeProvider;
+    }
+  }, {
+    key: "urlConstructor",
+    get: function get() {
+      return urlConstructor;
+    }
+  }, {
+    key: "globalConfigHelpers",
+    get: function get() {
+      return globalConfigHelpers;
+    }
+  }, {
+    key: "idGenerator",
+    get: function get() {
+      return idGenerator;
+    }
   }, {
     key: "assertAllowedSdkPackageVersion",
     value: function assertAllowedSdkPackageVersion() {}
@@ -218,16 +203,13 @@ function (_EventEmitter) {
     value: function createVisList(appInterface, recordDatas, fieldDatas, sorts) {
       return {
         removeRecordIds(recordIds) {},
-
         addRecordData(recordData) {},
-
         getOrderedRecordIds() {
-          return recordDatas.map((_ref) => {
+          return recordDatas.map(_ref => {
             var id = _ref.id;
             return id;
           });
         }
-
       };
     }
   }, {
@@ -237,8 +219,9 @@ function (_EventEmitter) {
     }
   }, {
     key: "setActiveViewOrTable",
-    value: function setActiveViewOrTable(tableId, viewId) {} // TODO(jugglinmike): Implement
+    value: function setActiveViewOrTable(tableId, viewId) {}
 
+    // TODO(jugglinmike): Implement
   }, {
     key: "subscribeToGlobalConfigUpdates",
     value: function subscribeToGlobalConfigUpdates() {}
@@ -260,8 +243,9 @@ function (_EventEmitter) {
       this.emit('modelupdates', {
         changes
       });
-    } // TODO(jugglinmike): Implement
+    }
 
+    // TODO(jugglinmike): Implement
   }, {
     key: "triggerGlobalConfigUpdates",
     value: function triggerGlobalConfigUpdates() {}
@@ -289,33 +273,5 @@ function (_EventEmitter) {
   }, {
     key: "unsubscribeFromViewData",
     value: function unsubscribeFromViewData() {}
-  }, {
-    key: "aggregators",
-    get: function get() {
-      return aggregators;
-    }
-  }, {
-    key: "fieldTypeProvider",
-    get: function get() {
-      return fieldTypeProvider;
-    }
-  }, {
-    key: "urlConstructor",
-    get: function get() {
-      return urlConstructor;
-    }
-  }, {
-    key: "globalConfigHelpers",
-    get: function get() {
-      return globalConfigHelpers;
-    }
-  }, {
-    key: "idGenerator",
-    get: function get() {
-      return idGenerator;
-    }
   }]);
-  return AbstractMockAirtableInterface;
-}(EventEmitter);
-
-exports.AbstractMockAirtableInterface = AbstractMockAirtableInterface;
+}(EventEmitter);

package/dist/cjs/types/airtable_interface.js

@@ -6,14 +6,42 @@ Object.defineProperty(exports, "__esModule", {
 exports.BlockRunContextType = void 0;
 // BlockRunContextType, BlockInstallationPageBlockRunContext, ViewBlockRunContext, BlockRunContext
 // must be kept in sync with block_run_context.tsx in hyperbase repo
-
-/** @hidden */
-var BlockRunContextType;
 /** @hidden */
-
-exports.BlockRunContextType = BlockRunContextType;
-
-(function (BlockRunContextType) {
+var BlockRunContextType = exports.BlockRunContextType = /*#__PURE__*/function (BlockRunContextType) {
   BlockRunContextType["DASHBOARD_APP"] = "dashboardApp";
   BlockRunContextType["VIEW"] = "view";
-})(BlockRunContextType || (exports.BlockRunContextType = BlockRunContextType = {}));
+  return BlockRunContextType;
+}({});
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+// TODO: (SeanKeenan) Move NormalizedSortConfig from record_query_result here
+//       once/if we support setting the sort config for a view
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/**
+ * AppInterface should never be used directly by the SDK, so we don't describe the type.
+ *
+ * @hidden
+ */
+/** @hidden */
+/**
+ * AirtableInterface is designed as the communication interface between the
+ * Block SDK and Airtable. The mechanism through which we communicate with Airtable
+ * depends on the context in which the block is running (i.e. frontend or backend),
+ * but the interface should remain consistent.
+ *
+ * @hidden
+ */

package/dist/cjs/types/field.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.FieldType = void 0;
-
 /** @module @airtable/blocks/models: Field */
-
 /** */
-
 /** */
-
 /** @hidden */
-
 /**
  * An enum of Airtable's field types
  *
@@ -24,12 +19,7 @@ exports.FieldType = void 0;
  * ));
  * ```
  */
-var FieldType;
-/** @hidden */
-
-exports.FieldType = FieldType;
-
-(function (FieldType) {
+var FieldType = exports.FieldType = /*#__PURE__*/function (FieldType) {
   FieldType["SINGLE_LINE_TEXT"] = "singleLineText";
   FieldType["EMAIL"] = "email";
   FieldType["URL"] = "url";
@@ -63,4 +53,68 @@ exports.FieldType = FieldType;
   FieldType["BUTTON"] = "button";
   FieldType["EXTERNAL_SYNC_SOURCE"] = "externalSyncSource";
   FieldType["AI_TEXT"] = "aiText";
-})(FieldType || (exports.FieldType = FieldType = {}));
+  return FieldType;
+}({});
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+// These field option definitions are based on the types returned by block_field_type_provider#getConfig
+// Be careful to keep them in sync and make changes in a backwards compatible manner
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/** @hidden */
+/**
+ * A type for use with Field objects to make type narrowing FieldOptions easier.
+ *
+ * @example
+ * const fieldConfig = field.config;
+ * if (fieldConfig.type === FieldType.SINGLE_SELECT) {
+ *     return fieldConfig.options.choices;
+ * } else if (fieldConfig.type === FieldType.MULTIPLE_LOOKUP_VALUES && fieldConfig.options.isValid) {
+ *     if (fieldConfig.options.result.type === FieldType.SINGLE_SELECT) {
+ *         return fieldConfig.options.result.options.choices;
+ *     }
+ * }
+ * return DEFAULT_CHOICES;
+ */

package/dist/cjs/types/mutations.js

@@ -4,13 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.MutationTypes = void 0;
-
-/** @module @airtable/blocks: mutations */
-
-/** */
+/** @module @airtable/blocks: mutations */ /** */
 
 /** @hidden */
-var MutationTypes = Object.freeze({
+var MutationTypes = exports.MutationTypes = Object.freeze({
   SET_MULTIPLE_RECORDS_CELL_VALUES: 'setMultipleRecordsCellValues',
   DELETE_MULTIPLE_RECORDS: 'deleteMultipleRecords',
   CREATE_MULTIPLE_RECORDS: 'createMultipleRecords',
@@ -22,6 +19,102 @@ var MutationTypes = Object.freeze({
   CREATE_SINGLE_TABLE: 'createSingleTable',
   UPDATE_VIEW_METADATA: 'updateViewMetadata'
 });
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App modifies one or more {@link Record|Records}.
+ *
+ * @docsPath testing/mutations/SetMultipleRecordsCellValuesMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App deletes one or more {@link Record|Records}.
+ *
+ * @docsPath testing/mutations/DeleteMultipleRecordsMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App creates one or more {@link Record|Records}.
+ *
+ * @docsPath testing/mutations/CreateMultipleRecordsMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App modifies one or more values in the
+ * {@link GlobalConfig}.
+ *
+ * @docsPath testing/mutations/SetMultipleGlobalConfigPathsMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App creates a {@link Field}.
+ *
+ * @docsPath testing/mutations/CreateSingleFieldMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App modifies the options of a {@link Field}.
+ *
+ * @docsPath testing/mutations/UpdateSingleFieldConfigMutation
+ */
+// note: while this accepts both type and options in config, we enforce liveapp-side that type
+// is not changed.
+
 /** @hidden */
 
-exports.MutationTypes = MutationTypes;
+/**
+ * The Mutation emitted when the App modifies the description of a {@link Field}.
+ *
+ * @docsPath testing/mutations/UpdateSingleFieldDescriptionMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App modifies the name of a {@link Field}.
+ *
+ * @docsPath testing/mutations/UpdateSingleFieldNameMutation
+ */
+
+/** @hidden */
+
+/**
+ * Options that affect the behavior of an `UpdateSingleFieldConfigMutation`
+ */
+
+/**
+ * The Mutation emitted when the App creates a {@link Table}
+ *
+ * @docsPath testing/mutations/CreateSingleTableMutation
+ */
+
+/** @hidden */
+
+/**
+ * The Mutation emitted when the App modifies a {@link View}.
+ *
+ * @docsPath testing/mutations/UpdateViewMetadataMutation
+ */
+
+/** @hidden */
+
+/** @hidden */
+
+/** @hidden */
+
+/** */
+
+/** */
+
+/** Indicates whether the user has permission to perform a particular action, and if not, why. */

package/dist/cjs/types/permission_levels.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.PermissionLevels = void 0;
-
 /** @hidden */
-var PermissionLevels = Object.freeze({
+var PermissionLevels = exports.PermissionLevels = Object.freeze({
   NONE: 'none',
   READ: 'read',
   COMMENT: 'comment',
@@ -14,6 +13,5 @@ var PermissionLevels = Object.freeze({
   CREATE: 'create',
   OWNER: 'owner'
 });
-/** @hidden */
 
-exports.PermissionLevels = PermissionLevels;
+/** @hidden */

package/dist/cjs/types/undo_redo.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.UndoRedoModes = void 0;
-var UndoRedoModes = Object.freeze({
+var UndoRedoModes = exports.UndoRedoModes = Object.freeze({
   NONE: 'none',
   AUTO: 'auto'
 });
-/** @hidden */
 
-exports.UndoRedoModes = UndoRedoModes;
+/** @hidden */

package/dist/cjs/types/view.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.ViewType = void 0;
-
 /** @module @airtable/blocks/models: View */
-
 /** */
-
 /** */
-
 /**
  * An enum of Airtable's view types
  *
@@ -22,16 +18,25 @@ exports.ViewType = void 0;
  * ));
  * ```
  */
-var ViewType;
-/** @hidden */
-
-exports.ViewType = ViewType;
-
-(function (ViewType) {
+var ViewType = exports.ViewType = /*#__PURE__*/function (ViewType) {
   ViewType["GRID"] = "grid";
   ViewType["FORM"] = "form";
   ViewType["CALENDAR"] = "calendar";
   ViewType["GALLERY"] = "gallery";
   ViewType["KANBAN"] = "kanban";
   ViewType["BLOCK"] = "block";
-})(ViewType || (exports.ViewType = ViewType = {}));
+  return ViewType;
+}({});
+/** @hidden */
+/** @hidden */
+/**
+ * Data provided by airtable for groups, only available on views or grouped queries
+ *
+ * @hidden
+ */
+/**
+ * GroupLevel provided by airtable - matches NormalizedGroupLevel
+ *
+ * @hidden
+ */
+/** @hidden */