@airtable/blocks 1.3.0 → 1.5.1

package/dist/cjs/models/models.js

@@ -13,6 +13,12 @@ Object.defineProperty(exports, "FieldType", {
     return _field.FieldType;
   }
 });
+Object.defineProperty(exports, "FieldConfig", {
+  enumerable: true,
+  get: function get() {
+    return _field.FieldConfig;
+  }
+});
 Object.defineProperty(exports, "ViewType", {
   enumerable: true,
   get: function get() {
@@ -61,6 +67,12 @@ Object.defineProperty(exports, "TableOrViewQueryResult", {
     return _table_or_view_query_result.default;
   }
 });
+Object.defineProperty(exports, "GroupedRecordQueryResult", {
+  enumerable: true,
+  get: function get() {
+    return _grouped_record_query_result.default;
+  }
+});
 Object.defineProperty(exports, "LinkedRecordsQueryResult", {
   enumerable: true,
   get: function get() {
@@ -73,6 +85,18 @@ Object.defineProperty(exports, "ViewMetadataQueryResult", {
     return _view_metadata_query_result.default;
   }
 });
+Object.defineProperty(exports, "Session", {
+  enumerable: true,
+  get: function get() {
+    return _session.default;
+  }
+});
+Object.defineProperty(exports, "Cursor", {
+  enumerable: true,
+  get: function get() {
+    return _cursor.default;
+  }
+});
 exports.recordColoring = void 0;
 
 var recordColoring = _interopRequireWildcard(require("./record_coloring"));
@@ -99,10 +123,16 @@ var _record_query_result = _interopRequireDefault(require("./record_query_result
 
 var _table_or_view_query_result = _interopRequireDefault(require("./table_or_view_query_result"));
 
+var _grouped_record_query_result = _interopRequireDefault(require("./grouped_record_query_result"));
+
 var _linked_records_query_result = _interopRequireDefault(require("./linked_records_query_result"));
 
 var _view_metadata_query_result = _interopRequireDefault(require("./view_metadata_query_result"));
 
+var _session = _interopRequireDefault(require("./session"));
+
+var _cursor = _interopRequireDefault(require("./cursor"));
+
 // istanbul ignore file
 
 /** @ignore */

package/dist/cjs/models/mutations.js

@@ -47,6 +47,8 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
+var _airtable_interface = require("../types/airtable_interface");
+
 var _mutations = require("../types/mutations");
 
 var _private_utils = require("../private_utils");
@@ -590,6 +592,35 @@ function () {
             return;
           }
 
+        case _mutations.MutationTypes.UPDATE_VIEW_METADATA:
+          {
+            var _tableId5 = mutation.tableId,
+                viewId = mutation.viewId;
+            var runContext = this._airtableInterface.sdkInitData.runContext;
+
+            if (runContext.type !== _airtable_interface.BlockRunContextType.VIEW) {
+              throw (0, _error_utils.spawnError)('Setting view metadata is only valid for views');
+            }
+
+            if (runContext.viewId !== viewId || runContext.tableId !== _tableId5) {
+              throw (0, _error_utils.spawnError)('Custom views can only set view metadata on themselves');
+            }
+
+            var _table5 = this._base.getTableByIdIfExists(_tableId5);
+
+            if (!_table5) {
+              throw (0, _error_utils.spawnError)("Can't update metadata: No table with id %s exists", _tableId5);
+            }
+
+            var view = _table5.getViewByIdIfExists(viewId);
+
+            if (!view) {
+              throw (0, _error_utils.spawnError)("Can't update metadata: No view with id %s exists", viewId);
+            }
+
+            return;
+          }
+
         default:
           throw (0, _error_utils.spawnUnknownSwitchCaseError)('mutation type', mutation, 'type');
       }
@@ -639,19 +670,19 @@ function () {
 
         case _mutations.MutationTypes.DELETE_MULTIPLE_RECORDS:
           {
-            var _tableId5 = mutation.tableId,
+            var _tableId6 = mutation.tableId,
                 recordIds = mutation.recordIds;
 
-            var _recordStore2 = this._base.__getRecordStore(_tableId5);
+            var _recordStore2 = this._base.__getRecordStore(_tableId6);
 
             if (!_recordStore2.isRecordMetadataLoaded) {
               return [];
             }
 
             return [...recordIds.map(recordId => ({
-              path: ['tablesById', _tableId5, 'recordsById', recordId],
+              path: ['tablesById', _tableId6, 'recordsById', recordId],
               value: undefined
-            })), ...this._base.getTableById(_tableId5).views.flatMap(view => {
+            })), ...this._base.getTableById(_tableId6).views.flatMap(view => {
               var viewDataStore = _recordStore2.getViewDataStore(view.id);
 
               if (!viewDataStore.isDataLoaded) {
@@ -664,10 +695,10 @@ function () {
 
         case _mutations.MutationTypes.CREATE_MULTIPLE_RECORDS:
           {
-            var _tableId6 = mutation.tableId,
+            var _tableId7 = mutation.tableId,
                 _records2 = mutation.records;
 
-            var _recordStore3 = this._base.__getRecordStore(_tableId6);
+            var _recordStore3 = this._base.__getRecordStore(_tableId7);
 
             if (!_recordStore3.isRecordMetadataLoaded) {
               return [];
@@ -706,7 +737,7 @@ function () {
               }
 
               return {
-                path: ['tablesById', _tableId6, 'recordsById', record.id],
+                path: ['tablesById', _tableId7, 'recordsById', record.id],
                 value: {
                   id: record.id,
                   cellValuesByFieldId: filteredCellValuesByFieldId,
@@ -714,7 +745,7 @@ function () {
                   createdTime: new Date().toJSON()
                 }
               };
-            }), ...this._base.getTableById(_tableId6).views.flatMap(view => {
+            }), ...this._base.getTableById(_tableId7).views.flatMap(view => {
               var viewDataStore = _recordStore3.getViewDataStore(view.id);
 
               if (!viewDataStore.isDataLoaded) {
@@ -735,9 +766,10 @@ function () {
 
         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 or table mutations.
+            // No optimistic updates for field, view metadata, or table mutations.
             return [];
           }
         // The following branch is unreachable because this method's only

package/dist/cjs/models/record_query_result.js

@@ -21,6 +21,7 @@ require("core-js/modules/web.dom-collections.iterator");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.normalizeSortsOrGroups = normalizeSortsOrGroups;
 exports.default = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
@@ -65,6 +66,8 @@ var WatchableRecordQueryResultKeys = Object.freeze({
   recordIds: 'recordIds',
   cellValues: 'cellValues',
   recordColors: 'recordColors',
+  groups: 'groups',
+  groupLevels: 'groupLevels',
   isDataLoaded: 'isDataLoaded'
 });
 var WatchableCellValuesInFieldKeyPrefix = 'cellValuesInField:'; // The string case is to accommodate cellValuesInField:$FieldId.
@@ -79,6 +82,35 @@ var WatchableCellValuesInFieldKeyPrefix = 'cellValuesInField:'; // The string ca
  * - `cellValuesInField:{FIELD_ID}`
  */
 
+/**
+ * @internal
+ */
+function _normalizeSortOrGroup(table, sortOrGroup) {
+  var _sortOrGroup$directio;
+
+  var field = table.__getFieldMatching(sortOrGroup.field);
+
+  if (sortOrGroup.direction !== undefined && sortOrGroup.direction !== 'asc' && sortOrGroup.direction !== 'desc') {
+    throw (0, _error_utils.spawnError)('Invalid sort direction: %s', sortOrGroup.direction);
+  }
+
+  return {
+    fieldId: field.id,
+    direction: (_sortOrGroup$directio = sortOrGroup.direction) !== null && _sortOrGroup$directio !== void 0 ? _sortOrGroup$directio : 'asc'
+  };
+}
+/**
+ * @internal
+ */
+
+
+function normalizeSortsOrGroups(table, sortsOrGroups) {
+  if (sortsOrGroups === undefined || sortsOrGroups === null) {
+    return sortsOrGroups;
+  }
+
+  return sortsOrGroups.map(sortOrGroup => _normalizeSortOrGroup(table, sortOrGroup));
+}
 /**
  * A RecordQueryResult represents a set of records. It's a little bit like a one-off View in Airtable: it
  * contains a bunch of records, filtered to a useful subset of the records in the table. Those
@@ -127,6 +159,8 @@ var WatchableCellValuesInFieldKeyPrefix = 'cellValuesInField:'; // The string ca
  *
  * @docsPath models/query results/RecordQueryResult
  */
+
+
 var RecordQueryResult =
 /*#__PURE__*/
 function (_AbstractModelWithAsy) {
@@ -143,25 +177,16 @@ function (_AbstractModelWithAsy) {
   }, {
     key: "_shouldLoadDataForKey",
     value: function _shouldLoadDataForKey(key) {
-      return key === RecordQueryResult.WatchableKeys.records || key === RecordQueryResult.WatchableKeys.recordIds || key === RecordQueryResult.WatchableKeys.cellValues || key === RecordQueryResult.WatchableKeys.recordColors || key.startsWith(RecordQueryResult.WatchableCellValuesInFieldKeyPrefix);
+      return key === RecordQueryResult.WatchableKeys.records || key === RecordQueryResult.WatchableKeys.recordIds || key === RecordQueryResult.WatchableKeys.cellValues || key === RecordQueryResult.WatchableKeys.recordColors || key === RecordQueryResult.WatchableKeys.groups || key === RecordQueryResult.WatchableKeys.groupLevels || key.startsWith(RecordQueryResult.WatchableCellValuesInFieldKeyPrefix);
     }
     /** @internal */
 
   }, {
     key: "_normalizeOpts",
     value: function _normalizeOpts(table, recordStore, opts) {
-      var sorts = !opts.sorts ? null : opts.sorts.map(sort => {
-        var field = table.__getFieldMatching(sort.field);
-
-        if (sort.direction !== undefined && sort.direction !== 'asc' && sort.direction !== 'desc') {
-          throw (0, _error_utils.spawnError)('Invalid sort direction: %s', sort.direction);
-        }
+      var _normalizeSortsOrGrou;
 
-        return {
-          fieldId: field.id,
-          direction: sort.direction || 'asc'
-        };
-      });
+      var sorts = (_normalizeSortsOrGrou = normalizeSortsOrGroups(table, opts.sorts)) !== null && _normalizeSortsOrGrou !== void 0 ? _normalizeSortsOrGrou : null;
       var fieldIdsOrNullIfAllFields = null;
 
       if (opts.fields) {

package/dist/cjs/models/session.js

@@ -64,12 +64,16 @@ var WatchableSessionKeys = Object.freeze({
  *
  * @example
  * ```js
- * import {session} from '@airtable/blocks';
+ * import {useSession} from '@airtable/blocks/ui';
  *
- * if (session.currentUser !== null) {
- *     console.log("The current user's name is", session.currentUser.name);
- * } else {
- *     console.log('This app is being viewed in a public share');
+ * function Username() {
+ *     const session = useSession();
+ *
+ *     if (session.currentUser !== null) {
+ *         return <span>The current user's name is {session.currentUser.name}</span>;
+ *     } else {
+ *         return <span>This app is being viewed in a public share</span>;
+ *     }
  * }
  * ```
  * @docsPath models/Session
@@ -132,11 +136,21 @@ function (_AbstractModel) {
      *
      * @example
      * ```js
-     * import {session} from '@airtable/blocks';
+     * import {useSession} from '@airtable/blocks/ui';
+     *
+     * function UpdateButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForUpdateRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
      *
-     * const updateRecordsCheckResult = session.checkPermissionsForUpdateRecords();
-     * if (!updateRecordsCheckResult.hasPermission) {
-     *     alert(updateRecordsCheckResult.reasonDisplayString);
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Update
+     *         </button>
+     *     </div>;
      * }
      */
     value: function checkPermissionsForUpdateRecords() {
@@ -166,11 +180,21 @@ function (_AbstractModel) {
      *
      * @example
      * ```js
-     * import {session} from '@airtable/blocks';
+     * import {useSession} from '@airtable/blocks/ui';
      *
-     * const createRecordsCheckResult = session.checkPermissionsForCreateRecords();
-     * if (!createRecordsCheckResult.hasPermission) {
-     *     alert(createRecordsCheckResult.reasonDisplayString);
+     * function CreateButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForCreateRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
+     *
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Create
+     *         </button>
+     *     </div>;
      * }
      */
 
@@ -203,12 +227,21 @@ function (_AbstractModel) {
      *
      * @example
      * ```js
-     * import {session} from '@airtable/blocks';
+     * import {useSession} from '@airtable/blocks/ui';
      *
-     * const deleteRecordsCheckResult = session.checkPermissionsForDeleteRecords();
-     * if (!deleteRecordsCheckResult.hasPermission) {
-     *     alert(deleteRecordsCheckResult.reasonDisplayString);
-     * }
+     * function DeleteButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForDeleteRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
+     *
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Delete
+     *         </button>
+     *     </div>;
      */
 
   }, {
@@ -355,11 +388,20 @@ function (_AbstractModel) {
      *
      * @example
      * ```js
-     * import {session} from '@airtable/blocks';
-     * if (session.currentUser) {
-     *     console.log(session.currentUser.id);
-     *     console.log(session.currentUser.email);
-     *     console.log(session.currentUser.name);
+     * import {useSession} from '@airtable/blocks/ui';
+     *
+     * function CurrentUser() {
+     *     const session = useSession();
+     *
+     *     if (!session.currentUser) {
+     *         return <div>This app is being used in a public share.</div>;
+     *     }
+     *
+     *     return <ul>
+     *         <li>ID: {session.currentUser.id}</li>
+     *         <li>E-mail: {session.currentUser.email}</li>
+     *         <li>Name: {session.currentUser.name}</li>
+     *     </ul>;
      * }
      * ```
      */