@deephaven/jsapi-bootstrap

@deephaven/jsapi-bootstrap

This is a library to bootstrap load the JS API. It provides functionality to load the API and set it in a context object, or to set it globally to retain legacy behaviour. Will display an error if unable to load the API.

Install

npm install --save @deephaven/jsapi-bootstrap

Usage

Using Context

import { ApiBootstrap, useApi } from '@deephaven/jsapi-bootstrap';

function MyComponent() {
  const api = useApi();

  ...
}

<ApiBootstrap apiUrl={API_URL}>
  <MyComponent />
</ApiBootstrap>;

Using API globally (legacy behaviour)

If you're using the JSAPI shim or relying on the API to be set globally, you'll need to lazily load your component first so the API is set before imports attempt to use it.

// App.tsx
import { ApiBootstrap } from '@deephaven/jsapi-bootstrap';

const MyComponent = React.lazy(() => import('./MyComponent'));

<ApiBootstrap apiUrl={API_URL} setGlobally>
    <Suspense fallback={<div>Loading...</div>}>
      <MyComponent />
    </Suspense>
</ApiBootstrap>;

// MyComponent.tsx
import dh from '@deephaven/jsapi-shim';
function MyComponent() {
  const client = new dh.CoreClient(...);

  ...
}

Changelog

0.39.0 (2023-05-15)

Bug Fixes

• add word-break to long column names in column tooltip (#1290) (02215b6), closes #1283
• DH-14630: useDebouncedViewportSearch: memoization bug (#1273) (be82b14), closes #1272
• Select distinct throwing for tables with multiple columns (#1286) (4b40e4b), closes #1275

Features

• Table rendering support for databars (#1212) (a17cc0e), closes #1151
• add uncaught rejections to support logs (#1293) (29ed459), closes #1253
• Added new icons and added composition example to styleguide (#1294) (97c7ead)
• De-globalize JSAPI in Chart package (#1258) (87fa2ef)
• De-globalize JSAPI in Console package (#1292) (3f12dd3)
• De-globalize JSAPI in IrisGrid package (#1262) (588cb8f)
• De-globalize utils, formatters, linker (#1278) (cb0e9ba)
• DH-14630 - ACL Editor Hooks (#1257) (e0a2a36), closes #1260
• remove click handler setting onTabContentFocusIn (#1263) (7d56f97)
• Update @vscode/codicons to v0.0.33 (#1259) (1b29af1)
• useTableUtils hook (#1281) (ce1fe2c), closes #1280

Reverts

• Revert "feat: Table rendering support for databars (#1212)" (#1296) (a80c6fc)

BREAKING CHANGES

• • Components IrisGrid, Chart, ChartBuilder, AdvancedFilterCreator, GotoRow, IrisGridModelUpdater, TableCSVExporter get the JSAPI reference from the model prop. dh prop removed.

• makeApi props in IrisGridPanel and ChartPanel removed.
• Components Console, ConsoleMenu, ConsoleStatusBar now require the JSAPI instance in the dh prop.
• ConsoleUtils: static methods isTableType, isWidgetType, isOpenableType, isFigureType, isPandas require JSAPI instance passed in the first argument.
• SessionUtils: static methods createSessionWrapper, loadSessionWrapper require JSAPI instance passed in the first argument.
• Class IrisGridModel requires JSAPI instance passed in the constructor args.
• Components DashboardLayout, ObjectIcon has to be wrapped in ApiContext.Provider passing the JSAPI instance.

• • Class Formatter requires the JSAPI instance as the first argument.

• Classes DateTimeColumnFormatter, DecimalColumnFormatter, IntegerColumnFormatter, TableColumnFormatter: static method isValid and constructor require the JSAPI instance in the first argument.
• Component Chart requires the JSAPI instance passed in the new prop dh.
• WidgetUtils: methods createChartModel, createGridModel methods require the JSAPI instance passed in the first argument.
• Components DateTimeOptions, TableInput, useViewportData have to be wrapped in ApiContext.Provider passing the JSAPI instance.
• SettingsUtils: methods isValidFormat and isFormatRuleValidForSave require the JSAPI instance passed in the first argument.
• SessionUtils: methods createConnection, createCoreClient require the JSAPI instance passed in the first argument.
• TableUtils static methods applyCustomColumns, applyFilter, applyNeverFilter, applySort converted to instance methods.
• Components DropdownFilterPanel, Linker now get the JSAPI instance from redux store.
• DecimalFormatContextMenu.getOptions, IntegerFormatContextMenu.getOptions now require the JSAPI instance in the first argument.

• • DateUtils static methods makeDateWrapper, getNextDate , parseDateRange now require the JSAPI object as the first argument.

• IrisGridUtils static methods dehydrateIrisGridState, hydrateIrisGridState, hydrateQuickFilters, dehydrateAdvancedFilters, hydrateAdvancedFilters, dehydrateAdvancedFilterOptions, hydrateAdvancedFilterOptions, dehydratePendingDataMap, hydratePendingDataMap, dehydrateValue, hydrateValue, dehydrateDateTime, hydrateDateTime, hydrateLong, hydrateSort, applyTableSettings, getFiltersFromInputFilters, rangeSetFromRanges converted to instance methods. Consumers now need to create an IrisGridUtils instance and pass the JSAPI object to the constructor.
• TableUtils static methods makeQuickFilter, makeQuickFilterFromComponent, makeQuickNumberFilter, makeQuickTextFilter, makeQuickBooleanFilter, makeQuickDateFilter, makeQuickDateFilterWithOperation, makeQuickCharFilter, makeAdvancedFilter, makeAdvancedValueFilter, makeFilterValue, makeFilterRawValue, makeValue, makeSelectValueFilter converted to instance methods. Consumers now need to create a TableUtils instance and pass the JSAPI object to the constructor.
• IrisGridTableModel, IrisGridTableModelTemplate, IrisGridProxyModel constructors require the JSAPI object in the first argument.
• IrisGridTestUtils.makeModel, IrisGridModelFactory.makeModel now require the JSAPI object in the first argument.
• IrisGridContextMenuHandler constructor requires the JSAPI object in the second argument.
• IrisGridPanel requires a new makeApi prop, a function that resolves with the JSAPI instance.
• CrossColumnSearch.createSearchFilter requires the JSAPI object argument.
• Components AdvancedFilterCreatorSelectValue, AdvancedFilterCreatorSelectValueList, ChartBuilder, GotoRow, IrisGrid, IrisGridModelUpdater, IrisGridPartitionSelector, PartitionSelectorSearch, TableCSVExporter, TableSaver, TreeTableViewportUpdater, RowFormatEditor, ColumnFormatEditor, ConditionEditor now require the JSAPI object passed in the new prop dh.
• Components AdvancedFilterCreator, AdvancedFilterCreatorFilterItem require the TableUtils instance pass in the new prop tableUtils.
• ConditionalFormattingUtils static methods getFormatColumns, isDateConditionValid require the JSAPI object in the first argument.
• ConditionalFormattingAPIUtils static method makeRowFormatColumn requires the JSAPI object in the first argument.

• • ChartUtils class now needs to be instantiated with a JSAPI object, most of the methods converted from static to instance methods.

• All ChartModelFactory methods require JSAPI object as the first argument.
• FigureChartModel constructor requires JSAPI object as the first argument.

• generateEmptyKeyedItemsRange previously required a single count arg, but now requires a start and end index
• vsCircleLargeOutline icon renamed to vsCircleLarge