@airtable/blocks 0.0.0-experimental-e5ab33b68-20250905 → 0.0.0-experimental-e625869e5-20251002

package/dist/{cjs → esm}/interface/ui/use_custom_properties.js

@@ -1,16 +1,9 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useCustomProperties = useCustomProperties;
-var _react = require("react");
-var _sdk_context = require("../../shared/ui/sdk_context");
-var _airtable_interface = require("../types/airtable_interface");
-var _use_global_config = _interopRequireDefault(require("../../shared/ui/use_global_config"));
-var _error_utils = require("../../shared/error_utils");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /** @module @airtable/blocks/interface/ui: useCustomProperties */ /** */
+import { useState, useEffect } from 'react';
+import { useSdk } from '../../shared/ui/sdk_context';
+import { BlockInstallationPageElementCustomPropertyTypeForAirtableInterface } from '../types/airtable_interface';
+import useGlobalConfig from '../../shared/ui/use_global_config';
+import { spawnUnknownSwitchCaseError } from '../../shared/error_utils';
 
 // This is the public-facing API for custom properties that blocks will pass.
 // It differs slightly from BlockInstallationPageElementCustomPropertyForAirtableInterface
@@ -36,6 +29,10 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  *       possibleValues?: Array<Field>; // If not provided, all visible fields in the table will be shown in the dropdown.
  *       defaultValue?: Field;
  *     }
