@xh/hoist 57.0.0 → 57.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/build/types/admin/AppComponent.d.ts +4 -0
- package/build/types/admin/AppModel.d.ts +13 -0
- package/build/types/admin/columns/Core.d.ts +6 -0
- package/build/types/admin/columns/Rest.d.ts +5 -0
- package/build/types/admin/columns/Tracking.d.ts +18 -0
- package/build/types/admin/columns/User.d.ts +9 -0
- package/build/types/admin/columns/UserData.d.ts +7 -0
- package/build/types/admin/columns/index.d.ts +5 -0
- package/build/types/admin/differ/Differ.d.ts +2 -0
- package/build/types/admin/differ/DifferDetail.d.ts +3 -0
- package/build/types/admin/differ/DifferDetailModel.d.ts +17 -0
- package/build/types/admin/differ/DifferModel.d.ts +43 -0
- package/build/types/admin/regroup/RegroupDialog.d.ts +2 -0
- package/build/types/admin/regroup/RegroupDialogModel.d.ts +20 -0
- package/build/types/admin/tabs/activity/ActivityTab.d.ts +2 -0
- package/build/types/admin/tabs/activity/aggregators/RangeAggregator.d.ts +8 -0
- package/build/types/admin/tabs/activity/clienterrors/ClientErrorDetail.d.ts +2 -0
- package/build/types/admin/tabs/activity/clienterrors/ClientErrorsModel.d.ts +30 -0
- package/build/types/admin/tabs/activity/clienterrors/ClientErrorsPanel.d.ts +2 -0
- package/build/types/admin/tabs/activity/feedback/FeedbackPanel.d.ts +1 -0
- package/build/types/admin/tabs/activity/tracking/ActivityTrackingModel.d.ts +50 -0
- package/build/types/admin/tabs/activity/tracking/ActivityTrackingPanel.d.ts +2 -0
- package/build/types/admin/tabs/activity/tracking/charts/ChartsModel.d.ts +32 -0
- package/build/types/admin/tabs/activity/tracking/charts/ChartsPanel.d.ts +2 -0
- package/build/types/admin/tabs/activity/tracking/detail/ActivityDetailModel.d.ts +15 -0
- package/build/types/admin/tabs/activity/tracking/detail/ActivityDetailView.d.ts +2 -0
- package/build/types/admin/tabs/general/GeneralTab.d.ts +1 -0
- package/build/types/admin/tabs/general/about/AboutPanel.d.ts +2 -0
- package/build/types/admin/tabs/general/alertBanner/AlertBannerModel.d.ts +24 -0
- package/build/types/admin/tabs/general/alertBanner/AlertBannerPanel.d.ts +3 -0
- package/build/types/admin/tabs/general/config/ConfigPanel.d.ts +2 -0
- package/build/types/admin/tabs/general/config/ConfigPanelModel.d.ts +19 -0
- package/build/types/admin/tabs/general/users/UserModel.d.ts +12 -0
- package/build/types/admin/tabs/general/users/UserPanel.d.ts +2 -0
- package/build/types/admin/tabs/monitor/MonitorColumns.d.ts +15 -0
- package/build/types/admin/tabs/monitor/MonitorEditorPanel.d.ts +1 -0
- package/build/types/admin/tabs/monitor/MonitorResultsModel.d.ts +17 -0
- package/build/types/admin/tabs/monitor/MonitorResultsPanel.d.ts +3 -0
- package/build/types/admin/tabs/monitor/MonitorResultsToolbar.d.ts +2 -0
- package/build/types/admin/tabs/monitor/MonitorTab.d.ts +1 -0
- package/build/types/admin/tabs/monitor/Tile.d.ts +2 -0
- package/build/types/admin/tabs/server/ServerTab.d.ts +1 -0
- package/build/types/admin/tabs/server/ehcache/EhCacheModel.d.ts +10 -0
- package/build/types/admin/tabs/server/ehcache/EhCachePanel.d.ts +2 -0
- package/build/types/admin/tabs/server/environment/ServerEnvModel.d.ts +11 -0
- package/build/types/admin/tabs/server/environment/ServerEnvPanel.d.ts +2 -0
- package/build/types/admin/tabs/server/logLevel/LogLevelColumns.d.ts +5 -0
- package/build/types/admin/tabs/server/logLevel/LogLevelPanel.d.ts +1 -0
- package/build/types/admin/tabs/server/logViewer/LogDisplay.d.ts +6 -0
- package/build/types/admin/tabs/server/logViewer/LogDisplayModel.d.ts +29 -0
- package/build/types/admin/tabs/server/logViewer/LogViewer.d.ts +3 -0
- package/build/types/admin/tabs/server/logViewer/LogViewerModel.d.ts +23 -0
- package/build/types/admin/tabs/server/memory/MemoryMonitorModel.d.ts +15 -0
- package/build/types/admin/tabs/server/memory/MemoryMonitorPanel.d.ts +2 -0
- package/build/types/admin/tabs/server/services/ServiceModel.d.ts +8 -0
- package/build/types/admin/tabs/server/services/ServicePanel.d.ts +2 -0
- package/build/types/admin/tabs/server/websocket/WebSocketColumns.d.ts +8 -0
- package/build/types/admin/tabs/server/websocket/WebSocketModel.d.ts +12 -0
- package/build/types/admin/tabs/server/websocket/WebSocketPanel.d.ts +2 -0
- package/build/types/admin/tabs/userData/JsonBlobColumns.d.ts +9 -0
- package/build/types/admin/tabs/userData/JsonBlobModel.d.ts +15 -0
- package/build/types/admin/tabs/userData/JsonBlobPanel.d.ts +2 -0
- package/build/types/admin/tabs/userData/PreferenceModel.d.ts +16 -0
- package/build/types/admin/tabs/userData/PreferencePanel.d.ts +2 -0
- package/build/types/admin/tabs/userData/UserDataTab.d.ts +1 -0
- package/build/types/admin/tabs/userData/UserPreferencePanel.d.ts +1 -0
- package/build/types/appcontainer/AboutDialogModel.d.ts +15 -0
- package/build/types/appcontainer/AppContainerModel.d.ts +43 -0
- package/build/types/appcontainer/AppOption.d.ts +23 -0
- package/build/types/appcontainer/BannerModel.d.ts +26 -0
- package/build/types/appcontainer/BannerSourceModel.d.ts +15 -0
- package/build/types/appcontainer/ChangelogDialogModel.d.ts +9 -0
- package/build/types/appcontainer/ErrorBoundary.d.ts +16 -0
- package/build/types/appcontainer/ExceptionDialogModel.d.ts +28 -0
- package/build/types/appcontainer/FeedbackDialogModel.d.ts +24 -0
- package/build/types/appcontainer/ImpersonationBarModel.d.ts +20 -0
- package/build/types/appcontainer/MessageModel.d.ts +35 -0
- package/build/types/appcontainer/MessageSourceModel.d.ts +18 -0
- package/build/types/appcontainer/OptionsDialogModel.d.ts +23 -0
- package/build/types/appcontainer/SizingModeModel.d.ts +13 -0
- package/build/types/appcontainer/ThemeModel.d.ts +13 -0
- package/build/types/appcontainer/ToastModel.d.ts +27 -0
- package/build/types/appcontainer/ToastSourceModel.d.ts +13 -0
- package/build/types/appcontainer/ViewportSizeModel.d.ts +19 -0
- package/build/types/appcontainer/login/LoginPanelModel.d.ts +15 -0
- package/build/types/cmp/ag-grid/AgGrid.d.ts +31 -0
- package/build/types/cmp/ag-grid/AgGridModel.d.ts +183 -0
- package/build/types/cmp/ag-grid/index.d.ts +2 -0
- package/build/types/cmp/badge/Badge.d.ts +13 -0
- package/build/types/cmp/badge/index.d.ts +1 -0
- package/build/types/cmp/chart/Chart.d.ts +18 -0
- package/build/types/cmp/chart/ChartModel.d.ts +48 -0
- package/build/types/cmp/chart/impl/copyToClipboard.d.ts +6 -0
- package/build/types/cmp/chart/impl/zoomout.d.ts +5 -0
- package/build/types/cmp/chart/index.d.ts +2 -0
- package/build/types/cmp/chart/theme/Dark.d.ts +216 -0
- package/build/types/cmp/chart/theme/Light.d.ts +193 -0
- package/build/types/cmp/clock/Clock.d.ts +26 -0
- package/build/types/cmp/clock/index.d.ts +1 -0
- package/build/types/cmp/dataview/DataView.d.ts +22 -0
- package/build/types/cmp/dataview/DataViewModel.d.ts +103 -0
- package/build/types/cmp/dataview/index.d.ts +2 -0
- package/build/types/cmp/filter/FilterChooserFieldSpec.d.ts +39 -0
- package/build/types/cmp/filter/FilterChooserModel.d.ts +130 -0
- package/build/types/cmp/filter/impl/Option.d.ts +47 -0
- package/build/types/cmp/filter/impl/QueryEngine.d.ts +29 -0
- package/build/types/cmp/filter/index.d.ts +1 -0
- package/build/types/cmp/form/BaseFormFieldProps.d.ts +33 -0
- package/build/types/cmp/form/Form.d.ts +35 -0
- package/build/types/cmp/form/FormModel.d.ts +130 -0
- package/build/types/cmp/form/field/BaseFieldModel.d.ts +156 -0
- package/build/types/cmp/form/field/FieldModel.d.ts +11 -0
- package/build/types/cmp/form/field/SubformsFieldModel.d.ts +65 -0
- package/build/types/cmp/form/index.d.ts +6 -0
- package/build/types/cmp/grid/Grid.d.ts +39 -0
- package/build/types/cmp/grid/GridAutosizeOptions.d.ts +44 -0
- package/build/types/cmp/grid/GridContextMenu.d.ts +28 -0
- package/build/types/cmp/grid/GridModel.d.ts +556 -0
- package/build/types/cmp/grid/GridSorter.d.ts +23 -0
- package/build/types/cmp/grid/Types.d.ts +274 -0
- package/build/types/cmp/grid/columns/Column.d.ts +362 -0
- package/build/types/cmp/grid/columns/ColumnGroup.d.ts +56 -0
- package/build/types/cmp/grid/columns/Core.d.ts +9 -0
- package/build/types/cmp/grid/columns/DatesTimes.d.ts +12 -0
- package/build/types/cmp/grid/columns/index.d.ts +4 -0
- package/build/types/cmp/grid/enums/ExcelFormat.d.ts +33 -0
- package/build/types/cmp/grid/enums/GridAutosizeMode.d.ts +24 -0
- package/build/types/cmp/grid/enums/TreeStyle.d.ts +15 -0
- package/build/types/cmp/grid/filter/GridFilterFieldSpec.d.ts +38 -0
- package/build/types/cmp/grid/filter/GridFilterModel.d.ts +44 -0
- package/build/types/cmp/grid/helpers/GridCountLabel.d.ts +25 -0
- package/build/types/cmp/grid/impl/ColumnGroupHeader.d.ts +24 -0
- package/build/types/cmp/grid/impl/ColumnHeader.d.ts +55 -0
- package/build/types/cmp/grid/impl/ColumnWidthCalculator.d.ts +41 -0
- package/build/types/cmp/grid/impl/GridPersistenceModel.d.ts +34 -0
- package/build/types/cmp/grid/impl/MenuSupport.d.ts +7 -0
- package/build/types/cmp/grid/impl/RowKeyNavSupport.d.ts +11 -0
- package/build/types/cmp/grid/impl/Utils.d.ts +5 -0
- package/build/types/cmp/grid/index.d.ts +15 -0
- package/build/types/cmp/grid/renderers/MultiFieldRenderer.d.ts +27 -0
- package/build/types/cmp/grid/renderers/TagsRenderer.d.ts +3 -0
- package/build/types/cmp/grouping/GroupingChooserModel.d.ts +89 -0
- package/build/types/cmp/grouping/index.d.ts +1 -0
- package/build/types/cmp/input/HoistInputModel.d.ts +148 -0
- package/build/types/cmp/input/HoistInputProps.d.ts +19 -0
- package/build/types/cmp/input/index.d.ts +2 -0
- package/build/types/cmp/layout/Box.d.ts +17 -0
- package/build/types/cmp/layout/Frame.d.ts +15 -0
- package/build/types/cmp/layout/Placeholder.d.ts +12 -0
- package/build/types/cmp/layout/Spacer.d.ts +15 -0
- package/build/types/cmp/layout/Tags.d.ts +32 -0
- package/build/types/cmp/layout/TileFrame.d.ts +38 -0
- package/build/types/cmp/layout/Viewport.d.ts +9 -0
- package/build/types/cmp/layout/index.d.ts +7 -0
- package/build/types/cmp/pinpad/PinPad.d.ts +10 -0
- package/build/types/cmp/pinpad/PinPadModel.d.ts +35 -0
- package/build/types/cmp/pinpad/index.d.ts +2 -0
- package/build/types/cmp/relativetimestamp/RelativeTimestamp.d.ts +46 -0
- package/build/types/cmp/relativetimestamp/index.d.ts +1 -0
- package/build/types/cmp/spinner/Spinner.d.ts +16 -0
- package/build/types/cmp/spinner/index.d.ts +1 -0
- package/build/types/cmp/store/StoreCountLabel.d.ts +18 -0
- package/build/types/cmp/store/StoreFilterField.d.ts +82 -0
- package/build/types/cmp/store/impl/StoreFilterFieldImplModel.d.ts +23 -0
- package/build/types/cmp/store/index.d.ts +2 -0
- package/build/types/cmp/tab/TabContainer.d.ts +20 -0
- package/build/types/cmp/tab/TabContainerModel.d.ts +114 -0
- package/build/types/cmp/tab/TabModel.d.ts +71 -0
- package/build/types/cmp/tab/TabSwitcherProps.d.ts +16 -0
- package/build/types/cmp/tab/index.d.ts +4 -0
- package/build/types/cmp/websocket/WebSocketIndicator.d.ts +10 -0
- package/build/types/cmp/websocket/index.d.ts +1 -0
- package/build/types/core/AppSpec.d.ts +106 -0
- package/build/types/core/AppState.d.ts +13 -0
- package/build/types/core/HoistAppModel.d.ts +81 -0
- package/build/types/core/HoistBase.d.ts +160 -0
- package/build/types/core/HoistBaseDecorators.d.ts +20 -0
- package/build/types/core/HoistComponent.d.ts +109 -0
- package/build/types/core/HoistProps.d.ts +91 -0
- package/build/types/core/HoistService.d.ts +56 -0
- package/build/types/core/RefreshContextView.d.ts +11 -0
- package/build/types/core/RouterModel.d.ts +41 -0
- package/build/types/core/TaskObserver.d.ts +75 -0
- package/build/types/core/XH.d.ts +358 -0
- package/build/types/core/elem.d.ts +55 -0
- package/build/types/core/enums/RefreshMode.d.ts +16 -0
- package/build/types/core/enums/RenderMode.d.ts +13 -0
- package/build/types/core/enums/SizingMode.d.ts +10 -0
- package/build/types/core/exception/Exception.d.ts +63 -0
- package/build/types/core/exception/ExceptionHandler.d.ts +121 -0
- package/build/types/core/exception/Types.d.ts +50 -0
- package/build/types/core/impl/InstallServices.d.ts +18 -0
- package/build/types/core/impl/InstanceManager.d.ts +19 -0
- package/build/types/core/impl/PlatformManager.d.ts +13 -0
- package/build/types/core/index.d.ts +24 -0
- package/build/types/core/load/LoadSpec.d.ts +50 -0
- package/build/types/core/load/LoadSupport.d.ts +36 -0
- package/build/types/core/load/Loadable.d.ts +48 -0
- package/build/types/core/load/index.d.ts +3 -0
- package/build/types/core/model/CreatesSpec.d.ts +29 -0
- package/build/types/core/model/HoistModel.d.ts +121 -0
- package/build/types/core/model/Hooks.d.ts +28 -0
- package/build/types/core/model/ManagedRefreshContextModel.d.ts +23 -0
- package/build/types/core/model/ModelLookup.d.ts +27 -0
- package/build/types/core/model/ModelSelector.d.ts +28 -0
- package/build/types/core/model/ModelSpec.d.ts +30 -0
- package/build/types/core/model/RefreshContextModel.d.ts +45 -0
- package/build/types/core/model/RootRefreshContextModel.d.ts +14 -0
- package/build/types/core/model/UsesSpec.d.ts +49 -0
- package/build/types/core/model/index.d.ts +10 -0
- package/build/types/core/persist/CustomProvider.d.ts +16 -0
- package/build/types/core/persist/DashViewProvider.d.ts +11 -0
- package/build/types/core/persist/LocalStorageProvider.d.ts +11 -0
- package/build/types/core/persist/PersistOptions.d.ts +31 -0
- package/build/types/core/persist/PersistenceProvider.d.ts +49 -0
- package/build/types/core/persist/PrefProvider.d.ts +11 -0
- package/build/types/core/persist/index.d.ts +6 -0
- package/build/types/core/types/Interfaces.d.ts +232 -0
- package/build/types/core/types/Types.d.ts +41 -0
- package/build/types/data/Field.d.ts +72 -0
- package/build/types/data/RecordAction.d.ts +114 -0
- package/build/types/data/Store.d.ts +386 -0
- package/build/types/data/StoreRecord.d.ts +167 -0
- package/build/types/data/StoreSelectionModel.d.ts +52 -0
- package/build/types/data/UrlStore.d.ts +26 -0
- package/build/types/data/cube/BucketSpec.d.ts +13 -0
- package/build/types/data/cube/Cube.d.ts +159 -0
- package/build/types/data/cube/CubeField.d.ts +52 -0
- package/build/types/data/cube/Query.d.ts +63 -0
- package/build/types/data/cube/View.d.ts +97 -0
- package/build/types/data/cube/aggregate/AggregationContext.d.ts +21 -0
- package/build/types/data/cube/aggregate/Aggregator.d.ts +40 -0
- package/build/types/data/cube/aggregate/AverageAggregator.d.ts +4 -0
- package/build/types/data/cube/aggregate/AverageStrictAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/ChildCountAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/LeafCountAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/MaxAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/MinAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/NullAggregator.d.ts +4 -0
- package/build/types/data/cube/aggregate/SingleAggregator.d.ts +4 -0
- package/build/types/data/cube/aggregate/SumAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/SumStrictAggregator.d.ts +5 -0
- package/build/types/data/cube/aggregate/UniqueAggregator.d.ts +5 -0
- package/build/types/data/cube/row/AggregateRow.d.ts +13 -0
- package/build/types/data/cube/row/BaseRow.d.ts +27 -0
- package/build/types/data/cube/row/BucketRow.d.ts +12 -0
- package/build/types/data/cube/row/LeafRow.d.ts +12 -0
- package/build/types/data/cube/row/RowUpdate.d.ts +10 -0
- package/build/types/data/filter/BaseFilterFieldSpec.d.ts +73 -0
- package/build/types/data/filter/CompoundFilter.d.ts +23 -0
- package/build/types/data/filter/FieldFilter.d.ts +32 -0
- package/build/types/data/filter/Filter.d.ts +25 -0
- package/build/types/data/filter/FunctionFilter.d.ts +20 -0
- package/build/types/data/filter/Types.d.ts +31 -0
- package/build/types/data/filter/Utils.d.ts +49 -0
- package/build/types/data/impl/RecordSet.d.ts +44 -0
- package/build/types/data/impl/RecordValidator.d.ts +39 -0
- package/build/types/data/impl/StoreValidator.d.ts +47 -0
- package/build/types/data/index.d.ts +31 -0
- package/build/types/data/validation/Rule.d.ts +51 -0
- package/build/types/data/validation/ValidationState.d.ts +6 -0
- package/build/types/data/validation/constraints.d.ts +64 -0
- package/build/types/deprecated/index.d.ts +0 -0
- package/build/types/desktop/appcontainer/AboutDialog.d.ts +11 -0
- package/build/types/desktop/appcontainer/AppContainer.d.ts +13 -0
- package/build/types/desktop/appcontainer/Banner.d.ts +8 -0
- package/build/types/desktop/appcontainer/ChangelogDialog.d.ts +3 -0
- package/build/types/desktop/appcontainer/ExceptionDialog.d.ts +13 -0
- package/build/types/desktop/appcontainer/ExceptionDialogDetails.d.ts +8 -0
- package/build/types/desktop/appcontainer/FeedbackDialog.d.ts +6 -0
- package/build/types/desktop/appcontainer/IdlePanel.d.ts +8 -0
- package/build/types/desktop/appcontainer/ImpersonationBar.d.ts +9 -0
- package/build/types/desktop/appcontainer/LockoutPanel.d.ts +8 -0
- package/build/types/desktop/appcontainer/LoginPanel.d.ts +9 -0
- package/build/types/desktop/appcontainer/Message.d.ts +8 -0
- package/build/types/desktop/appcontainer/MessageSource.d.ts +6 -0
- package/build/types/desktop/appcontainer/OptionsDialog.d.ts +9 -0
- package/build/types/desktop/appcontainer/SuspendPanel.d.ts +6 -0
- package/build/types/desktop/appcontainer/ToastSource.d.ts +8 -0
- package/build/types/desktop/appcontainer/VersionBar.d.ts +3 -0
- package/build/types/desktop/appcontainer/index.d.ts +1 -0
- package/build/types/desktop/cmp/appOption/AutoRefreshAppOption.d.ts +340 -0
- package/build/types/desktop/cmp/appOption/SizingModeAppOption.d.ts +17 -0
- package/build/types/desktop/cmp/appOption/ThemeAppOption.d.ts +340 -0
- package/build/types/desktop/cmp/appOption/index.d.ts +3 -0
- package/build/types/desktop/cmp/appbar/AppBar.d.ts +34 -0
- package/build/types/desktop/cmp/appbar/AppBarSeparator.d.ts +6 -0
- package/build/types/desktop/cmp/appbar/index.d.ts +2 -0
- package/build/types/desktop/cmp/button/AppMenuButton.d.ts +36 -0
- package/build/types/desktop/cmp/button/Button.d.ts +28 -0
- package/build/types/desktop/cmp/button/ButtonGroup.d.ts +17 -0
- package/build/types/desktop/cmp/button/ColAutosizeButton.d.ts +14 -0
- package/build/types/desktop/cmp/button/ColChooserButton.d.ts +19 -0
- package/build/types/desktop/cmp/button/DashCanvasAddViewButton.d.ts +11 -0
- package/build/types/desktop/cmp/button/ExportButton.d.ts +22 -0
- package/build/types/desktop/cmp/button/FeedbackButton.d.ts +9 -0
- package/build/types/desktop/cmp/button/LaunchAdminButton.d.ts +9 -0
- package/build/types/desktop/cmp/button/LogoutButton.d.ts +11 -0
- package/build/types/desktop/cmp/button/ModalToggleButton.d.ts +11 -0
- package/build/types/desktop/cmp/button/OptionsButton.d.ts +10 -0
- package/build/types/desktop/cmp/button/RefreshButton.d.ts +13 -0
- package/build/types/desktop/cmp/button/RestoreDefaultsButton.d.ts +16 -0
- package/build/types/desktop/cmp/button/ThemeToggleButton.d.ts +8 -0
- package/build/types/desktop/cmp/button/WhatsNewButton.d.ts +11 -0
- package/build/types/desktop/cmp/button/index.d.ts +15 -0
- package/build/types/desktop/cmp/clipboard/ClipboardButton.d.ts +13 -0
- package/build/types/desktop/cmp/clipboard/ClipboardMenuItem.d.ts +7 -0
- package/build/types/desktop/cmp/clipboard/index.d.ts +2 -0
- package/build/types/desktop/cmp/contextmenu/ContextMenu.d.ts +21 -0
- package/build/types/desktop/cmp/contextmenu/index.d.ts +1 -0
- package/build/types/desktop/cmp/dash/DashConfig.d.ts +33 -0
- package/build/types/desktop/cmp/dash/DashModel.d.ts +19 -0
- package/build/types/desktop/cmp/dash/DashViewModel.d.ts +52 -0
- package/build/types/desktop/cmp/dash/DashViewSpec.d.ts +41 -0
- package/build/types/desktop/cmp/dash/canvas/DashCanvas.d.ts +19 -0
- package/build/types/desktop/cmp/dash/canvas/DashCanvasModel.d.ts +104 -0
- package/build/types/desktop/cmp/dash/canvas/DashCanvasViewModel.d.ts +27 -0
- package/build/types/desktop/cmp/dash/canvas/DashCanvasViewSpec.d.ts +30 -0
- package/build/types/desktop/cmp/dash/canvas/impl/DashCanvasContextMenu.d.ts +8 -0
- package/build/types/desktop/cmp/dash/canvas/impl/DashCanvasView.d.ts +12 -0
- package/build/types/desktop/cmp/dash/canvas/impl/utils.d.ts +10 -0
- package/build/types/desktop/cmp/dash/container/DashContainer.d.ts +9 -0
- package/build/types/desktop/cmp/dash/container/DashContainerModel.d.ts +143 -0
- package/build/types/desktop/cmp/dash/container/DashContainerViewSpec.d.ts +17 -0
- package/build/types/desktop/cmp/dash/container/impl/DashContainerContextMenu.d.ts +15 -0
- package/build/types/desktop/cmp/dash/container/impl/DashContainerMenuButton.d.ts +7 -0
- package/build/types/desktop/cmp/dash/container/impl/DashContainerUtils.d.ts +14 -0
- package/build/types/desktop/cmp/dash/container/impl/DashContainerView.d.ts +12 -0
- package/build/types/desktop/cmp/dash/index.d.ts +11 -0
- package/build/types/desktop/cmp/dock/DockContainer.d.ts +26 -0
- package/build/types/desktop/cmp/dock/DockContainerModel.d.ts +33 -0
- package/build/types/desktop/cmp/dock/DockViewModel.d.ts +75 -0
- package/build/types/desktop/cmp/dock/impl/DockContainer.d.ts +10 -0
- package/build/types/desktop/cmp/dock/impl/DockView.d.ts +15 -0
- package/build/types/desktop/cmp/dock/index.d.ts +3 -0
- package/build/types/desktop/cmp/error/ErrorMessage.d.ts +33 -0
- package/build/types/desktop/cmp/error/index.d.ts +1 -0
- package/build/types/desktop/cmp/filechooser/FileChooser.d.ts +42 -0
- package/build/types/desktop/cmp/filechooser/FileChooserModel.d.ts +25 -0
- package/build/types/desktop/cmp/filechooser/index.d.ts +2 -0
- package/build/types/desktop/cmp/filter/FilterChooser.d.ts +28 -0
- package/build/types/desktop/cmp/filter/index.d.ts +2 -0
- package/build/types/desktop/cmp/form/FormField.d.ts +63 -0
- package/build/types/desktop/cmp/form/index.d.ts +1 -0
- package/build/types/desktop/cmp/grid/columns/Actions.d.ts +29 -0
- package/build/types/desktop/cmp/grid/editors/BooleanEditor.d.ts +16 -0
- package/build/types/desktop/cmp/grid/editors/DateEditor.d.ts +7 -0
- package/build/types/desktop/cmp/grid/editors/EditorProps.d.ts +17 -0
- package/build/types/desktop/cmp/grid/editors/NumberEditor.d.ts +7 -0
- package/build/types/desktop/cmp/grid/editors/SelectEditor.d.ts +7 -0
- package/build/types/desktop/cmp/grid/editors/TextAreaEditor.d.ts +7 -0
- package/build/types/desktop/cmp/grid/editors/TextEditor.d.ts +7 -0
- package/build/types/desktop/cmp/grid/editors/impl/InlineEditorModel.d.ts +15 -0
- package/build/types/desktop/cmp/grid/editors/index.d.ts +6 -0
- package/build/types/desktop/cmp/grid/find/GridFindField.d.ts +43 -0
- package/build/types/desktop/cmp/grid/find/impl/GridFindFieldImplModel.d.ts +37 -0
- package/build/types/desktop/cmp/grid/impl/colchooser/ColChooser.d.ts +18 -0
- package/build/types/desktop/cmp/grid/impl/colchooser/ColChooserDialog.d.ts +2 -0
- package/build/types/desktop/cmp/grid/impl/colchooser/ColChooserModel.d.ts +33 -0
- package/build/types/desktop/cmp/grid/impl/filter/ColumnHeaderFilter.d.ts +9 -0
- package/build/types/desktop/cmp/grid/impl/filter/ColumnHeaderFilterModel.d.ts +38 -0
- package/build/types/desktop/cmp/grid/impl/filter/GridFilterDialog.d.ts +11 -0
- package/build/types/desktop/cmp/grid/impl/filter/custom/CustomRow.d.ts +6 -0
- package/build/types/desktop/cmp/grid/impl/filter/custom/CustomRowModel.d.ts +28 -0
- package/build/types/desktop/cmp/grid/impl/filter/custom/CustomTab.d.ts +7 -0
- package/build/types/desktop/cmp/grid/impl/filter/custom/CustomTabModel.d.ts +21 -0
- package/build/types/desktop/cmp/grid/impl/filter/values/ValuesTab.d.ts +7 -0
- package/build/types/desktop/cmp/grid/impl/filter/values/ValuesTabModel.d.ts +33 -0
- package/build/types/desktop/cmp/grid/index.d.ts +3 -0
- package/build/types/desktop/cmp/grouping/GroupingChooser.d.ts +26 -0
- package/build/types/desktop/cmp/grouping/index.d.ts +2 -0
- package/build/types/desktop/cmp/input/ButtonGroupInput.d.ts +26 -0
- package/build/types/desktop/cmp/input/Checkbox.d.ts +28 -0
- package/build/types/desktop/cmp/input/CodeInput.d.ts +80 -0
- package/build/types/desktop/cmp/input/DateInput.d.ts +117 -0
- package/build/types/desktop/cmp/input/JsonInput.d.ts +9 -0
- package/build/types/desktop/cmp/input/NumberInput.d.ts +77 -0
- package/build/types/desktop/cmp/input/RadioInput.d.ts +22 -0
- package/build/types/desktop/cmp/input/Select.d.ts +139 -0
- package/build/types/desktop/cmp/input/Slider.d.ts +33 -0
- package/build/types/desktop/cmp/input/SwitchInput.d.ts +21 -0
- package/build/types/desktop/cmp/input/TextArea.d.ts +26 -0
- package/build/types/desktop/cmp/input/TextInput.d.ts +55 -0
- package/build/types/desktop/cmp/input/index.d.ts +12 -0
- package/build/types/desktop/cmp/leftrightchooser/LeftRightChooser.d.ts +14 -0
- package/build/types/desktop/cmp/leftrightchooser/LeftRightChooserFilter.d.ts +15 -0
- package/build/types/desktop/cmp/leftrightchooser/LeftRightChooserModel.d.ts +83 -0
- package/build/types/desktop/cmp/leftrightchooser/impl/ChooserToolbar.d.ts +3 -0
- package/build/types/desktop/cmp/leftrightchooser/impl/Description.d.ts +3 -0
- package/build/types/desktop/cmp/leftrightchooser/index.d.ts +3 -0
- package/build/types/desktop/cmp/loadingindicator/LoadingIndicator.d.ts +27 -0
- package/build/types/desktop/cmp/loadingindicator/index.d.ts +1 -0
- package/build/types/desktop/cmp/mask/Mask.d.ts +27 -0
- package/build/types/desktop/cmp/mask/index.d.ts +1 -0
- package/build/types/desktop/cmp/modalsupport/ModalSupport.d.ts +16 -0
- package/build/types/desktop/cmp/modalsupport/ModalSupportModel.d.ts +30 -0
- package/build/types/desktop/cmp/modalsupport/index.d.ts +2 -0
- package/build/types/desktop/cmp/panel/Panel.d.ts +60 -0
- package/build/types/desktop/cmp/panel/PanelModel.d.ts +112 -0
- package/build/types/desktop/cmp/panel/impl/PanelHeader.d.ts +2 -0
- package/build/types/desktop/cmp/panel/impl/ResizeContainer.d.ts +1 -0
- package/build/types/desktop/cmp/panel/impl/Splitter.d.ts +2 -0
- package/build/types/desktop/cmp/panel/impl/dragger/Dragger.d.ts +3 -0
- package/build/types/desktop/cmp/panel/impl/dragger/DraggerModel.d.ts +33 -0
- package/build/types/desktop/cmp/panel/index.d.ts +2 -0
- package/build/types/desktop/cmp/pinpad/impl/PinPad.d.ts +11 -0
- package/build/types/desktop/cmp/record/RecordActionBar.d.ts +33 -0
- package/build/types/desktop/cmp/record/impl/RecordActionButton.d.ts +21 -0
- package/build/types/desktop/cmp/record/index.d.ts +1 -0
- package/build/types/desktop/cmp/rest/Actions.d.ts +7 -0
- package/build/types/desktop/cmp/rest/RestGrid.d.ts +24 -0
- package/build/types/desktop/cmp/rest/RestGridModel.d.ts +98 -0
- package/build/types/desktop/cmp/rest/data/RestField.d.ts +37 -0
- package/build/types/desktop/cmp/rest/data/RestStore.d.ts +39 -0
- package/build/types/desktop/cmp/rest/impl/RestForm.d.ts +6 -0
- package/build/types/desktop/cmp/rest/impl/RestFormField.d.ts +5 -0
- package/build/types/desktop/cmp/rest/impl/RestFormModel.d.ts +48 -0
- package/build/types/desktop/cmp/rest/impl/RestGridToolbar.d.ts +5 -0
- package/build/types/desktop/cmp/rest/index.d.ts +4 -0
- package/build/types/desktop/cmp/store/impl/StoreFilterField.d.ts +7 -0
- package/build/types/desktop/cmp/tab/TabSwitcher.d.ts +15 -0
- package/build/types/desktop/cmp/tab/impl/Tab.d.ts +12 -0
- package/build/types/desktop/cmp/tab/impl/TabContainer.d.ts +8 -0
- package/build/types/desktop/cmp/tab/index.d.ts +1 -0
- package/build/types/desktop/cmp/toolbar/Toolbar.d.ts +31 -0
- package/build/types/desktop/cmp/toolbar/ToolbarSep.d.ts +11 -0
- package/build/types/desktop/cmp/toolbar/index.d.ts +2 -0
- package/build/types/desktop/cmp/treemap/SplitTreeMap.d.ts +11 -0
- package/build/types/desktop/cmp/treemap/SplitTreeMapModel.d.ts +79 -0
- package/build/types/desktop/cmp/treemap/TreeMap.d.ts +16 -0
- package/build/types/desktop/cmp/treemap/TreeMapModel.d.ts +182 -0
- package/build/types/desktop/cmp/treemap/impl/Splitter.d.ts +6 -0
- package/build/types/desktop/cmp/treemap/index.d.ts +4 -0
- package/build/types/desktop/hooks/UseContextMenu.d.ts +11 -0
- package/build/types/desktop/hooks/UseHotkeys.d.ts +14 -0
- package/build/types/desktop/hooks/index.d.ts +2 -0
- package/build/types/desktop/register.d.ts +1 -0
- package/build/types/dynamics/desktop.d.ts +27 -0
- package/build/types/dynamics/mobile.d.ts +21 -0
- package/build/types/format/FormatDate.d.ts +52 -0
- package/build/types/format/FormatMisc.d.ts +41 -0
- package/build/types/format/FormatNumber.d.ts +112 -0
- package/build/types/format/FormatUtils.d.ts +11 -0
- package/build/types/format/impl/Utils.d.ts +7 -0
- package/build/types/format/index.d.ts +4 -0
- package/build/types/icon/Icon.d.ts +340 -0
- package/build/types/icon/XHLogo.d.ts +4 -0
- package/build/types/icon/impl/IconCmp.d.ts +6 -0
- package/build/types/icon/impl/IconHtml.d.ts +13 -0
- package/build/types/icon/index.d.ts +2 -0
- package/build/types/inspector/InspectorPanel.d.ts +5 -0
- package/build/types/inspector/instances/InstancesModel.d.ts +48 -0
- package/build/types/inspector/instances/InstancesPanel.d.ts +2 -0
- package/build/types/inspector/stats/StatsModel.d.ts +19 -0
- package/build/types/inspector/stats/StatsPanel.d.ts +2 -0
- package/build/types/kit/ag-grid/index.d.ts +19 -0
- package/build/types/kit/blueprint/Dialog.d.ts +13 -0
- package/build/types/kit/blueprint/Wrappers.d.ts +5 -0
- package/build/types/kit/blueprint/index.d.ts +8 -0
- package/build/types/kit/highcharts/index.d.ts +6 -0
- package/build/types/kit/onsen/index.d.ts +8 -0
- package/build/types/kit/react-beautiful-dnd/index.d.ts +3 -0
- package/build/types/kit/react-dates/index.d.ts +5 -0
- package/build/types/kit/react-dropzone/index.d.ts +3 -0
- package/build/types/kit/react-select/index.d.ts +7 -0
- package/build/types/mobile/appcontainer/AboutDialog.d.ts +10 -0
- package/build/types/mobile/appcontainer/AppContainer.d.ts +13 -0
- package/build/types/mobile/appcontainer/Banner.d.ts +8 -0
- package/build/types/mobile/appcontainer/ExceptionDialog.d.ts +13 -0
- package/build/types/mobile/appcontainer/ExceptionDialogDetails.d.ts +7 -0
- package/build/types/mobile/appcontainer/FeedbackDialog.d.ts +6 -0
- package/build/types/mobile/appcontainer/IdlePanel.d.ts +8 -0
- package/build/types/mobile/appcontainer/ImpersonationBar.d.ts +9 -0
- package/build/types/mobile/appcontainer/LockoutPanel.d.ts +7 -0
- package/build/types/mobile/appcontainer/LoginPanel.d.ts +9 -0
- package/build/types/mobile/appcontainer/Message.d.ts +7 -0
- package/build/types/mobile/appcontainer/MessageSource.d.ts +6 -0
- package/build/types/mobile/appcontainer/OptionsDialog.d.ts +6 -0
- package/build/types/mobile/appcontainer/SuspendPanel.d.ts +6 -0
- package/build/types/mobile/appcontainer/Toast.d.ts +6 -0
- package/build/types/mobile/appcontainer/ToastSource.d.ts +7 -0
- package/build/types/mobile/appcontainer/VersionBar.d.ts +5 -0
- package/build/types/mobile/appcontainer/index.d.ts +1 -0
- package/build/types/mobile/cmp/appOption/AutoRefreshAppOption.d.ts +333 -0
- package/build/types/mobile/cmp/appOption/SizingModeAppOption.d.ts +336 -0
- package/build/types/mobile/cmp/appOption/ThemeAppOption.d.ts +333 -0
- package/build/types/mobile/cmp/appOption/index.d.ts +3 -0
- package/build/types/mobile/cmp/button/Button.d.ts +22 -0
- package/build/types/mobile/cmp/button/ButtonGroup.d.ts +13 -0
- package/build/types/mobile/cmp/button/ColAutosizeButton.d.ts +14 -0
- package/build/types/mobile/cmp/button/ColChooserButton.d.ts +15 -0
- package/build/types/mobile/cmp/button/ExpandCollapseButton.d.ts +12 -0
- package/build/types/mobile/cmp/button/FeedbackButton.d.ts +9 -0
- package/build/types/mobile/cmp/button/LogoutButton.d.ts +11 -0
- package/build/types/mobile/cmp/button/NavigatorBackButton.d.ts +8 -0
- package/build/types/mobile/cmp/button/OptionsButton.d.ts +10 -0
- package/build/types/mobile/cmp/button/RefreshButton.d.ts +13 -0
- package/build/types/mobile/cmp/button/RestoreDefaultsButton.d.ts +16 -0
- package/build/types/mobile/cmp/button/ThemeToggleButton.d.ts +8 -0
- package/build/types/mobile/cmp/button/index.d.ts +11 -0
- package/build/types/mobile/cmp/dialog/Dialog.d.ts +17 -0
- package/build/types/mobile/cmp/dialog/index.d.ts +1 -0
- package/build/types/mobile/cmp/error/ErrorMessage.d.ts +33 -0
- package/build/types/mobile/cmp/error/index.d.ts +1 -0
- package/build/types/mobile/cmp/form/FormField.d.ts +26 -0
- package/build/types/mobile/cmp/form/index.d.ts +1 -0
- package/build/types/mobile/cmp/grid/impl/ColChooser.d.ts +22 -0
- package/build/types/mobile/cmp/grid/impl/ColChooserModel.d.ts +46 -0
- package/build/types/mobile/cmp/grouping/GroupingChooser.d.ts +20 -0
- package/build/types/mobile/cmp/grouping/index.d.ts +2 -0
- package/build/types/mobile/cmp/header/AppBar.d.ts +39 -0
- package/build/types/mobile/cmp/header/AppMenuButton.d.ts +31 -0
- package/build/types/mobile/cmp/header/index.d.ts +2 -0
- package/build/types/mobile/cmp/input/ButtonGroupInput.d.ts +23 -0
- package/build/types/mobile/cmp/input/Checkbox.d.ts +14 -0
- package/build/types/mobile/cmp/input/DateInput.d.ts +53 -0
- package/build/types/mobile/cmp/input/Label.d.ts +11 -0
- package/build/types/mobile/cmp/input/NumberInput.d.ts +52 -0
- package/build/types/mobile/cmp/input/SearchInput.d.ts +24 -0
- package/build/types/mobile/cmp/input/Select.d.ts +122 -0
- package/build/types/mobile/cmp/input/SwitchInput.d.ts +14 -0
- package/build/types/mobile/cmp/input/TextArea.d.ts +22 -0
- package/build/types/mobile/cmp/input/TextInput.d.ts +39 -0
- package/build/types/mobile/cmp/input/index.d.ts +10 -0
- package/build/types/mobile/cmp/loadingindicator/LoadingIndicator.d.ts +27 -0
- package/build/types/mobile/cmp/loadingindicator/index.d.ts +1 -0
- package/build/types/mobile/cmp/mask/Mask.d.ts +25 -0
- package/build/types/mobile/cmp/mask/index.d.ts +1 -0
- package/build/types/mobile/cmp/menu/MenuButton.d.ts +21 -0
- package/build/types/mobile/cmp/menu/impl/Menu.d.ts +12 -0
- package/build/types/mobile/cmp/menu/index.d.ts +1 -0
- package/build/types/mobile/cmp/navigator/Navigator.d.ts +13 -0
- package/build/types/mobile/cmp/navigator/NavigatorModel.d.ts +55 -0
- package/build/types/mobile/cmp/navigator/PageModel.d.ts +60 -0
- package/build/types/mobile/cmp/navigator/impl/Page.d.ts +12 -0
- package/build/types/mobile/cmp/navigator/impl/swipe/BackIndicator.d.ts +6 -0
- package/build/types/mobile/cmp/navigator/impl/swipe/RefreshIndicator.d.ts +6 -0
- package/build/types/mobile/cmp/navigator/impl/swipe/Swiper.d.ts +8 -0
- package/build/types/mobile/cmp/navigator/impl/swipe/SwiperModel.d.ts +23 -0
- package/build/types/mobile/cmp/navigator/index.d.ts +2 -0
- package/build/types/mobile/cmp/panel/DialogPanel.d.ts +15 -0
- package/build/types/mobile/cmp/panel/Panel.d.ts +39 -0
- package/build/types/mobile/cmp/panel/impl/PanelHeader.d.ts +6 -0
- package/build/types/mobile/cmp/panel/index.d.ts +2 -0
- package/build/types/mobile/cmp/pinpad/impl/PinPad.d.ts +9 -0
- package/build/types/mobile/cmp/popover/Popover.d.ts +36 -0
- package/build/types/mobile/cmp/popover/index.d.ts +1 -0
- package/build/types/mobile/cmp/store/impl/StoreFilterField.d.ts +7 -0
- package/build/types/mobile/cmp/tab/impl/Tab.d.ts +13 -0
- package/build/types/mobile/cmp/tab/impl/TabContainer.d.ts +10 -0
- package/build/types/mobile/cmp/toolbar/Toolbar.d.ts +12 -0
- package/build/types/mobile/cmp/toolbar/ToolbarSeparator.d.ts +8 -0
- package/build/types/mobile/cmp/toolbar/index.d.ts +2 -0
- package/build/types/mobile/register.d.ts +1 -0
- package/build/types/mobx/decorators.d.ts +11 -0
- package/build/types/mobx/index.d.ts +5 -0
- package/build/types/mobx/overrides.d.ts +9 -0
- package/build/types/promise/Promise.d.ts +107 -0
- package/build/types/promise/index.d.ts +1 -0
- package/build/types/svc/AlertBannerService.d.ts +19 -0
- package/build/types/svc/AutoRefreshService.d.ts +28 -0
- package/build/types/svc/ChangelogService.d.ts +62 -0
- package/build/types/svc/ConfigService.d.ts +36 -0
- package/build/types/svc/EnvironmentService.d.ts +24 -0
- package/build/types/svc/FetchService.d.ts +139 -0
- package/build/types/svc/GridAutosizeService.d.ts +38 -0
- package/build/types/svc/GridExportService.d.ts +56 -0
- package/build/types/svc/IdentityService.d.ts +61 -0
- package/build/types/svc/IdleService.d.ts +21 -0
- package/build/types/svc/InspectorService.d.ts +74 -0
- package/build/types/svc/JsonBlobService.d.ts +35 -0
- package/build/types/svc/LocalStorageService.d.ts +24 -0
- package/build/types/svc/PrefService.d.ts +76 -0
- package/build/types/svc/TrackService.d.ts +15 -0
- package/build/types/svc/WebSocketService.d.ts +94 -0
- package/build/types/svc/index.d.ts +16 -0
- package/build/types/utils/async/AsyncUtils.d.ts +40 -0
- package/build/types/utils/async/Timer.d.ts +89 -0
- package/build/types/utils/async/index.d.ts +2 -0
- package/build/types/utils/datetime/DateTimeUtils.d.ts +10 -0
- package/build/types/utils/datetime/LocalDate.d.ts +94 -0
- package/build/types/utils/datetime/index.d.ts +2 -0
- package/build/types/utils/impl/Equals.d.ts +4 -0
- package/build/types/utils/impl/IsOmitted.d.ts +7 -0
- package/build/types/utils/impl/Separators.d.ts +10 -0
- package/build/types/utils/impl/TimeZone.d.ts +4 -0
- package/build/types/utils/impl/index.d.ts +4 -0
- package/build/types/utils/js/BrowserUtils.d.ts +4 -0
- package/build/types/utils/js/Decorators.d.ts +25 -0
- package/build/types/utils/js/DomUtils.d.ts +46 -0
- package/build/types/utils/js/HtmlUtils.d.ts +4 -0
- package/build/types/utils/js/LangUtils.d.ts +112 -0
- package/build/types/utils/js/LogUtils.d.ts +32 -0
- package/build/types/utils/js/VersionUtils.d.ts +17 -0
- package/build/types/utils/js/index.d.ts +7 -0
- package/build/types/utils/react/ClassName.d.ts +14 -0
- package/build/types/utils/react/Hooks.d.ts +47 -0
- package/build/types/utils/react/LayoutPropUtils.d.ts +42 -0
- package/build/types/utils/react/ObservableRef.d.ts +13 -0
- package/build/types/utils/react/ReactUtils.d.ts +19 -0
- package/build/types/utils/react/index.d.ts +5 -0
- package/package.json +2 -2
- package/tsconfig.json +14 -7
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { HoistService } from '@xh/hoist/core';
|
|
2
|
+
/**
|
|
3
|
+
* Establishes and maintains a websocket connection to the Hoist server, if enabled via `AppSpec`.
|
|
4
|
+
*
|
|
5
|
+
* Once a connection is established, this service exposes a `channelKey` property that is unique to
|
|
6
|
+
* this user and client app instance. This key can be used in application-specific requests to the
|
|
7
|
+
* server to identify this unique client app instance / connection. The server can then push
|
|
8
|
+
* messages as requested - e.g. when a particular query or dataset of interest is updated.
|
|
9
|
+
*
|
|
10
|
+
* Callers can register a callback via `subscribe()` to receive incoming messages on a requested
|
|
11
|
+
* topic. The {@link WebSocketSubscription} returned from `subscribe()` can be used to later
|
|
12
|
+
* `unsubscribe()` if updates are no longer desired. `HoistModel` and `HoistComponent` callers are
|
|
13
|
+
* encouraged to save a reference to their subscription via a {@link managed} property to have
|
|
14
|
+
* callbacks unsubscribed automatically when the component/model is unmounted/destroyed.
|
|
15
|
+
*
|
|
16
|
+
* This service also provides a `sendMessage()` method to push messages back to the server over the
|
|
17
|
+
* same socket, although this is a relatively uncommon usage and is specifically *not* recommended
|
|
18
|
+
* over plain-old Ajax requests.
|
|
19
|
+
*
|
|
20
|
+
* Note this service requires the server-side application to be configured to listen to inbound
|
|
21
|
+
* websocket connections. See `WebSocketService.groovy` in hoist-core for additional documentation.
|
|
22
|
+
*
|
|
23
|
+
* See {@link WebSocketIndicator}, a simple component for displaying connection status.
|
|
24
|
+
*/
|
|
25
|
+
export declare class WebSocketService extends HoistService {
|
|
26
|
+
static instance: WebSocketService;
|
|
27
|
+
HEARTBEAT_TOPIC: string;
|
|
28
|
+
REG_SUCCESS_TOPIC: string;
|
|
29
|
+
FORCE_APP_SUSPEND_TOPIC: string;
|
|
30
|
+
/** Unique channel assigned by server upon successful connection. */
|
|
31
|
+
channelKey: string;
|
|
32
|
+
/** Last time a message was received, including heartbeat messages. */
|
|
33
|
+
lastMessageTime: Date;
|
|
34
|
+
/** Observable flag indicating service is connected and available for use. */
|
|
35
|
+
get connected(): boolean;
|
|
36
|
+
/** set to true to log all sent/received messages - very chatty. */
|
|
37
|
+
logMessages: boolean;
|
|
38
|
+
private _timer;
|
|
39
|
+
private _socket;
|
|
40
|
+
private _subsByTopic;
|
|
41
|
+
enabled: boolean;
|
|
42
|
+
constructor();
|
|
43
|
+
initAsync(): Promise<void>;
|
|
44
|
+
/**
|
|
45
|
+
* Subscribe a callback to receive inbound messages for a given topic on a going-forward basis.
|
|
46
|
+
*
|
|
47
|
+
* @param topic - application-specific topic of interest.
|
|
48
|
+
* @param fn - handler to call for each incoming message on the requested topic.
|
|
49
|
+
* @returns subscription reference that can be used to unsubscribe to future messages for the
|
|
50
|
+
* same topic/handler. Callers should take care to save this reference and use it to
|
|
51
|
+
* dispose of their subs on destroy.
|
|
52
|
+
*/
|
|
53
|
+
subscribe(topic: string, fn: (msg: WebSocketMessage) => any): WebSocketSubscription;
|
|
54
|
+
/**
|
|
55
|
+
* Cancel a subscription for a given topic/handler.
|
|
56
|
+
*
|
|
57
|
+
* @param subscription - WebSocketSubscription returned when the subscription was established.
|
|
58
|
+
*/
|
|
59
|
+
unsubscribe(subscription: WebSocketSubscription): void;
|
|
60
|
+
/**
|
|
61
|
+
* Send a message back to the server via the connected websocket.
|
|
62
|
+
*/
|
|
63
|
+
sendMessage(message: WebSocketMessage): void;
|
|
64
|
+
connect(): void;
|
|
65
|
+
disconnect(): void;
|
|
66
|
+
heartbeatOrReconnect(): void;
|
|
67
|
+
shutdown(): void;
|
|
68
|
+
onOpen(ev: any): void;
|
|
69
|
+
onClose(ev: any): void;
|
|
70
|
+
onError(ev: any): void;
|
|
71
|
+
onMessage(rawMsg: any): void;
|
|
72
|
+
notifySubscribers(message: any): void;
|
|
73
|
+
getSubsForTopic(topic: any): WebSocketSubscription[];
|
|
74
|
+
updateConnectedStatus(): void;
|
|
75
|
+
installChannelKey(key: any): void;
|
|
76
|
+
updateLastMessageTime(): void;
|
|
77
|
+
buildWebSocketUrl(): string;
|
|
78
|
+
showTestMessageAlert(message: any): void;
|
|
79
|
+
maybeLogMessage(...args: any[]): void;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Wrapper class to encapsulate and manage a subscription to messages for a given topic + handler.
|
|
83
|
+
* Returned from `WebSocketService.subscribe()` and used to `unsubscribe()`.
|
|
84
|
+
*/
|
|
85
|
+
export declare class WebSocketSubscription {
|
|
86
|
+
topic: string;
|
|
87
|
+
fn: (msg: WebSocketMessage) => any;
|
|
88
|
+
constructor(topic: any, fn: any);
|
|
89
|
+
destroy(): void;
|
|
90
|
+
}
|
|
91
|
+
export interface WebSocketMessage {
|
|
92
|
+
topic: string;
|
|
93
|
+
data?: any;
|
|
94
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export * from './AlertBannerService';
|
|
2
|
+
export * from './AutoRefreshService';
|
|
3
|
+
export * from './ChangelogService';
|
|
4
|
+
export * from './ConfigService';
|
|
5
|
+
export * from './EnvironmentService';
|
|
6
|
+
export * from './FetchService';
|
|
7
|
+
export * from './GridAutosizeService';
|
|
8
|
+
export * from './GridExportService';
|
|
9
|
+
export * from './IdentityService';
|
|
10
|
+
export * from './IdleService';
|
|
11
|
+
export * from './InspectorService';
|
|
12
|
+
export * from './JsonBlobService';
|
|
13
|
+
export * from './LocalStorageService';
|
|
14
|
+
export * from './PrefService';
|
|
15
|
+
export * from './TrackService';
|
|
16
|
+
export * from './WebSocketService';
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Iterate over an iterable and run a closure on each item - as with `for ... of` - but do so
|
|
3
|
+
* asynchronously and with minimal waits inserted after a configurable time interval.
|
|
4
|
+
*
|
|
5
|
+
* Intended for long-running or compute-intensive loops that would otherwise lock up the browser
|
|
6
|
+
* if run synchronously. Waiting at regular intervals minimizes blocking of user interactions,
|
|
7
|
+
* allowing ongoing rendering of UI updates (e.g. load masks) and generally keeping the browser
|
|
8
|
+
* event loop running.
|
|
9
|
+
*
|
|
10
|
+
* Note that if the browser tab is hidden (i.e. document.hidden is true) this loop will be executed
|
|
11
|
+
* without pauses. In this case the pauses would be unduly large due to throttling of the event
|
|
12
|
+
* loop by the browser, and there is no user benefit to avoiding blocking the main thread.
|
|
13
|
+
*
|
|
14
|
+
* NOTE this is NOT for use cases where the `fn` arg is itself async - i.e. it does not await the
|
|
15
|
+
* call to `fn` and is instead for the opposite use case, where fn is *synchronous*. If looking to
|
|
16
|
+
* run an async operation over a collection, consider a simple and blocking for...of loop.
|
|
17
|
+
*/
|
|
18
|
+
export declare function forEachAsync<T>(collection: Iterable<T>, fn: (val: T, idx: number, collection: Iterable<T>) => void, opts?: {
|
|
19
|
+
waitAfter?: number;
|
|
20
|
+
waitFor?: number;
|
|
21
|
+
}): Promise<void>;
|
|
22
|
+
/**
|
|
23
|
+
* As with `forEachAsync()` above, but in the form of a `while` loop.
|
|
24
|
+
* @param conditionFn - called before each iteration; return true to continue loop.
|
|
25
|
+
* @param fn - called without arguments for each iteration.
|
|
26
|
+
* @param opts - additional options.
|
|
27
|
+
*/
|
|
28
|
+
export declare function whileAsync(conditionFn: () => boolean, fn: () => void, opts?: AsyncLoopOptions): Promise<void>;
|
|
29
|
+
export interface AsyncLoopOptions {
|
|
30
|
+
/**
|
|
31
|
+
* Interval in ms after which the loop should pause and wait. If the loop completes before
|
|
32
|
+
* this interval has passed, no waits will be inserted. Default 50ms.
|
|
33
|
+
*/
|
|
34
|
+
waitAfter?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Wait time in ms for each pause. The default of 0ms should be sufficient to allow an event
|
|
37
|
+
* loop cycle to run.
|
|
38
|
+
*/
|
|
39
|
+
waitFor?: number;
|
|
40
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* Promise-aware recurring task timer for use by framework and applications.
|
|
4
|
+
*
|
|
5
|
+
* This object is designed to be robust across failing tasks, and never to re-run the task
|
|
6
|
+
* simultaneously, unless in the case of a timeout. Callers can optionally specify
|
|
7
|
+
* the duration of asynchronous tasks by returning a Promise from runFn.
|
|
8
|
+
*
|
|
9
|
+
* This object seeks to mirror the API and semantics of the server-side equivalent 'Timer'
|
|
10
|
+
* as closely as possible. However, there are important differences due to the synchronous
|
|
11
|
+
* nature of javascript. In particular, there is no support for 'runImmediatelyAndBlock', and the
|
|
12
|
+
* 'timeout' argument will not be able to interrupt synchronous activity of the runFn.
|
|
13
|
+
*
|
|
14
|
+
* All public properties should be considered read-only. See `setInterval()` to change the interval
|
|
15
|
+
* of this timer dynamically.
|
|
16
|
+
*/
|
|
17
|
+
export declare class Timer {
|
|
18
|
+
static _timers: Timer[];
|
|
19
|
+
runFn: () => any;
|
|
20
|
+
interval: number | (() => number);
|
|
21
|
+
timeout: number | (() => number);
|
|
22
|
+
delay: number | boolean;
|
|
23
|
+
scope: any;
|
|
24
|
+
intervalUnits: number;
|
|
25
|
+
timeoutUnits: number;
|
|
26
|
+
cancelled: boolean;
|
|
27
|
+
isRunning: boolean;
|
|
28
|
+
lastRun: Date;
|
|
29
|
+
/** Create a new Timer. */
|
|
30
|
+
static create({ runFn, interval, timeout, intervalUnits, timeoutUnits, delay, scope }: TimerSpec): Timer;
|
|
31
|
+
/**
|
|
32
|
+
* Permanently cancel *all* running timers.
|
|
33
|
+
*
|
|
34
|
+
* This method is intended for framework use only.
|
|
35
|
+
* It is a one-way operation, intended for permanently halting app activity before sleeping.
|
|
36
|
+
*/
|
|
37
|
+
static cancelAll(): void;
|
|
38
|
+
/**
|
|
39
|
+
* Permanently cancel this timer.
|
|
40
|
+
*/
|
|
41
|
+
cancel(): void;
|
|
42
|
+
/**
|
|
43
|
+
* Change the interval of this timer.
|
|
44
|
+
*
|
|
45
|
+
* @param interval - ms to wait between runs or any value `<=0` to pause the timer.
|
|
46
|
+
*/
|
|
47
|
+
setInterval(interval: number): void;
|
|
48
|
+
constructor(args: any);
|
|
49
|
+
private cancelInternal;
|
|
50
|
+
private heartbeatAsync;
|
|
51
|
+
private doRunAsync;
|
|
52
|
+
private internalRunFn;
|
|
53
|
+
private parseDynamicVal;
|
|
54
|
+
private parseDelay;
|
|
55
|
+
private get intervalMs();
|
|
56
|
+
private get timeoutMs();
|
|
57
|
+
destroy(): void;
|
|
58
|
+
}
|
|
59
|
+
export interface TimerSpec {
|
|
60
|
+
/**
|
|
61
|
+
* Function to run.
|
|
62
|
+
* For async activity, return a promise to allow timer to prevent overlapping runs.
|
|
63
|
+
*/
|
|
64
|
+
runFn: () => any;
|
|
65
|
+
/**
|
|
66
|
+
* Interval between runs, in milliseconds.
|
|
67
|
+
* If a number and `<=0` job will not run.
|
|
68
|
+
* If a function, will be re-evaluated after every timer run.
|
|
69
|
+
* If a string, will be interpreted as an AppConfig key and looked up to determine the value.
|
|
70
|
+
*/
|
|
71
|
+
interval: number | (() => number) | string;
|
|
72
|
+
/**
|
|
73
|
+
* Timeout for action in milliseconds.
|
|
74
|
+
* Like interval, this value may also be specified as a function or a config key.
|
|
75
|
+
* Set to null for no timeout.
|
|
76
|
+
*/
|
|
77
|
+
timeout?: number | (() => number) | string;
|
|
78
|
+
/** Units that the interval arg is specified in. Default is ms. */
|
|
79
|
+
intervalUnits?: number;
|
|
80
|
+
/** Units that the timeout arg is specified in. Default is ms. */
|
|
81
|
+
timeoutUnits?: number;
|
|
82
|
+
/**
|
|
83
|
+
* Initial delay, in milliseconds.
|
|
84
|
+
* If specified as true, the value of the delay will be the same as interval. Default to false.
|
|
85
|
+
*/
|
|
86
|
+
delay?: number | boolean;
|
|
87
|
+
/** Scope to run runFn in. */
|
|
88
|
+
scope?: any;
|
|
89
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare const MILLISECONDS = 1, SECONDS = 1000, MINUTES: number, HOURS: number, DAYS: number, ONE_SECOND = 1000, ONE_MINUTE: number, ONE_HOUR: number, ONE_DAY: number;
|
|
2
|
+
/**
|
|
3
|
+
* Is a Date or UTC time stamp older than a certain amount?
|
|
4
|
+
* Returns true if input time is null.
|
|
5
|
+
*/
|
|
6
|
+
export declare function olderThan(t: Date | number, millis: number): boolean;
|
|
7
|
+
/** Returns midnight browser local time for the provided date, or current date. */
|
|
8
|
+
export declare function startOfDay(date?: Date): Date;
|
|
9
|
+
/** Returns 11:59:59pm browser local time for the provided date, or current date. */
|
|
10
|
+
export declare function endOfDay(date?: Date): Date;
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { Moment, MomentInput } from 'moment';
|
|
2
|
+
/**
|
|
3
|
+
* A Date representation that does not contain time information. Useful for business day or calendar
|
|
4
|
+
* day data where time and time zone should be explicitly ignored. Client-side equivalent of the
|
|
5
|
+
* Java `LocalDate` class.
|
|
6
|
+
*
|
|
7
|
+
* This class is immutable. All methods for manipulation return a new LocalDate instance.
|
|
8
|
+
* For efficiency and to enable strict equality checks, instances of this class are memoized:
|
|
9
|
+
* only a single version of the object will be created and returned for each calendar day,
|
|
10
|
+
* as long as the caller uses one of the *public factory methods*, which they always should!
|
|
11
|
+
*
|
|
12
|
+
* Unit accepted by manipulation methods are ['year', 'quarter', 'month', 'week', 'day', 'date'].
|
|
13
|
+
*/
|
|
14
|
+
export declare class LocalDate {
|
|
15
|
+
private static _instances;
|
|
16
|
+
static VALID_UNITS: string[];
|
|
17
|
+
private _isoString;
|
|
18
|
+
private _moment;
|
|
19
|
+
private _date;
|
|
20
|
+
/**
|
|
21
|
+
* Get an instance of this class.
|
|
22
|
+
* This is the standard way to get an instance of this object from serialized server-side data.
|
|
23
|
+
*
|
|
24
|
+
* @param s - a valid date in 'YYYY-MM-DD' or 'YYYYMMDD' format.
|
|
25
|
+
*/
|
|
26
|
+
static get(s: string): LocalDate;
|
|
27
|
+
/**
|
|
28
|
+
* Get an instance of this class.
|
|
29
|
+
*
|
|
30
|
+
* Note: Applications should favor using the `get()` factory instead of this method.
|
|
31
|
+
* `get()` takes an explicit 'YYYYMMDD' or 'YYYY-MM-DD' format and is the safest way to get
|
|
32
|
+
* a LocalDate.
|
|
33
|
+
*
|
|
34
|
+
* @param val - any string, timestamp, or date parsable by moment.js.
|
|
35
|
+
*/
|
|
36
|
+
static from(val: MomentInput | LocalDate): LocalDate;
|
|
37
|
+
/** LocalDate representing the current day. */
|
|
38
|
+
static today(): LocalDate;
|
|
39
|
+
/** LocalDate representing the current day in the App TimeZone */
|
|
40
|
+
static currentAppDay(): LocalDate;
|
|
41
|
+
/** LocalDate representing the current day in the Server TimeZone */
|
|
42
|
+
static currentServerDay(): LocalDate;
|
|
43
|
+
/** LocalDate representing the next day. */
|
|
44
|
+
static tomorrow(): LocalDate;
|
|
45
|
+
/** LocalDate representing the previous day. */
|
|
46
|
+
static yesterday(): LocalDate;
|
|
47
|
+
/** Is the input value a local Date? */
|
|
48
|
+
static isLocalDate(v: any): boolean;
|
|
49
|
+
get isoString(): string;
|
|
50
|
+
get date(): Date;
|
|
51
|
+
get moment(): Moment;
|
|
52
|
+
get timestamp(): number;
|
|
53
|
+
format(...args: any[]): string;
|
|
54
|
+
dayOfWeek(): string;
|
|
55
|
+
get isToday(): boolean;
|
|
56
|
+
get isWeekday(): boolean;
|
|
57
|
+
get isStartOfMonth(): boolean;
|
|
58
|
+
get isEndOfMonth(): boolean;
|
|
59
|
+
get isStartOfQuarter(): boolean;
|
|
60
|
+
get isEndOfQuarter(): boolean;
|
|
61
|
+
get isStartOfYear(): boolean;
|
|
62
|
+
get isEndOfYear(): boolean;
|
|
63
|
+
toString(): any;
|
|
64
|
+
toJSON(): any;
|
|
65
|
+
valueOf(): any;
|
|
66
|
+
get isLocalDate(): boolean;
|
|
67
|
+
add(value: any, unit?: string): LocalDate;
|
|
68
|
+
subtract(value: any, unit?: string): LocalDate;
|
|
69
|
+
startOf(unit: any): LocalDate;
|
|
70
|
+
startOfMonth(): LocalDate;
|
|
71
|
+
startOfQuarter(): LocalDate;
|
|
72
|
+
startOfYear(): LocalDate;
|
|
73
|
+
endOf(unit: any): LocalDate;
|
|
74
|
+
endOfMonth(): LocalDate;
|
|
75
|
+
endOfQuarter(): LocalDate;
|
|
76
|
+
endOfYear(): LocalDate;
|
|
77
|
+
nextDay(): LocalDate;
|
|
78
|
+
previousDay(): LocalDate;
|
|
79
|
+
nextWeekday(): LocalDate;
|
|
80
|
+
previousWeekday(): LocalDate;
|
|
81
|
+
/** The same date if already a weekday, or the next weekday. */
|
|
82
|
+
currentOrNextWeekday(): LocalDate;
|
|
83
|
+
/** The same date if already a weekday, or the previous weekday. */
|
|
84
|
+
currentOrPreviousWeekday(): LocalDate;
|
|
85
|
+
diff(other: any, unit?: string): number;
|
|
86
|
+
/** @internal - use one of the static factory methods instead. */
|
|
87
|
+
private constructor();
|
|
88
|
+
private ensureUnitValid;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Is the input value a local Date?
|
|
92
|
+
* Convenience alias for LocalDate.isLocalDate()
|
|
93
|
+
*/
|
|
94
|
+
export declare function isLocalDate(val: any): val is LocalDate;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `Array.filter()` function to exclude consecutive separators within Blueprint and AgGrid menus.
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export declare function filterConsecutiveMenuSeparators(): (it: any, idx: number, arr: any[]) => boolean;
|
|
6
|
+
/**
|
|
7
|
+
* `Array.filter()` function to exclude consecutive separators within Toolbars.
|
|
8
|
+
* @internal
|
|
9
|
+
*/
|
|
10
|
+
export declare function filterConsecutiveToolbarSeparators(): (it: any, idx: number, arr: any[]) => boolean;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Decorates a class method so that it is debounced by the specified duration.
|
|
3
|
+
* Based on https://github.com/bvaughn/debounce-decorator.
|
|
4
|
+
*
|
|
5
|
+
* @param duration - milliseconds to debounce.
|
|
6
|
+
*/
|
|
7
|
+
export declare function debounced(duration: number): (target: any, key: any, descriptor: any) => any;
|
|
8
|
+
/**
|
|
9
|
+
* Modify a method or getter so that it will compute once lazily and then cache the results.
|
|
10
|
+
* Not appropriate for methods that take arguments. Typically useful on immutable objects.
|
|
11
|
+
*/
|
|
12
|
+
export declare function computeOnce(target: any, key: any, descriptor: any): any;
|
|
13
|
+
/**
|
|
14
|
+
* Modify a method so that its execution is tracked and timed with a debug message.
|
|
15
|
+
* @see withDebug
|
|
16
|
+
*/
|
|
17
|
+
export declare function logWithDebug(target: any, key: any, descriptor: any): any;
|
|
18
|
+
/**
|
|
19
|
+
* Modify a member so that it is enumerable. Useful for getters, which default to enumerable = false
|
|
20
|
+
*/
|
|
21
|
+
export declare function enumerable(target: any, key: any, descriptor: any): any;
|
|
22
|
+
/**
|
|
23
|
+
* Designate a method or getter as abstract so that it throws if it is called directly
|
|
24
|
+
*/
|
|
25
|
+
export declare function abstract(target: any, key: any, descriptor: any): any;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import ResizeObserver from 'resize-observer-polyfill';
|
|
2
|
+
import { SyntheticEvent } from 'react';
|
|
3
|
+
/**
|
|
4
|
+
* Is this element visible and not within a hidden sub-tree (e.g. hidden tab)?
|
|
5
|
+
* Based on the underlying css 'display' property of all ancestor properties.
|
|
6
|
+
*/
|
|
7
|
+
export declare function isDisplayed(elem: HTMLElement): boolean;
|
|
8
|
+
/**
|
|
9
|
+
* Observe when a dom node's size changes.
|
|
10
|
+
*
|
|
11
|
+
* @param fn - function to be called with the co-ordinates of the node.
|
|
12
|
+
* @param node - The DOM node to observe
|
|
13
|
+
* @param opts - extra options, currently supporting a `debounce` specified in ms.
|
|
14
|
+
* @returns ResizeObserver used to implement this function. Be sure to call disconnect()
|
|
15
|
+
* on this when finished.
|
|
16
|
+
*
|
|
17
|
+
* Unlike the raw ResizeObserver implementation, this function will not run the
|
|
18
|
+
* callback when the dimensions are both changed to 0 or is changed back from 0
|
|
19
|
+
* to a previous size. This is to improve performance by avoiding responding to
|
|
20
|
+
* visibility changes.
|
|
21
|
+
*
|
|
22
|
+
* For a hook that conveniently wraps this function see {@link useOnResize}.
|
|
23
|
+
*/
|
|
24
|
+
export declare function observeResize(fn: (size: DOMRect) => any, node: Element, opts?: {
|
|
25
|
+
debounce?: number;
|
|
26
|
+
}): ResizeObserver;
|
|
27
|
+
/**
|
|
28
|
+
* Observe when a dom node's visibility changes.
|
|
29
|
+
*
|
|
30
|
+
* @param fn - function that takes a single argument with visibility.
|
|
31
|
+
* @param node - The DOM node to observe
|
|
32
|
+
* @returns ResizeObserver used to implement this function. Be sure to call disconnect() on this
|
|
33
|
+
* when finished.
|
|
34
|
+
*
|
|
35
|
+
* For a hook that conveniently wraps this function see {@link useOnVisibleChange}.
|
|
36
|
+
*/
|
|
37
|
+
export declare function observeVisibleChange(fn: (visible: boolean) => any, node: Element): ResizeObserver;
|
|
38
|
+
/**
|
|
39
|
+
* A convenience handler that will call 'stopPropagation'
|
|
40
|
+
* and 'preventDefault' on an event.
|
|
41
|
+
*/
|
|
42
|
+
export declare function consumeEvent(e: Event | SyntheticEvent): void;
|
|
43
|
+
/**
|
|
44
|
+
* A convenience handler that will 'stopPropagation' on an event.
|
|
45
|
+
*/
|
|
46
|
+
export declare function stopPropagation(e: Event | SyntheticEvent): void;
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Get a cached value on an object, creating it if it does not yet exist.
|
|
3
|
+
*
|
|
4
|
+
* @param obj - object of interest. Must have writable properties.
|
|
5
|
+
* @param key - key (property name) to cache value at in object.
|
|
6
|
+
* @param fn - function to generate value if missing.
|
|
7
|
+
* @returns value stored at key
|
|
8
|
+
*/
|
|
9
|
+
export declare function getOrCreate<V>(obj: any, key: any, fn: () => V): V;
|
|
10
|
+
/**
|
|
11
|
+
* Return the first defined argument - intended to allow for multiple levels of fallback values or
|
|
12
|
+
* expressions when evaluating function parameters or configuration object properties.
|
|
13
|
+
*/
|
|
14
|
+
export declare function withDefault<T>(...args: T[]): T;
|
|
15
|
+
export declare function deepFreeze(obj: object): object;
|
|
16
|
+
/**
|
|
17
|
+
* Output a deep copy of an object or array up to a given depth, beyond which nested contents will
|
|
18
|
+
* be replaced by a placeholder string.
|
|
19
|
+
*
|
|
20
|
+
* @param obj - source object to trim
|
|
21
|
+
* @param depth - maximum depth within the object tree that will be returned.
|
|
22
|
+
*/
|
|
23
|
+
export declare function trimToDepth(obj: any, depth?: number): any;
|
|
24
|
+
/**
|
|
25
|
+
* Determine if an object/value can be parsed successfully into JSON.
|
|
26
|
+
*/
|
|
27
|
+
export declare function isJSON(obj: any): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Throw an exception if a condition evaluates as truthy.
|
|
30
|
+
*/
|
|
31
|
+
export declare function throwIf(condition: any, message: unknown): void;
|
|
32
|
+
/**
|
|
33
|
+
* Log a warning to the console if a condition evaluates as truthy.
|
|
34
|
+
*/
|
|
35
|
+
export declare function warnIf(condition: any, message: any): void;
|
|
36
|
+
/**
|
|
37
|
+
* Log an error to the console if a condition evaluates as truthy.
|
|
38
|
+
*/
|
|
39
|
+
export declare function errorIf(condition: any, message: any): void;
|
|
40
|
+
export interface APIWarnOptions {
|
|
41
|
+
/**
|
|
42
|
+
* If provided and undefined, this method will be a no-op.
|
|
43
|
+
* Useful for testing if a parameter has been provided in caller.
|
|
44
|
+
*/
|
|
45
|
+
test?: any;
|
|
46
|
+
/** Version when this API will no longer be supported or this warning should be removed. */
|
|
47
|
+
v?: string;
|
|
48
|
+
/** An additional message. Can contain suggestions for alternatives. */
|
|
49
|
+
msg?: string;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Document and prevent usage of a removed parameter.
|
|
53
|
+
*/
|
|
54
|
+
export declare function apiRemoved(name: string, opts?: APIWarnOptions): void;
|
|
55
|
+
export declare function apiDeprecated(name: string, opts?: APIWarnOptions): void;
|
|
56
|
+
/**
|
|
57
|
+
* Throw an exception if the provided object or collection is empty, as per lodash isEmpty().
|
|
58
|
+
*
|
|
59
|
+
* @param obj - object or array to test.
|
|
60
|
+
* @param exceptionMessage - error to throw if empty.
|
|
61
|
+
*/
|
|
62
|
+
export declare function ensureNotEmpty(obj: any, exceptionMessage?: string): void;
|
|
63
|
+
/**
|
|
64
|
+
* Throw an exception if an array contains any duplicate, non-unique items.
|
|
65
|
+
*
|
|
66
|
+
* @param arr - the array to test.
|
|
67
|
+
* @param exceptionMessage - error to throw if non-unique values found.
|
|
68
|
+
*/
|
|
69
|
+
export declare function ensureUnique(arr: any[], exceptionMessage?: string): void;
|
|
70
|
+
/**
|
|
71
|
+
* Throw an exception if an array contains any items with non-unique values for the provided key.
|
|
72
|
+
*
|
|
73
|
+
* @param arr - the array to test.
|
|
74
|
+
* @param uniqueKey - the property that must hold a unique value for each item.
|
|
75
|
+
* @param exceptionMessage - error to throw if non-unique values found.
|
|
76
|
+
*/
|
|
77
|
+
export declare function ensureUniqueBy(arr: any[], uniqueKey: string, exceptionMessage?: string): void;
|
|
78
|
+
/**
|
|
79
|
+
* Returns the singular version of the plural word passed to it.
|
|
80
|
+
*/
|
|
81
|
+
export declare function singularize(s: string): string;
|
|
82
|
+
/**
|
|
83
|
+
* Returns the plural version of the singular word passed to it.
|
|
84
|
+
*
|
|
85
|
+
* @param s - the string to pluralize.
|
|
86
|
+
* @param count - if provided, will pluralize to match this number
|
|
87
|
+
* @param includeCount - include count in the output
|
|
88
|
+
*/
|
|
89
|
+
export declare function pluralize(s: string, count?: number, includeCount?: boolean): string;
|
|
90
|
+
/**
|
|
91
|
+
* Returns the number with an ordinal suffix (i.e. 1 becomes '1st', 11 becomes '11th').
|
|
92
|
+
*
|
|
93
|
+
* @param n - the number to ordinalize
|
|
94
|
+
*/
|
|
95
|
+
export declare function ordinalize(n: number): string;
|
|
96
|
+
/**
|
|
97
|
+
* Remove when lodash adds Set/Map support.
|
|
98
|
+
*/
|
|
99
|
+
export declare function findIn<T>(collection: Set<T> | Map<unknown, T>, fn: (it: T) => boolean): T;
|
|
100
|
+
/**
|
|
101
|
+
* A function to be passed to `array.filter()` that excludes consecutive items that match the
|
|
102
|
+
* provided predicate. Matches that would ultimately appear at the start or end of the
|
|
103
|
+
* filtered array are also removed.
|
|
104
|
+
*
|
|
105
|
+
* Useful for removing separators that have become extraneous when the items they were separating
|
|
106
|
+
* have been removed.
|
|
107
|
+
*/
|
|
108
|
+
export declare function filterConsecutive<T>(predicate: (it: T) => boolean): (it: T, idx: number, arr: T[]) => boolean;
|
|
109
|
+
/**
|
|
110
|
+
* Return value passed or the result of executing it, if it is a function.
|
|
111
|
+
*/
|
|
112
|
+
export declare function executeIfFunction(v: any): any;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Track a function execution with console.log.
|
|
3
|
+
*
|
|
4
|
+
* This method will log the provided message(s) with timing information in a single message *after*
|
|
5
|
+
* the tracked function returns.
|
|
6
|
+
*
|
|
7
|
+
* If the function passed to this util returns a Promise, it will wait until the Promise resolves
|
|
8
|
+
* or completes to finish its logging. The actual object returned by the tracked function will
|
|
9
|
+
* always be returned directly to the caller.
|
|
10
|
+
*
|
|
11
|
+
* @param msgs - message(s) to output after the execution "completes"
|
|
12
|
+
* @param fn - function to execute
|
|
13
|
+
* @param source - class, function or string to label the source of the message
|
|
14
|
+
*/
|
|
15
|
+
export declare function withInfo<T>(msgs: string[] | string, fn: () => T, source?: any): T;
|
|
16
|
+
/**
|
|
17
|
+
* Track a function execution with console.debug.
|
|
18
|
+
* @see withInfo
|
|
19
|
+
*/
|
|
20
|
+
export declare function withDebug<T>(msgs: string[] | string, fn: () => T, source?: any): T;
|
|
21
|
+
/**
|
|
22
|
+
* Log a message with console.log.
|
|
23
|
+
*
|
|
24
|
+
* @param msgs - message(s) to output
|
|
25
|
+
* @param source - class, function or string to label the source of the message
|
|
26
|
+
*/
|
|
27
|
+
export declare function logInfo(msgs: string[] | string, source?: any): any;
|
|
28
|
+
/**
|
|
29
|
+
* Log a message with console.debug.
|
|
30
|
+
* @see logInfo
|
|
31
|
+
*/
|
|
32
|
+
export declare function logDebug(msgs: string[] | string, source?: any): any;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Check if a version string falls within a range
|
|
3
|
+
*/
|
|
4
|
+
export declare function checkVersion(version: string, minVersion: string, maxVersion: string): boolean;
|
|
5
|
+
/**
|
|
6
|
+
* Check if a version string meets a minimum version
|
|
7
|
+
*/
|
|
8
|
+
export declare function checkMinVersion(version: string, minVersion: string): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Check if a version string meets a maximum version
|
|
11
|
+
*/
|
|
12
|
+
export declare function checkMaxVersion(version: string, maxVersion: string): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Normalizes a Java/Maven style x.0-SNAPSHOT version to a semver compatible x.0.0-SNAPSHOT string.
|
|
15
|
+
* @returns normalized version, if input matched as above, or input version unmodified.
|
|
16
|
+
*/
|
|
17
|
+
export declare function normalizeVersion(version: string): string;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generate a string with one or more CSS classes to apply to a component, typically concatenating a
|
|
3
|
+
* standardized base className with any instance-specific getClassName(s) provided via props and any
|
|
4
|
+
* optional / conditional class names determined at render-time.
|
|
5
|
+
*
|
|
6
|
+
* Components should call this to produce a combined class list and apply it to their outermost
|
|
7
|
+
* (or otherwise most appropriate) rendered component.
|
|
8
|
+
*
|
|
9
|
+
* @param baseName - base class name for the component.
|
|
10
|
+
* @param props - component props.
|
|
11
|
+
* @param extraNames - optional, additional class names to append.
|
|
12
|
+
* @returns concatenated, space-delimited class name appropriate for html className attribute.
|
|
13
|
+
*/
|
|
14
|
+
export declare function getClassName(baseName: string, props: any, ...extraNames: string[]): string;
|