@airtable/blocks 1.9.0 → 1.10.2-experimental-640bd10-20220211

package/dist/cjs/private_utils.js

@@ -22,6 +22,10 @@ require("core-js/modules/es.object.to-string");
 
 require("core-js/modules/es.object.values");
 
+require("core-js/modules/es.regexp.constructor");
+
+require("core-js/modules/es.regexp.to-string");
+
 require("core-js/modules/es.set");
 
 require("core-js/modules/es.weak-map");
@@ -57,6 +61,7 @@ exports.getValueAtOwnPath = getValueAtOwnPath;
 exports.arrayDifference = arrayDifference;
 exports.debounce = debounce;
 exports.isBlockDevelopmentRestrictionEnabled = isBlockDevelopmentRestrictionEnabled;
+exports.isFieldId = isFieldId;
 Object.defineProperty(exports, "isDeepEqual", {
   enumerable: true,
   get: function get() {
@@ -140,10 +145,16 @@ function cast(x) {
   return x;
 }
 /**
+ * Used to turn a readonly type into a mutable copy: https://stackoverflow.com/a/50769802
+ * (used in the cloneDeep function)
+ *
  * @hidden
  */
 
 
+/**
+ * @hidden
+ */
 function cloneDeep(obj) {
   var jsonString = JSON.stringify(obj);
 
@@ -553,4 +564,33 @@ function debounce(fn, timeoutMs) {
 
 function isBlockDevelopmentRestrictionEnabled() {
   return (0, _airtable_interface.default)().sdkInitData.baseData.isBlockDevelopmentRestrictionEnabled;
+} // This is copied from hyper_id_generator in hyperbase
+
+/**
+ * Airtable id format. All object ids to have this format:
+ * <3 char prefix (lower-case)> + <14 random chars (upper/lower-case & numbers)>
+ * e.g. app4iu8QmuwcCbWCE
+ *
+ * We call it an "objectId" rather than "modelId" because not everything with an id is a model,
+ * e.g. worker access tokens.
+ */
+
+
+var ALPHA_NUMERIC_CHAR_PATTERN = '[A-Za-z0-9]';
+var OBJECT_ID_PREFIX_LENGTH = 3; // We allow shorter objectIds because our tests use non-standard AirtableIds
+
+var OBJECT_ID_MIN_SUFFIX_LENGTH = 1;
+var OBJECT_ID_SUFFIX_LENGTH = 14;
+var OBJECT_ID_SUFFIX_PATTERN = ALPHA_NUMERIC_CHAR_PATTERN + '{' + OBJECT_ID_MIN_SUFFIX_LENGTH + ',' + OBJECT_ID_SUFFIX_LENGTH + '}';
+var OBJECT_ID_PATTERN = '[a-z]{' + OBJECT_ID_PREFIX_LENGTH + '}' + OBJECT_ID_SUFFIX_PATTERN;
+var OBJECT_ID_REGEX = new RegExp('^' + OBJECT_ID_PATTERN + '$');
+
+function _isStringAnObjectId(str) {
+  return OBJECT_ID_REGEX.test(str);
+}
+/** @internal */
+
+
+function isFieldId(str) {
+  return typeof str === 'string' && _isStringAnObjectId(str) && str.substr(0, 3) === 'fld';
 }

package/dist/cjs/sdk.js

@@ -45,6 +45,8 @@ var _undo_redo = _interopRequireDefault(require("./undo_redo"));
 
 var _perform_record_action = require("./perform_record_action");
 
+var _query_manager = require("./models/query_manager");
+
 /** @hidden */
 
 /** */
@@ -101,6 +103,12 @@ function () {
 
   /** Represents the current Airtable {@link Base}. */
 
+  /**
+   * Represents active queries and their state
+   *
+   * @internal
+   */
+
   /** Contains information about the current session. */
 
   /** @internal */
@@ -152,6 +160,7 @@ function () {
     (0, _defineProperty2.default)(this, "__airtableInterface", void 0);
     (0, _defineProperty2.default)(this, "globalConfig", void 0);
     (0, _defineProperty2.default)(this, "base", void 0);
+    (0, _defineProperty2.default)(this, "_queryManager", void 0);
     (0, _defineProperty2.default)(this, "session", void 0);
     (0, _defineProperty2.default)(this, "__mutations", void 0);
     (0, _defineProperty2.default)(this, "installationId", void 0);
@@ -167,6 +176,7 @@ function () {
     var sdkInitData = airtableInterface.sdkInitData;
     this.globalConfig = new _global_config.default(sdkInitData.initialKvValuesByKey, this);
     this.base = new _base.default(this);
+    this._queryManager = new _query_manager.QueryManager(this);
     this.installationId = sdkInitData.blockInstallationId; // Bind the public methods on this class so users can import
     // just the method, e.g.
     // import {reload} from '@airtable/blocks';
@@ -176,7 +186,7 @@ function () {
     this.viewport = new _viewport.default(sdkInitData.isFullscreen, airtableInterface);
     this.cursor = new _cursor.default(this);
     this.session = new _session.default(this);
-    this.__mutations = new _mutations.default(this, this.session, this.base, changes => this.__applyModelChanges(changes), updates => this.__applyGlobalConfigUpdates(updates));
+    this.__mutations = new _mutations.default(this, this.session, this.base, updates => this.__applyGlobalConfigUpdates(updates));
     this.settingsButton = new _settings_button.default(airtableInterface);
     this.undoRedo = new _undo_redo.default(airtableInterface);
     this.performRecordAction = new _perform_record_action.PerformRecordAction(this, airtableInterface);
@@ -330,4 +340,4 @@ function () {
 }();
 
 exports.default = BlockSdk;
-(0, _defineProperty2.default)(BlockSdk, "VERSION", "1.9.0");
+(0, _defineProperty2.default)(BlockSdk, "VERSION", "1.10.2-experimental-640bd10-20220211");

package/dist/cjs/testing/abstract_mock_airtable_interface.js

@@ -4,17 +4,23 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 require("core-js/modules/es.array.concat");
 
-require("core-js/modules/es.array.map");
+require("core-js/modules/es.array.iterator");
 
 require("core-js/modules/es.object.to-string");
 
 require("core-js/modules/es.promise");
 
+require("core-js/modules/web.dom-collections.iterator");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AbstractMockAirtableInterface = void 0;
 
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+require("regenerator-runtime/runtime");
+
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -155,7 +161,8 @@ var globalConfigHelpers = {
 var idGenerator = {
   generateRecordId: () => 'recGeneratedMockId',
   generateFieldId: () => 'fldGeneratedMockId',
-  generateTableId: () => 'tblGeneratedMockId'
+  generateTableId: () => 'tblGeneratedMockId',
+  generateViewId: () => 'viwGeneratedMockId'
 };
 /**
  * An abstract base class with a common interface exposed to both Blocks SDK's
@@ -214,18 +221,15 @@ function (_EventEmitter) {
       };
     }
   }, {
-    key: "createVisList",
-    value: function createVisList(appInterface, recordDatas, fieldDatas, sorts) {
+    key: "createVisListWithRecordIds",
+    value: function createVisListWithRecordIds(recordIds, fieldDatas, sorts, tableId) {
       return {
-        removeRecordIds(recordIds) {},
+        removeRecordIds(removedRecordIds) {},
 
-        addRecordData(recordData) {},
+        addRecordIds(addedRecordIds) {},
 
         getOrderedRecordIds() {
-          return recordDatas.map((_ref) => {
-            var id = _ref.id;
-            return id;
-          });
+          return [...recordIds];
         }
 
       };
@@ -237,7 +241,49 @@ function (_EventEmitter) {
     }
   }, {
     key: "setActiveViewOrTable",
-    value: function setActiveViewOrTable(tableId, viewId) {} // TODO(jugglinmike): Implement
+    value: function setActiveViewOrTable(tableId, viewId) {}
+  }, {
+    key: "subscribeToQueryAndPopulateStoresAsync",
+    value: function subscribeToQueryAndPopulateStoresAsync(query, options) {
+      return _regenerator.default.async(function subscribeToQueryAndPopulateStoresAsync$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              throw (0, _error_utils.spawnError)('subscribeToQueryAndPopulateStoresAsync unimplemented');
+
+            case 1:
+            case "end":
+              return _context.stop();
+          }
+        }
+      });
+    }
+  }, {
+    key: "unsubscribeFromQueryIdsAsync",
+    value: function unsubscribeFromQueryIdsAsync(querySpecIds) {
+      return _regenerator.default.async(function unsubscribeFromQueryIdsAsync$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              throw (0, _error_utils.spawnError)('unsubscribeFromQueryIdsAsync unimplemented');
+
+            case 1:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      });
+    }
+  }, {
+    key: "getTableRecordStoreIfExists",
+    value: function getTableRecordStoreIfExists(tableId) {
+      throw (0, _error_utils.spawnError)('getTableRecordStoreIfExists unimplemented');
+    }
+  }, {
+    key: "getViewMetadataStoreIfExists",
+    value: function getViewMetadataStoreIfExists(tableId, viewId) {
+      throw (0, _error_utils.spawnError)('getViewMetadataStoreIfExists unimplemented');
+    } // TODO(jugglinmike): Implement
 
   }, {
     key: "subscribeToGlobalConfigUpdates",

package/dist/cjs/testing/fixture_data.js

@@ -0,0 +1,268 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+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.includes");
+
+require("core-js/modules/es.array.iterator");
+
+require("core-js/modules/es.array.map");
+
+require("core-js/modules/es.object.get-own-property-descriptors");
+
+require("core-js/modules/es.object.to-string");
+
+require("core-js/modules/es.string.includes");
+
+require("core-js/modules/web.dom-collections.for-each");
+
+require("core-js/modules/web.dom-collections.iterator");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.convertFixtureDataToSdkInitData = convertFixtureDataToSdkInitData;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _private_utils = require("../private_utils");
+
+var _airtable_interface = require("../types/airtable_interface");
+
+var _error_utils = require("../error_utils");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+// There are some values that FixtureData does not cover but SdkInitData
+// requires, so we fill in some mock values for them if needed.
+var MOCK_BLOCK_INSTALLATION_ID = 'blicPfOILwejF6HL2';
+var MOCK_BLOCK_RUN_CONTEXT_TYPE = _airtable_interface.BlockRunContextType.DASHBOARD_APP;
+var MOCK_BASE_PERMISSION_LEVEL = 'create';
+var MOCK_CURRENT_USER_ID = 'usrGalSamari';
+var MOCK_BASE_COLOR = 'purple';
+var MOCK_BILLING_GROUP = 'pro';
+/** @hidden */
+
+function convertFixtureDataToSdkInitData(fixtureData) {
+  var _fixtureData$base = fixtureData.base,
+      id = _fixtureData$base.id,
+      name = _fixtureData$base.name,
+      color = _fixtureData$base.color,
+      tables = _fixtureData$base.tables,
+      collaborators = _fixtureData$base.collaborators,
+      globalConfig = fixtureData.globalConfig;
+  var tablesById = {};
+
+  if (tables.length === 0) {
+    throw (0, _error_utils.spawnError)('Fixture data must include at least one table');
+  }
+
+  var _iteratorNormalCompletion = true;
+  var _didIteratorError = false;
+  var _iteratorError = undefined;
+
+  try {
+    for (var _iterator = tables[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+      var table = _step.value;
+      var tableData = convertTableFixtureDataToTableData(table);
+
+      if (tablesById[table.id]) {
+        throw (0, _error_utils.spawnError)('repeated table ID: %s', table.id);
+      }
+
+      tablesById[table.id] = tableData;
+    }
+  } catch (err) {
+    _didIteratorError = true;
+    _iteratorError = err;
+  } finally {
+    try {
+      if (!_iteratorNormalCompletion && _iterator.return != null) {
+        _iterator.return();
+      }
+    } finally {
+      if (_didIteratorError) {
+        throw _iteratorError;
+      }
+    }
+  }
+
+  return {
+    isDevelopmentMode: false,
+    blockInstallationId: MOCK_BLOCK_INSTALLATION_ID,
+    isFirstRun: false,
+    isFullscreen: false,
+    initialKvValuesByKey: _objectSpread({}, globalConfig),
+    runContext: {
+      type: MOCK_BLOCK_RUN_CONTEXT_TYPE
+    },
+    baseData: {
+      id,
+      name,
+      color: color !== null && color !== void 0 ? color : MOCK_BASE_COLOR,
+      activeTableId: tables[0].id,
+      tableOrder: tables.map(t => t.id),
+      tablesById,
+      permissionLevel: MOCK_BASE_PERMISSION_LEVEL,
+      currentUserId: MOCK_CURRENT_USER_ID,
+      enabledFeatureNames: [],
+      collaboratorsById: (0, _private_utils.keyBy)(collaborators.map(c => {
+        // filter out c.isActive
+        var email = c.email,
+            profilePicUrl = c.profilePicUrl;
+        return {
+          id: c.id,
+          name: c.name,
+          email,
+          profilePicUrl
+        };
+      }), _private_utils.getId),
+      activeCollaboratorIds: collaborators.filter(c => c.isActive).map(c => c.id),
+      cursorData: null,
+      billingPlanGrouping: MOCK_BILLING_GROUP,
+      appInterface: {},
+      isBlockDevelopmentRestrictionEnabled: false
+    },
+    intentData: null
+  };
+}
+/** @internal */
+
+
+function convertTableFixtureDataToTableData(tableFixtureData) {
+  var id = tableFixtureData.id,
+      name = tableFixtureData.name,
+      description = tableFixtureData.description,
+      fields = tableFixtureData.fields,
+      views = tableFixtureData.views,
+      records = tableFixtureData.records;
+  var tableRecordIds = records.map(_private_utils.getId);
+  var fieldsById = {};
+
+  if (fields.length === 0) {
+    throw (0, _error_utils.spawnError)('Every table in fixture data must specify at least one field, but table "%s" specified zero fields', id);
+  }
+
+  var _iteratorNormalCompletion2 = true;
+  var _didIteratorError2 = false;
+  var _iteratorError2 = undefined;
+
+  try {
+    for (var _iterator2 = fields[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
+      var field = _step2.value;
+      var fieldData = convertFieldFixtureDataToFieldData(field);
+
+      if (fieldsById[field.id]) {
+        throw (0, _error_utils.spawnError)('repeated field ID: %s', field.id);
+      }
+
+      fieldsById[field.id] = fieldData;
+    }
+  } catch (err) {
+    _didIteratorError2 = true;
+    _iteratorError2 = err;
+  } finally {
+    try {
+      if (!_iteratorNormalCompletion2 && _iterator2.return != null) {
+        _iterator2.return();
+      }
+    } finally {
+      if (_didIteratorError2) {
+        throw _iteratorError2;
+      }
+    }
+  }
+
+  var viewsById = {};
+
+  if (views.length === 0) {
+    throw (0, _error_utils.spawnError)('Every table in fixture data must specify at least one view, but table "%s" specified zero views', id);
+  }
+
+  var _iteratorNormalCompletion3 = true;
+  var _didIteratorError3 = false;
+  var _iteratorError3 = undefined;
+
+  try {
+    for (var _iterator3 = views[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
+      var view = _step3.value;
+      var viewData = view;
+
+      if (viewsById[view.id]) {
+        throw (0, _error_utils.spawnError)('repeated view ID: %s', view.id);
+      }
+
+      view.records.map(_private_utils.getId).forEach(viewRecordId => {
+        if (!tableRecordIds.includes(viewRecordId)) {
+          throw (0, _error_utils.spawnError)('record %s not present in table %s', viewRecordId, id);
+        }
+      });
+      viewsById[view.id] = viewData;
+    }
+  } catch (err) {
+    _didIteratorError3 = true;
+    _iteratorError3 = err;
+  } finally {
+    try {
+      if (!_iteratorNormalCompletion3 && _iterator3.return != null) {
+        _iterator3.return();
+      }
+    } finally {
+      if (_didIteratorError3) {
+        throw _iteratorError3;
+      }
+    }
+  }
+
+  return {
+    id,
+    name,
+    description,
+    primaryFieldId: fields[0].id,
+    fieldsById,
+    activeViewId: views[0].id,
+    viewOrder: views.map(v => v.id),
+    viewsById,
+    lock: null,
+    externalSyncById: null
+  };
+}
+/** @internal */
+
+
+function convertFieldFixtureDataToFieldData(fieldFixtureData) {
+  var id = fieldFixtureData.id,
+      name = fieldFixtureData.name,
+      description = fieldFixtureData.description,
+      type = fieldFixtureData.type,
+      options = fieldFixtureData.options;
+  return {
+    id,
+    name,
+    type,
+    description,
+    typeOptions: options,
+    lock: null
+  };
+}
+/**
+ * A complete set of information necessary to initialize a simulated Airtable
+ * Base in automated test environments. This is currently copied from
+ * block-testing.
+ *
+ * Unlike SdkInitData which does not contain record data by design,
+ * FixtureData contains it in fixtureData.base.tables[number].records,
+ * and relies on dependent modules to simulate the hyperbase behavior of
+ * only making those records after corresponding necessary calls to
+ * AirtableInterface.
+ *
+ * @hidden
+ */