+ *   | {
+ *       type: 'table';
+ *       defaultValue?: Table;
+ *     }
  * );
  * ```
  */
@@ -75,16 +72,16 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * @docsPath UI/hooks/useCustomProperties
  * @hook
  */
-function useCustomProperties(getCustomProperties) {
-  const sdk = (0, _sdk_context.useSdk)();
-  const [customProperties, setCustomProperties] = (0, _react.useState)(() => {
+export function useCustomProperties(getCustomProperties) {
+  const sdk = useSdk();
+  const [customProperties, setCustomProperties] = useState(() => {
     return getCustomProperties(sdk.base);
   });
-  const globalConfig = (0, _use_global_config.default)();
-  const [errorState, setErrorState] = (0, _react.useState)(null);
+  const globalConfig = useGlobalConfig();
+  const [errorState, setErrorState] = useState(null);
 
   // Create subscription to update custom properties when schema changes
-  (0, _react.useEffect)(() => {
+  useEffect(() => {
     const base = sdk.base;
     const onSchemaChange = base => {
       const customProperties = getCustomProperties(base);
@@ -98,7 +95,7 @@ function useCustomProperties(getCustomProperties) {
 
   // When custom properties change, send a message to hyperbase to update the properties panel
   const hasError = errorState !== null;
-  (0, _react.useEffect)(() => {
+  useEffect(() => {
     if (hasError) {
       return;
     }
@@ -123,21 +120,21 @@ function convertBlockPageElementCustomPropertyToBlockInstallationPageElementCust
       return {
         key: property.key,
         label: property.label,
-        type: _airtable_interface.BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.BOOLEAN,
+        type: BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.BOOLEAN,
         defaultValue: property.defaultValue
       };
     case 'string':
       return {
         key: property.key,
         label: property.label,
-        type: _airtable_interface.BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.STRING,
+        type: BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.STRING,
         defaultValue: property.defaultValue
       };
     case 'enum':
       return {
         key: property.key,
         label: property.label,
-        type: _airtable_interface.BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.ENUM,
+        type: BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.ENUM,
         possibleValues: property.possibleValues,
         defaultValue: property.defaultValue
       };
@@ -145,13 +142,20 @@ function convertBlockPageElementCustomPropertyToBlockInstallationPageElementCust
       return {
         key: property.key,
         label: property.label,
-        type: _airtable_interface.BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.FIELD_ID,
+        type: BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.FIELD_ID,
         tableId: property.table.id,
         possibleValues: property.possibleValues?.map(field => field.id),
         defaultValue: property.defaultValue?.id
       };
+    case 'table':
+      return {
+        key: property.key,
+        label: property.label,
+        type: BlockInstallationPageElementCustomPropertyTypeForAirtableInterface.TABLE_ID,
+        defaultValue: property.defaultValue?.id
+      };
     default:
-      throw (0, _error_utils.spawnUnknownSwitchCaseError)('property type', property, 'type');
+      throw spawnUnknownSwitchCaseError('property type', property, 'type');
   }
 }
 
@@ -161,29 +165,47 @@ function getCustomPropertyValue(base, globalConfig, property) {
   const rawValue = globalConfig.get(property.key) ?? defaultValue;
   switch (property.type) {
     case 'boolean':
-      if (typeof rawValue === 'boolean') {
-        return rawValue;
+      {
+        if (typeof rawValue === 'boolean') {
+          return rawValue;
+        }
+        return defaultValue;
       }
-      return defaultValue;
     case 'string':
-      if (typeof rawValue === 'string') {
-        return rawValue;
+      {
+        if (typeof rawValue === 'string') {
+          return rawValue;
+        }
+        return defaultValue;
       }
-      return defaultValue;
     case 'enum':
-      if (typeof rawValue === 'string' && property.possibleValues.some(value => value.value === rawValue)) {
-        return rawValue;
+      {
+        if (typeof rawValue === 'string' && property.possibleValues.some(value => value.value === rawValue)) {
+          return rawValue;
+        }
+        return defaultValue;
       }
-      return defaultValue;
     case 'field':
-      if (typeof rawValue === 'string' && property.table === base.getTableById(property.table.id)) {
-        const fieldModel = property.table.fields.find(field => field.id === rawValue);
-        if (fieldModel && (!property.possibleValues || property.possibleValues.includes(fieldModel))) {
-          return fieldModel;
+      {
+        if (typeof rawValue === 'string' && property.table === base.getTableById(property.table.id)) {
+          const fieldModel = property.table.fields.find(field => field.id === rawValue);
+          if (fieldModel && (!property.possibleValues || property.possibleValues.includes(fieldModel))) {
+            return fieldModel;
+          }
+        }
+        return defaultValue;
+      }
+    case 'table':
+      {
+        if (typeof rawValue === 'string') {
+          const tableIfExists = base.getTableByIdIfExists(rawValue);
+          if (tableIfExists) {
+            return tableIfExists;
+          }
         }
+        return defaultValue;
       }
-      return defaultValue;
     default:
-      throw (0, _error_utils.spawnUnknownSwitchCaseError)('property type', property, 'type');
+      throw spawnUnknownSwitchCaseError('property type', property, 'type');
   }
 }

package/dist/{cjs → esm}/interface/ui/use_records.js

@@ -1,14 +1,7 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useRecords = useRecords;
-var _sdk_context = require("../../shared/ui/sdk_context");
-var _use_watchable = _interopRequireDefault(require("../../shared/ui/use_watchable"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /** @module @airtable/blocks/interface/ui: useRecords */ /** */
 
+import { useSdk } from '../../shared/ui/sdk_context';
+import useWatchable from '../../shared/ui/use_watchable';
 /**
  * A hook for working with all of the records (including cell values) in a
  * particular table. Automatically handles loading data and updating
@@ -45,12 +38,12 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * @docsPath UI/hooks/useRecords
  * @hook
  */
-function useRecords(table) {
+export function useRecords(table) {
   const {
     base
-  } = (0, _sdk_context.useSdk)();
+  } = useSdk();
   const recordStore = base.__getRecordStore(table.id);
-  (0, _use_watchable.default)(recordStore, ['records', 'recordIds', 'cellValues', 'recordOrder']);
+  useWatchable(recordStore, ['records', 'recordIds', 'cellValues', 'recordOrder']);
   const records = recordStore.records;
   return records;
 }

package/dist/{cjs → esm}/interface/ui/use_run_info.js

@@ -1,12 +1,7 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useRunInfo = useRunInfo;
-var _sdk_context = require("../../shared/ui/sdk_context");
 /** @module @airtable/blocks/interface/ui: useRunInfo */ /** */
 
+import { useSdk } from '../../shared/ui/sdk_context';
+
 /**
  * A hook for getting information about the current run context. This can be
  * useful if you'd like to display some configuration options when the page
@@ -32,8 +27,8 @@ var _sdk_context = require("../../shared/ui/sdk_context");
  * @docsPath UI/hooks/useRunInfo
  * @hook
  */
-function useRunInfo() {
-  const sdk = (0, _sdk_context.useSdk)();
+export function useRunInfo() {
+  const sdk = useSdk();
   const runContext = sdk.getBlockRunContext();
   return {
     isDevelopmentMode: sdk.runInfo.isDevelopmentMode,

package/dist/{cjs → esm}/interface/ui/use_session.js

@@ -1,13 +1,6 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useSession = useSession;
-var _use_session = _interopRequireDefault(require("../../shared/ui/use_session"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /** @module @airtable/blocks/ui: useSession */ /** */
 
+import useSessionInternal from '../../shared/ui/use_session';
 /**
  * A hook for connecting a React component to the current session. This returns a {@link Session}
  * instance and will re-render your component whenever the session changes (e.g. when the current user's
@@ -35,6 +28,6 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * @docsPath UI/hooks/useSession
  * @hook
  */
-function useSession() {
-  return (0, _use_session.default)();
+export function useSession() {
+  return useSessionInternal();
 }

package/dist/esm/sdk_mode.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/shared/color_utils.js

@@ -0,0 +1,50 @@
+/** @module @airtable/blocks/ui: colorUtils */ /** */
+import { getEnumValueIfExists, has } from './private_utils';
+import Colors, { rgbTuplesByColor } from './colors';
+
+/** A red/green/blue color object. Each property is a number from 0 to 255. */
+
+/**
+ * Utilities for working with {@link Color} names from the {@link colors} enum.
+ *
+ * @docsPath UI/utils/colorUtils
+ */
+
+const colorUtils = {
+  getHexForColor: colorString => {
+    const color = getEnumValueIfExists(Colors, colorString);
+    if (!color) {
+      return null;
+    }
+    const rgbTuple = rgbTuplesByColor[color];
+    const hexNumber = rgbTuple[0] << 16 | rgbTuple[1] << 8 | rgbTuple[2];
+    return `#${hexNumber.toString(16).padStart(6, '0')}`;
+  },
+  getRgbForColor: colorString => {
+    const color = getEnumValueIfExists(Colors, colorString);
+    if (!color) {
+      return null;
+    }
+    const rgbTuple = rgbTuplesByColor[color];
+    return {
+      r: rgbTuple[0],
+      g: rgbTuple[1],
+      b: rgbTuple[2]
+    };
+  },
+  shouldUseLightTextOnColor: colorString => {
+    if (!has(rgbTuplesByColor, colorString)) {
+      // Don't have a color for this. Let's just return false as a default
+      // instead of throwing.
+      return false;
+    }
+
+    // Light1 and Light2 colors use dark text.
+    // Bright, Dark1 and no suffix colors use light text.
+    // NOTE: use shouldUseDarkText instead of shouldUseLightText just to make
+    // checking the suffix easier, since no suffix uses light text.
+    const shouldUseDarkText = colorString.endsWith('Light1') || colorString.endsWith('Light2');
+    return !shouldUseDarkText;
+  }
+};
+export default colorUtils;

package/dist/{cjs → esm}/shared/colors.js

@@ -1,9 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.rgbTuplesByColor = exports.default = void 0;
 /** @module @airtable/blocks/ui: colors */ /** */
 
 /**
@@ -125,12 +119,14 @@ const Colors = {
   /** @docsPath UI/utils/Colors */
   YELLOW: 'yellow'
 };
-var _default = exports.default = Colors;
+export default Colors;
+
 /**
  * A color name from the list of {@link Colors}.
  */
+
 /** @hidden */
-const rgbTuplesByColor = exports.rgbTuplesByColor = {
+export const rgbTuplesByColor = {
   [Colors.BLUE_BRIGHT]: [45, 127, 249],
   [Colors.BLUE_DARK_1]: [39, 80, 174],
   [Colors.BLUE_LIGHT_1]: [156, 199, 255],

package/dist/{cjs → esm}/shared/error_utils.js

@@ -1,13 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.invariant = invariant;
-exports.logErrorToSentry = logErrorToSentry;
-exports.spawnAbstractMethodError = spawnAbstractMethodError;
-exports.spawnError = spawnError;
-exports.spawnUnknownSwitchCaseError = spawnUnknownSwitchCaseError;
 // If errorOriginFn is specified, all frames above and including the call to errorOriginFn
 // will be omitted from the stack trace.
 /**
@@ -42,7 +32,7 @@ function spawnErrorWithOriginOmittedFromStackTrace(errorMessageFormat, errorMess
 /**
  * @hidden
  */
-function spawnError(errorMessageFormat) {
+export function spawnError(errorMessageFormat) {
   for (var _len = arguments.length, errorMessageArgs = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
     errorMessageArgs[_key - 1] = arguments[_key];
   }
@@ -55,7 +45,7 @@ function spawnError(errorMessageFormat) {
  *
  * @hidden
  */
-function logErrorToSentry(errorMessage, metadata) {
+export function logErrorToSentry(errorMessage, metadata) {
   // See this comment for how to log via Sentry: https://github.com/Hyperbase/hyperbase/blob/2c5438ecaddcb9fa196e027e40df5e0c68c90989/client/run_block_frame.tsx#L333
   const blocksErrorReporter = window.blocksErrorReporter;
   if (blocksErrorReporter?.reportWarning) {
@@ -68,7 +58,7 @@ function logErrorToSentry(errorMessage, metadata) {
  *
  * @hidden
  */
-function invariant(condition, errorMessageFormat) {
+export function invariant(condition, errorMessageFormat) {
   if (!condition) {
     for (var _len2 = arguments.length, errorMessageArgs = new Array(_len2 > 2 ? _len2 - 2 : 0), _key2 = 2; _key2 < _len2; _key2++) {
       errorMessageArgs[_key2 - 2] = arguments[_key2];
@@ -80,7 +70,7 @@ function invariant(condition, errorMessageFormat) {
 /**
  * @internal
  */
-function spawnUnknownSwitchCaseError(valueDescription, providedValue, key) {
+export function spawnUnknownSwitchCaseError(valueDescription, providedValue, key) {
   const providedValueKey = providedValue[key];
   const providedValueKeyString = providedValueKey !== null && providedValueKey !== undefined ? providedValueKey : 'null';
   return spawnErrorWithOriginOmittedFromStackTrace('Unknown value %s for %s', [providedValueKeyString, valueDescription], spawnUnknownSwitchCaseError);
@@ -89,6 +79,6 @@ function spawnUnknownSwitchCaseError(valueDescription, providedValue, key) {
 /**
  * @internal
  */
-function spawnAbstractMethodError() {
+export function spawnAbstractMethodError() {
   return spawnErrorWithOriginOmittedFromStackTrace('Abstract method', undefined, spawnAbstractMethodError);
 }

package/dist/esm/shared/event_tracker.js

@@ -0,0 +1,20 @@
+import getAirtableInterface from '../injected/airtable_interface';
+/** @hidden */
+export function trackEvent(eventSchemaName) {
+  let eventData = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  getAirtableInterface().trackEvent(eventSchemaName, eventData);
+}
+
+/**
+ * Used for logging blockInstallation.performRecordAction event
+ * Mirrored from hyperbase block_installation_record_action_status.tsx
+ *
+ * @hidden
+ * */
+export let RecordActionStatus = /*#__PURE__*/function (RecordActionStatus) {
+  RecordActionStatus["SUCCESS"] = "SUCCESS";
+  RecordActionStatus["IGNORED"] = "IGNORED";
+  RecordActionStatus["SETTINGS_INVALID"] = "SETTINGS_INVALID";
+  RecordActionStatus["TABLE_MISMATCH"] = "TABLE_MISMATCH";
+  return RecordActionStatus;
+}({});

package/dist/{cjs → esm}/shared/global_config.js

@@ -1,16 +1,10 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _watchable = _interopRequireDefault(require("./watchable"));
-var _error_utils = require("./error_utils");
-var _mutations_core = require("./types/mutations_core");
-var _private_utils = require("./private_utils");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /** @module @airtable/blocks: globalConfig */ /** */
 
+import Watchable from './watchable';
+import { spawnError } from './error_utils';
+import { MutationTypesCore } from './types/mutations_core';
+import { getValueAtOwnPath } from './private_utils';
+
 /**
  * You can watch any top-level key in global config. Use '*' to watch every change.
  */
@@ -40,7 +34,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  *
  * @docsPath models/GlobalConfig
  */
-class GlobalConfig extends _watchable.default {
+class GlobalConfig extends Watchable {
   /** @internal */
   static _className = 'GlobalConfig';
   /** @internal */
@@ -123,9 +117,9 @@ class GlobalConfig extends _watchable.default {
     const path = this._formatKeyAsPath(key);
     const pathValidationResult = this._validatePath(path, this._kvStore);
     if (!pathValidationResult.isValid) {
-      throw (0, _error_utils.spawnError)('Invalid globalConfig path: %s', pathValidationResult.reason);
+      throw spawnError('Invalid globalConfig path: %s', pathValidationResult.reason);
     }
-    const value = (0, _private_utils.getValueAtOwnPath)(this._kvStore, path);
+    const value = getValueAtOwnPath(this._kvStore, path);
     // value is returned as `unknown` from getValueAtOwnPath, but we know it must be a `GlobalConfigValue | void`
     return value;
   }
@@ -269,7 +263,7 @@ class GlobalConfig extends _watchable.default {
    */
   checkPermissionsForSetPaths(updates) {
     return this._sdk.__mutations.checkPermissionsForMutation({
-      type: _mutations_core.MutationTypesCore.SET_MULTIPLE_GLOBAL_CONFIG_PATHS,
+      type: MutationTypesCore.SET_MULTIPLE_GLOBAL_CONFIG_PATHS,
       updates: updates ? updates.map(_ref => {
         let {
           path,
@@ -357,16 +351,16 @@ class GlobalConfig extends _watchable.default {
     // We check here, instead of deeper (e.g. on the liveapp side) so the user
     // gets a more useful error stack trace.
     if (!this.hasPermissionToSetPaths(updates)) {
-      throw (0, _error_utils.spawnError)('Your permission level does not allow setting globalConfig values');
+      throw spawnError('Your permission level does not allow setting globalConfig values');
     }
     for (const update of updates) {
       const pathValidation = this._validatePath(update.path, this._kvStore);
       if (!pathValidation.isValid) {
-        throw (0, _error_utils.spawnError)('Invalid globalConfig path: %s', pathValidation.reason);
+        throw spawnError('Invalid globalConfig path: %s', pathValidation.reason);
       }
     }
     await this._sdk.__mutations.applyMutationAsync({
-      type: _mutations_core.MutationTypesCore.SET_MULTIPLE_GLOBAL_CONFIG_PATHS,
+      type: MutationTypesCore.SET_MULTIPLE_GLOBAL_CONFIG_PATHS,
       updates
     });
   }
@@ -396,4 +390,4 @@ class GlobalConfig extends _watchable.default {
     }
   }
 }
-var _default = exports.default = GlobalConfig;
+export default GlobalConfig;

package/dist/{cjs → esm}/shared/models/abstract_model.js

@@ -1,20 +1,12 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _error_utils = require("../error_utils");
-var _watchable = _interopRequireDefault(require("../watchable"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /** @module @airtable/blocks/models: Abstract models */ /** */
-
+import { invariant, spawnError } from '../error_utils';
+import Watchable from '../watchable';
 /**
  * Abstract superclass for all models. You won't use this class directly.
  *
  * @docsPath models/advanced/AbstractModel
  */
-class AbstractModel extends _watchable.default {
+class AbstractModel extends Watchable {
   /** @internal */
   static _className = 'AbstractModel';
   /**
@@ -41,7 +33,7 @@ class AbstractModel extends _watchable.default {
    */
   constructor(sdk, modelId) {
     super();
-    (0, _error_utils.invariant)(typeof modelId === 'string', '%s id should be a string', this.constructor._className);
+    invariant(typeof modelId === 'string', '%s id should be a string', this.constructor._className);
     this._sdk = sdk;
     this._baseData = sdk.__airtableInterface.sdkInitData.baseData;
     this._id = modelId;
@@ -82,7 +74,7 @@ class AbstractModel extends _watchable.default {
    * @internal
    */
   _spawnErrorForDeletion() {
-    return (0, _error_utils.spawnError)('%s has been deleted', this.constructor._className);
+    return spawnError('%s has been deleted', this.constructor._className);
   }
   /**
    * A string representation of the model for use in debugging.
@@ -91,4 +83,4 @@ class AbstractModel extends _watchable.default {
     return `[${this.constructor._className} ${this.id}]`;
   }
 }
-var _default = exports.default = AbstractModel;
+export default AbstractModel;