From 49d1fcc2afeabf81d0cdfc2c71e54721e7cc00b2 Mon Sep 17 00:00:00 2001 From: lyonsil Date: Mon, 25 Nov 2024 20:46:31 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@03846fc69b28ebcefb12030c2695865decee0ba3=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_client_services_rpc_client_.default.html | 18 ++++---- .../_main_services_rpc_server_.default.html | 14 +++--- ...vices_rpc_websocket_listener_.default.html | 18 ++++---- ...execution_token_model_.ExecutionToken.html | 6 +-- ..._renderer_web_socket_service_.default.html | 30 ++++++------- ...rer_xml_http_request_service_.default.html | 44 +++++++++---------- .../_shared_log_error_model_.default.html | 4 +- ..._model_.BaseProjectDataProviderEngine.html | 4 +- ...ider_engine_model_.DataProviderEngine.html | 4 +- ..._network_event_emitter_model_.default.html | 20 ++++----- ...eringProjectDataProviderEngineFactory.html | 12 ++--- ...gine_model_.ProjectDataProviderEngine.html | 4 +- ...eb_view_factory_model_.WebViewFactory.html | 12 ++--- ...t_settings_document_combiner_.default.html | 38 ++++++++-------- ...tings_document_combiner_base_.default.html | 34 +++++++------- ...s_node_file_system_service_.EntryType.html | 4 +- ...ared_data_rpc_model_.ConnectionStatus.html | 8 ++-- ...shared_global_this_model_.ProcessType.html | 4 +- ...vileges_model_.ElevatedPrivilegeNames.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 ++-- papi-dts/functions/__papi_backend_.fetch.html | 2 +- .../functions/__papi_frontend_.fetch.html | 2 +- ...s_web_socket_factory_.createWebSocket.html | 2 +- ...e_service_.buildExtensionPathFromName.html | 2 +- ...ion_storage_service_.setExtensionUris.html | 2 +- ...es_node_file_system_service_.copyFile.html | 2 +- ...s_node_file_system_service_.createDir.html | 2 +- ...s_node_file_system_service_.deleteDir.html | 2 +- ..._node_file_system_service_.deleteFile.html | 2 +- ...es_node_file_system_service_.getStats.html | 2 +- ...es_node_file_system_service_.moveFile.html | 2 +- ...ces_node_file_system_service_.readDir.html | 2 +- ...e_file_system_service_.readFileBinary.html | 2 +- ...ode_file_system_service_.readFileText.html | 2 +- ...vices_node_file_system_service_.touch.html | 2 +- ...s_node_file_system_service_.writeFile.html | 2 +- .../_node_utils_crypto_util_.createNonce.html | 2 +- .../_node_utils_crypto_util_.createUuid.html | 2 +- ...s_crypto_util_.generateHashFromBuffer.html | 2 +- .../_node_utils_util_.getAppDir.html | 2 +- .../_node_utils_util_.getPathFromUri.html | 2 +- ...ls_util_.isNoisyDevModeEnvVariableSet.html | 2 +- .../_node_utils_util_.joinUriPaths.html | 2 +- .../_node_utils_util_.resolveHtmlPath.html | 2 +- ...dialog_base_data_.hookUpDialogService.html | 2 +- ...rs_create_use_data_hook_util_.default.html | 2 +- ...use_network_object_hook_util_.default.html | 2 +- ...oks_papi_hooks_use_data_hook_.default.html | 2 +- ...hooks_use_data_provider_hook_.default.html | 2 +- ...use_data_provider_multi_hook_.default.html | 2 +- ...oks_use_dialog_callback_hook_.default.html | 4 +- ...s_use_localized_strings_hook_.default.html | 2 +- ..._hooks_use_project_data_hook_.default.html | 2 +- ...e_project_data_provider_hook_.default.html | 2 +- ...oks_use_project_setting_hook_.default.html | 2 +- ...se_scroll_group_scr_ref_hook_.default.html | 2 +- ..._papi_hooks_use_setting_hook_.default.html | 2 +- ...use_web_view_controller_hook_.default.html | 2 +- ...service_.blockWebSocketsToPapiNetwork.html | 2 +- ...oll_group_service_host_.getScrRefSync.html | 2 +- ...group_service_host_.onDidUpdateScrRef.html | 2 +- ...oll_group_service_host_.setScrRefSync.html | 2 +- ...service_host_.startScrollGroupService.html | 2 +- ...d_data_rpc_model_.createErrorResponse.html | 2 +- ..._shared_data_rpc_model_.createRequest.html | 2 +- ...data_rpc_model_.createSuccessResponse.html | 2 +- ...ed_data_rpc_model_.deserializeMessage.html | 2 +- ..._shared_data_rpc_model_.fixupResponse.html | 2 +- ...ared_data_rpc_model_.requestWithRetry.html | 2 +- ...ata_rpc_model_.sendPayloadToWebSocket.html | 2 +- ...tDataProviderDataTypeFromFunctionName.html | 2 +- ...e_model_.areProjectInterfacesIncluded.html | 2 +- ...oviderFactoryMetadataInfoMinimalMatch.html | 2 +- ....getPDPFactoryIdFromNetworkObjectName.html | 2 +- ....getPDPFactoryNetworkObjectNameFromId.html | 2 +- ...up_service_model_.internalGetMetadata.html | 2 +- ...tMetadataForProjectParametersToFilter.html | 2 +- ...nd_service_.createSendCommandFunction.html | 2 +- ...ices_command_service_.registerCommand.html | 2 +- ...services_command_service_.sendCommand.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ect_service_.onDidCreateNetworkObject.html | 2 +- ...ct_service_.onDidDisposeNetworkObject.html | 2 +- ...twork_object_service_.overrideDispose.html | 2 +- ...rk_service_.createNetworkEventEmitter.html | 2 +- ...etwork_service_.createRequestFunction.html | 2 +- ...ices_network_service_.getNetworkEvent.html | 2 +- ..._services_network_service_.initialize.html | 2 +- ...twork_service_.registerRequestHandler.html | 2 +- ...red_services_network_service_.request.html | 2 +- ...ed_services_network_service_.shutdown.html | 2 +- ...es_project_data_provider_service_.get.html | 2 +- ...isterProjectDataProviderEngineFactory.html | 2 +- ...tingsContributionsByProjectInterfaces.html | 2 +- ...rpc_handler_factory_.createRpcHandler.html | 2 +- ...w_service_model_.getWebViewController.html | 2 +- ...e_model_.getWebViewControllerObjectId.html | 2 +- ...e_model_.getWebViewMessageRequestType.html | 2 +- ...d_utils_internal_util_.getProcessType.html | 2 +- ..._shared_utils_internal_util_.isClient.html | 2 +- ..._utils_internal_util_.isExtensionHost.html | 2 +- ...hared_utils_internal_util_.isRenderer.html | 2 +- ..._shared_utils_internal_util_.isServer.html | 2 +- .../_shared_utils_util_.bindClassMethods.html | 2 +- ...ed_utils_util_.deserializeRequestType.html | 2 +- ...tils_util_.getModuleSimilarApiMessage.html | 2 +- .../_shared_utils_util_.newNonce.html | 2 +- ...ared_utils_util_.serializeRequestType.html | 2 +- .../functions/getSavedWebViewDefinition.html | 2 +- .../getSavedWebViewDefinitionById.html | 2 +- papi-dts/functions/getWebViewState.html | 2 +- papi-dts/functions/resetWebViewState.html | 2 +- papi-dts/functions/setWebViewState.html | 2 +- .../functions/updateWebViewDefinition.html | 2 +- .../updateWebViewDefinitionById.html | 2 +- .../useWebViewScrollGroupScrRef.html | 2 +- papi-dts/functions/useWebViewState.html | 2 +- papi-dts/functions/webViewComponent.html | 2 +- ...types_extension_interface_.IExtension.html | 6 +-- ...rage_service_.ExtensionStorageService.html | 12 ++--- .../_papi_shared_types_.CommandHandlers.html | 8 ++-- .../_papi_shared_types_.DataProviders.html | 4 +- ..._types_.ProjectDataProviderInterfaces.html | 4 +- ...api_shared_types_.ProjectSettingTypes.html | 10 ++--- .../_papi_shared_types_.SettingTypes.html | 12 ++--- ...papi_shared_types_.WebViewControllers.html | 4 +- ..._dialog_definition_model_.DialogTypes.html | 4 +- ..._docking_framework_model_.FloatLayout.html | 6 +-- ..._docking_framework_model_.PanelLayout.html | 6 +-- ...ls_docking_framework_model_.TabLayout.html | 4 +- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +-- ...el_.IProjectDataProviderEngineFactory.html | 6 +-- ...a_provider_factory_interface_.default.html | 8 ++-- ...red_models_rpc_interface_.IRpcHandler.html | 12 ++--- ...ls_rpc_interface_.IRpcMethodRegistrar.html | 16 +++---- ...der_model_.IDisposableWebViewProvider.html | 8 ++-- ...der_model_.IRegisteredWebViewProvider.html | 6 +-- ...view_provider_model_.IWebViewProvider.html | 8 ++-- ...provider_service_.DataProviderService.html | 12 ++--- ...s_dialog_service_model_.DialogService.html | 6 +-- ...ces_internet_service_.InternetService.html | 4 +- ..._service_.MinimalNetworkObjectService.html | 6 +-- ..._object_service_.NetworkObjectService.html | 10 ++--- ...s_network_service_.PapiNetworkService.html | 6 +-- ...PapiBackendProjectDataProviderService.html | 6 +-- ...apiFrontendProjectDataProviderService.html | 4 +- ...ervice_model_.IProjectSettingsService.html | 10 ++--- ...vice_model_.IScrollGroupRemoteService.html | 6 +-- ...up_service_model_.IScrollGroupService.html | 8 ++-- ...r_service_.PapiWebViewProviderService.html | 10 ++--- ...vider_service_.WebViewProviderService.html | 12 ++--- ...iew_service_model_.WebViewServiceType.html | 20 ++++----- papi-dts/modules/__papi_backend_.html | 2 +- papi-dts/modules/__papi_core_.html | 2 +- papi-dts/modules/__papi_frontend_.html | 2 +- papi-dts/modules/__papi_frontend_react_.html | 2 +- .../modules/_client_services_rpc_client_.html | 2 +- .../_client_services_web_socket_factory_.html | 2 +- ...client_services_web_socket_interface_.html | 2 +- ...s_extension_activation_context_model_.html | 2 +- ..._extension_types_extension_interface_.html | 2 +- ...nsion_types_extension_manifest_model_.html | 2 +- ...ices_extension_host_web_socket_model_.html | 2 +- ...t_services_extension_storage_service_.html | 2 +- .../modules/_main_services_rpc_server_.html | 2 +- ...main_services_rpc_websocket_listener_.html | 2 +- .../_node_models_execution_token_model_.html | 2 +- ...ode_services_execution_token_service_.html | 2 +- ...de_services_node_file_system_service_.html | 2 +- .../modules/_node_utils_crypto_util_.html | 2 +- papi-dts/modules/_node_utils_util_.html | 2 +- papi-dts/modules/_papi_shared_types_.html | 2 +- ..._components_dialogs_dialog_base_data_.html | 2 +- ...ents_dialogs_dialog_definition_model_.html | 2 +- ...generators_create_use_data_hook_util_.html | 2 +- ..._create_use_network_object_hook_util_.html | 2 +- .../_renderer_hooks_papi_hooks_index_.html | 2 +- ...derer_hooks_papi_hooks_use_data_hook_.html | 2 +- ...ks_papi_hooks_use_data_provider_hook_.html | 2 +- ...i_hooks_use_data_provider_multi_hook_.html | 2 +- ..._papi_hooks_use_dialog_callback_hook_.html | 2 +- ...api_hooks_use_localized_strings_hook_.html | 2 +- ...oks_papi_hooks_use_project_data_hook_.html | 2 +- ...hooks_use_project_data_provider_hook_.html | 2 +- ..._papi_hooks_use_project_setting_hook_.html | 2 +- ..._hooks_use_scroll_group_scr_ref_hook_.html | 2 +- ...er_hooks_papi_hooks_use_setting_hook_.html | 2 +- ...i_hooks_use_web_view_controller_hook_.html | 2 +- ...services_renderer_web_socket_service_.html | 2 +- ...es_renderer_xml_http_request_service_.html | 2 +- ...r_services_scroll_group_service_host_.html | 2 +- .../_shared_data_file_system_model_.html | 2 +- .../modules/_shared_data_platform_data_.html | 2 +- papi-dts/modules/_shared_data_rpc_model_.html | 2 +- .../modules/_shared_global_this_model_.html | 2 +- .../modules/_shared_log_error_model_.html | 2 +- ...e_project_data_provider_engine_model_.html | 2 +- ...odels_create_process_privilege_model_.html | 2 +- ...ed_models_data_provider_engine_model_.html | 2 +- ...hared_models_data_provider_interface_.html | 2 +- .../_shared_models_data_provider_model_.html | 2 +- .../_shared_models_dialog_options_model_.html | 2 +- ...hared_models_docking_framework_model_.html | 2 +- ...red_models_elevated_privileges_model_.html | 2 +- ...ed_models_extension_basic_data_model_.html | 2 +- ...tract_data_provider_data_types_model_.html | 2 +- ...ls_manage_extensions_privilege_model_.html | 2 +- .../_shared_models_network_object_model_.html | 2 +- ..._network_object_status_service_model_.html | 2 +- ...els_papi_network_event_emitter_model_.html | 2 +- ...t_data_provider_engine_factory_model_.html | 2 +- ...s_project_data_provider_engine_model_.html | 2 +- ...ject_data_provider_factory_interface_.html | 2 +- ...d_models_project_data_provider_model_.html | 2 +- ..._models_project_lookup_service_model_.html | 2 +- ...shared_models_project_metadata_model_.html | 2 +- .../_shared_models_rpc_interface_.html | 2 +- ...shared_models_web_view_factory_model_.html | 2 +- .../_shared_models_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- ...hared_services_data_provider_service_.html | 2 +- .../_shared_services_dialog_service_.html | 2 +- ...shared_services_dialog_service_model_.html | 2 +- .../_shared_services_internet_service_.html | 2 +- ...shared_services_localization_service_.html | 2 +- ..._services_localization_service_model_.html | 2 +- .../_shared_services_logger_service_.html | 2 +- .../_shared_services_menu_data_service_.html | 2 +- ...red_services_menu_data_service_model_.html | 2 +- ...ared_services_network_object_service_.html | 2 +- ...rvices_network_object_status_service_.html | 2 +- .../_shared_services_network_service_.html | 2 +- ...rvices_project_data_provider_service_.html | 2 +- ...ared_services_project_lookup_service_.html | 2 +- ...ed_services_project_settings_service_.html | 2 +- ...vices_project_settings_service_model_.html | 2 +- ..._shared_services_rpc_handler_factory_.html | 2 +- ...shared_services_scroll_group_service_.html | 2 +- ..._services_scroll_group_service_model_.html | 2 +- .../_shared_services_settings_service_.html | 2 +- ...ared_services_settings_service_model_.html | 2 +- ...d_services_web_view_provider_service_.html | 2 +- .../_shared_services_web_view_service_.html | 2 +- ...ared_services_web_view_service_model_.html | 2 +- .../modules/_shared_utils_internal_util_.html | 2 +- ...s_project_settings_document_combiner_.html | 2 +- ...tils_settings_document_combiner_base_.html | 2 +- papi-dts/modules/_shared_utils_util_.html | 2 +- papi-dts/types/__papi_frontend_.Papi.html | 2 +- ...ices_web_socket_interface_.IWebSocket.html | 2 +- ...ext_model_.ExecutionActivationContext.html | 2 +- ...ion_manifest_model_.ExtensionManifest.html | 2 +- ...ices_rpc_server_.PropagateEventMethod.html | 2 +- ...ution_token_model_.ExecutionTokenType.html | 2 +- ...file_system_service_.DirectoryEntries.html | 2 +- .../_papi_shared_types_.CommandNames.html | 2 +- ..._papi_shared_types_.DataProviderNames.html | 2 +- ..._papi_shared_types_.DataProviderTypes.html | 2 +- ...shared_types_.DisposableDataProviders.html | 2 +- ...hared_types_.IBaseProjectDataProvider.html | 2 +- ...pi_shared_types_.IProjectDataProvider.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- ...ared_types_.ProjectInterfaceDataTypes.html | 2 +- ..._papi_shared_types_.ProjectInterfaces.html | 2 +- ...api_shared_types_.ProjectSettingNames.html | 2 +- .../_papi_shared_types_.SettingNames.html | 2 +- .../_papi_shared_types_.StuffDataTypes.html | 2 +- ..._shared_types_.WebViewControllerTypes.html | 2 +- ...ojectDataProviderEngineSettingMethods.html | 2 +- ...ialog_base_data_.DialogDefinitionBase.html | 2 +- ...dialogs_dialog_base_data_.DialogProps.html | 6 +-- ...log_definition_model_.DialogDataTypes.html | 2 +- ...og_definition_model_.DialogDefinition.html | 2 +- ...alog_definition_model_.DialogTabTypes.html | 2 +- ...ition_model_.ProjectDialogOptionsBase.html | 2 +- ...ition_model_.SelectBooksDialogOptions.html | 2 +- ..._.SelectMultipleProjectsDialogOptions.html | 2 +- ...ion_model_.SelectProjectDialogOptions.html | 2 +- ...llback_hook_.UseDialogCallbackOptions.html | 2 +- .../_shared_data_file_system_model_.Uri.html | 2 +- .../_shared_data_rpc_model_.EventHandler.html | 2 +- ...ata_rpc_model_.InternalRequestHandler.html | 2 +- .../_shared_data_rpc_model_.RequestId.html | 2 +- ..._shared_data_rpc_model_.RequestParams.html | 2 +- ...model_.IBaseProjectDataProviderEngine.html | 2 +- ...rocess_privilege_model_.CreateProcess.html | 2 +- ..._privilege_model_.OperatingSystemData.html | 2 +- ...process_privilege_model_.PlatformFork.html | 2 +- ...rocess_privilege_model_.PlatformSpawn.html | 2 +- ...model_.DataProviderEngineNotifyUpdate.html | 2 +- ...ovider_engine_model_.WithNotifyUpdate.html | 2 +- ...s_data_provider_engine_model_.default.html | 2 +- ...er_interface_.IDisposableDataProvider.html | 2 +- ...dels_data_provider_interface_.default.html | 2 +- ..._provider_model_.DataProviderDataType.html | 2 +- ...provider_model_.DataProviderDataTypes.html | 2 +- ...ta_provider_model_.DataProviderGetter.html | 2 +- ...a_provider_model_.DataProviderGetters.html | 2 +- ...ta_provider_model_.DataProviderSetter.html | 2 +- ...a_provider_model_.DataProviderSetters.html | 2 +- ...rovider_model_.DataProviderSubscriber.html | 2 +- ..._model_.DataProviderSubscriberOptions.html | 2 +- ...ovider_model_.DataProviderSubscribers.html | 2 +- ...model_.DataProviderUpdateInstructions.html | 2 +- ...ls_data_provider_model_.DataTypeNames.html | 2 +- ...d_models_data_provider_model_.default.html | 2 +- ...dels_dialog_options_model_.DialogData.html | 2 +- ...s_dialog_options_model_.DialogOptions.html | 2 +- ...ocking_framework_model_.FloatPosition.html | 2 +- ...ls_docking_framework_model_.FloatSize.html | 2 +- ...odels_docking_framework_model_.Layout.html | 2 +- ...framework_model_.OnLayoutChangeRCDock.html | 2 +- ...cking_framework_model_.PanelDirection.html | 2 +- ...cking_framework_model_.PapiDockLayout.html | 2 +- ...docking_framework_model_.SavedTabInfo.html | 2 +- ...dels_docking_framework_model_.TabInfo.html | 2 +- ...ls_docking_framework_model_.TabLoader.html | 2 +- ...els_docking_framework_model_.TabSaver.html | 2 +- ...king_framework_model_.WebViewTabProps.html | 2 +- ..._privileges_model_.ElevatedPrivileges.html | 2 +- ..._basic_data_model_.ExtensionBasicData.html | 2 +- ...ta_provider_data_types_model_.default.html | 2 +- ...ilege_model_.DisableExtensionFunction.html | 2 +- ...vilege_model_.EnableExtensionFunction.html | 2 +- ..._privilege_model_.ExtensionIdentifier.html | 2 +- ...model_.GetInstalledExtensionsFunction.html | 2 +- ...xtensions_privilege_model_.HashValues.html | 2 +- ...ilege_model_.InstallExtensionFunction.html | 2 +- ..._privilege_model_.InstalledExtensions.html | 2 +- ...ons_privilege_model_.ManageExtensions.html | 2 +- ...object_model_.DisposableNetworkObject.html | 2 +- ...ject_model_.LocalObjectToProxyCreator.html | 2 +- ...s_network_object_model_.NetworkObject.html | 2 +- ...rk_object_model_.NetworkObjectDetails.html | 2 +- ...twork_object_model_.NetworkableObject.html | 2 +- ...ine_model_.IProjectDataProviderEngine.html | 2 +- ...terface_.ProjectMetadataFilterOptions.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...ider_model_.MandatoryProjectDataTypes.html | 2 +- ...ataProviderEngineExtensionDataMethods.html | 4 +- ...rvice_model_.ProjectLookupServiceType.html | 12 ++--- ...rojectDataProviderFactoryMetadataInfo.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...el_.ProjectMetadataWithoutFactoryInfo.html | 2 +- ...view_model_.GetSavedWebViewDefinition.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...el_.SavedWebViewDefinitionOmittedKeys.html | 2 +- ...b_view_model_.UpdateWebViewDefinition.html | 2 +- ...odel_.UseWebViewScrollGroupScrRefHook.html | 2 +- ...s_web_view_model_.UseWebViewStateHook.html | 2 +- ...els_web_view_model_.WebViewDefinition.html | 2 +- ...web_view_model_.WebViewDefinitionBase.html | 2 +- ...web_view_model_.WebViewDefinitionHtml.html | 2 +- ...eb_view_model_.WebViewDefinitionReact.html | 2 +- ..._web_view_model_.WebViewDefinitionURL.html | 2 +- ....WebViewDefinitionUpdatableProperties.html | 2 +- ...ew_model_.WebViewDefinitionUpdateInfo.html | 2 +- ...ared_models_web_view_model_.WebViewId.html | 2 +- ...d_models_web_view_model_.WebViewProps.html | 2 +- ...ed_models_web_view_model_.WebViewType.html | 2 +- ...ommand_service_.moduleSummaryComments.html | 2 +- ...n_service_model_.ILocalizationService.html | 6 +-- ...ation_service_model_.LocalizationData.html | 2 +- ...vice_model_.LocalizationDataDataTypes.html | 2 +- ...n_service_model_.LocalizationSelector.html | 2 +- ..._service_model_.LocalizationSelectors.html | 2 +- ..._data_service_model_.IMenuDataService.html | 16 +++---- ...data_service_model_.MenuDataDataTypes.html | 2 +- ...e_model_.AllProjectSettingsValidators.html | 2 +- ...ervice_model_.ProjectSettingValidator.html | 2 +- ...l_.SimultaneousProjectSettingsChanges.html | 2 +- ...roup_service_model_.ScrollGroupScrRef.html | 2 +- ..._service_model_.ScrollGroupUpdateInfo.html | 2 +- ...ttings_service_model_.AllSettingsData.html | 2 +- ..._service_model_.AllSettingsValidators.html | 2 +- ...tings_service_model_.ISettingsService.html | 14 +++--- ...tings_service_model_.SettingDataTypes.html | 2 +- ...tings_service_model_.SettingValidator.html | 2 +- ...view_service_model_.CloseWebViewEvent.html | 2 +- ..._view_service_model_.OpenWebViewEvent.html | 2 +- ...iew_service_model_.UpdateWebViewEvent.html | 2 +- ...e_model_.WebViewMessageRequestHandler.html | 2 +- ...ment_combiner_.AllProjectSettingsInfo.html | 2 +- ...alizedProjectSettingsContributionInfo.html | 2 +- ...document_combiner_.ProjectSettingInfo.html | 2 +- ...iner_.ProjectSettingsContributionInfo.html | 2 +- ...cument_combiner_base_.AllSettingsInfo.html | 2 +- ...se_.LocalizedSettingsContributionInfo.html | 2 +- ...s_document_combiner_base_.SettingInfo.html | 2 +- ...mbiner_base_.SettingsContributionInfo.html | 2 +- .../_shared_utils_util_.RequestType.html | 2 +- ...red_utils_util_.SerializedRequestType.html | 2 +- ...ackend_.BaseProjectDataProviderEngine.html | 2 +- .../__papi_backend_.DataProviderEngine.html | 2 +- ...eringProjectDataProviderEngineFactory.html | 2 +- ...pi_backend_.ProjectDataProviderEngine.html | 2 +- .../__papi_backend_.WebViewFactory.html | 2 +- .../variables/__papi_backend_.commands.html | 2 +- .../__papi_backend_.dataProviders.html | 2 +- .../variables/__papi_backend_.default.html | 2 +- .../variables/__papi_backend_.dialogs.html | 2 +- .../variables/__papi_backend_.internet.html | 2 +- .../__papi_backend_.localization.html | 2 +- .../variables/__papi_backend_.logger.html | 2 +- .../variables/__papi_backend_.menuData.html | 2 +- .../variables/__papi_backend_.network.html | 2 +- .../__papi_backend_.networkObjectStatus.html | 2 +- .../__papi_backend_.networkObjects.html | 2 +- .../__papi_backend_.projectDataProviders.html | 2 +- .../__papi_backend_.projectLookup.html | 2 +- .../__papi_backend_.projectSettings.html | 2 +- .../__papi_backend_.scrollGroups.html | 2 +- .../variables/__papi_backend_.settings.html | 2 +- .../variables/__papi_backend_.storage.html | 2 +- .../__papi_backend_.webViewProviders.html | 2 +- .../variables/__papi_backend_.webViews.html | 2 +- papi-dts/variables/__papi_core_.default.html | 2 +- .../variables/__papi_frontend_.WebSocket.html | 2 +- .../__papi_frontend_.XMLHttpRequest.html | 2 +- .../variables/__papi_frontend_.commands.html | 2 +- .../__papi_frontend_.dataProviders.html | 2 +- .../variables/__papi_frontend_.default.html | 2 +- .../variables/__papi_frontend_.dialogs.html | 2 +- .../variables/__papi_frontend_.internet.html | 2 +- .../__papi_frontend_.localization.html | 2 +- .../variables/__papi_frontend_.logger.html | 2 +- .../variables/__papi_frontend_.menuData.html | 2 +- .../variables/__papi_frontend_.network.html | 2 +- ...__papi_frontend_.projectDataProviders.html | 2 +- .../__papi_frontend_.projectLookup.html | 2 +- .../variables/__papi_frontend_.react.html | 2 +- .../__papi_frontend_.scrollGroups.html | 2 +- .../variables/__papi_frontend_.settings.html | 2 +- .../variables/__papi_frontend_.webViews.html | 2 +- ...es_extension_storage_service_.default.html | 2 +- ...ices_execution_token_service_.default.html | 2 +- .../_node_utils_util_.FILE_PROTOCOL.html | 2 +- .../_node_utils_util_.RESOURCES_PROTOCOL.html | 2 +- ...nts_dialogs_dialog_base_data_.default.html | 2 +- ...ition_model_.SELECT_BOOKS_DIALOG_TYPE.html | 2 +- ....SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html | 2 +- ...ion_model_.SELECT_PROJECT_DIALOG_TYPE.html | 2 +- ...service_host_.availableScrollGroupIds.html | 2 +- ...orm_data_.DEV_MODE_RENDERER_INDICATOR.html | 2 +- ...ata_platform_data_.PLATFORM_NAMESPACE.html | 2 +- ...ared_data_rpc_model_.CATEGORY_COMMAND.html | 2 +- .../_shared_data_rpc_model_.GET_METHODS.html | 2 +- ...hared_data_rpc_model_.REGISTER_METHOD.html | 2 +- ...red_data_rpc_model_.UNREGISTER_METHOD.html | 2 +- ...shared_data_rpc_model_.WEBSOCKET_PORT.html | 2 +- ...LOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html | 2 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...ry_interface_.PDP_FACTORY_OBJECT_TYPE.html | 2 +- ...odel_.PROJECT_INTERFACE_PLATFORM_BASE.html | 2 +- ...RK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html | 2 +- ...rvice_model_.projectLookupServiceBase.html | 2 +- ...ce_model_.testingProjectLookupService.html | 2 +- ...SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html | 2 +- ...EW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html | 2 +- ...rvices_data_provider_service_.default.html | 2 +- ...ared_services_dialog_service_.default.html | 2 +- ...dialog_service_model_.CATEGORY_DIALOG.html | 2 +- ...ed_services_internet_service_.default.html | 2 +- ...ervices_localization_service_.default.html | 2 +- ...del_.localizationServiceObjectToProxy.html | 2 +- ...odel_.localizationServiceProviderName.html | 2 +- ...red_services_logger_service_.WARN_TAG.html | 2 +- ...ared_services_logger_service_.default.html | 2 +- ...d_services_menu_data_service_.default.html | 2 +- ...e_model_.menuDataServiceObjectToProxy.html | 2 +- ...ce_model_.menuDataServiceProviderName.html | 2 +- ...vices_network_object_service_.default.html | 2 +- ...ervice_.minimalNetworkObjectService-1.html | 2 +- ...etwork_object_status_service_.default.html | 2 +- ...network_service_.papiNetworkService-1.html | 2 +- ...piBackendProjectDataProviderService-1.html | 2 +- ...iFrontendProjectDataProviderService-1.html | 2 +- ...vices_project_lookup_service_.default.html | 2 +- ...ces_project_settings_service_.default.html | 2 +- ...Y_EXTENSION_PROJECT_SETTING_VALIDATOR.html | 2 +- ...ojectSettingsServiceNetworkObjectName.html | 2 +- ..._.projectSettingsServiceObjectToProxy.html | 2 +- ...ervices_scroll_group_service_.default.html | 2 +- ...del_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html | 2 +- ...WORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ....CATEGORY_EXTENSION_SETTING_VALIDATOR.html | 2 +- ...odel_.settingsServiceDataProviderName.html | 2 +- ...e_model_.settingsServiceObjectToProxy.html | 2 +- ...es_web_view_provider_service_.default.html | 2 +- ...service_.papiWebViewProviderService-1.html | 2 +- ...ed_services_web_view_service_.default.html | 2 +- ...model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html | 2 +- ...del_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html | 2 +- ...odel_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html | 2 +- ...el_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html | 2 +- ....NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html | 2 +- ...odel_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html | 2 +- ...hared_utils_util_.MODULE_SIMILAR_APIS.html | 2 +- ...ed_utils_util_.REQUEST_TYPE_SEPARATOR.html | 2 +- papi-dts/variables/isNoisyDevModeEnabled.html | 2 +- papi-dts/variables/isPackaged.html | 2 +- papi-dts/variables/logLevel.html | 2 +- papi-dts/variables/processType.html | 2 +- papi-dts/variables/resourcesPath.html | 2 +- papi-dts/variables/webViewId.html | 2 +- .../enums/BookSelectionMode.html | 4 +- .../enums/DropdownMenuItemType.html | 4 +- platform-bible-react/functions/Alert.html | 2 +- .../functions/AlertDescription.html | 2 +- .../functions/AlertTitle.html | 2 +- .../functions/BookChapterControl.html | 2 +- .../functions/BookSelector.html | 2 +- platform-bible-react/functions/Button.html | 2 +- platform-bible-react/functions/Card.html | 2 +- .../functions/CardContent.html | 2 +- .../functions/CardDescription.html | 2 +- .../functions/CardFooter.html | 2 +- .../functions/CardHeader.html | 2 +- platform-bible-react/functions/CardTitle.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- platform-bible-react/functions/Checkbox.html | 2 +- platform-bible-react/functions/Checklist.html | 2 +- platform-bible-react/functions/ComboBox.html | 2 +- platform-bible-react/functions/DataTable.html | 2 +- .../functions/DisableButton.html | 2 +- .../functions/DropdownMenu.html | 2 +- .../functions/DropdownMenuCheckboxItem.html | 2 +- .../functions/DropdownMenuContent.html | 2 +- .../functions/DropdownMenuGroup.html | 2 +- .../functions/DropdownMenuItem.html | 2 +- .../functions/DropdownMenuLabel.html | 2 +- .../functions/DropdownMenuPortal.html | 2 +- .../functions/DropdownMenuRadioGroup.html | 2 +- .../functions/DropdownMenuRadioItem.html | 2 +- .../functions/DropdownMenuSeparator.html | 2 +- .../functions/DropdownMenuShortcut.html | 4 +- .../functions/DropdownMenuSub.html | 2 +- .../functions/DropdownMenuSubContent.html | 2 +- .../functions/DropdownMenuSubTrigger.html | 2 +- .../functions/DropdownMenuTrigger.html | 2 +- .../functions/EnableButton.html | 2 +- .../functions/FilterButton.html | 2 +- .../functions/FilterDropdown.html | 2 +- platform-bible-react/functions/Footer.html | 2 +- platform-bible-react/functions/GridMenu.html | 2 +- .../functions/HamburgerMenuButton.html | 2 +- .../functions/IconButton.html | 2 +- platform-bible-react/functions/Input.html | 2 +- .../functions/InstallButton.html | 2 +- platform-bible-react/functions/Inventory.html | 2 +- platform-bible-react/functions/Label.html | 2 +- .../functions/MarkdownRenderer.html | 2 +- platform-bible-react/functions/MenuItem.html | 2 +- platform-bible-react/functions/MoreInfo.html | 2 +- .../functions/NavigationContentSearch.html | 2 +- .../functions/NoExtensionsFound.html | 2 +- .../functions/RadioGroup.html | 2 +- .../functions/RadioGroupItem.html | 2 +- .../functions/ScriptureResultsViewer.html | 2 +- .../functions/ScrollGroupSelector.html | 2 +- platform-bible-react/functions/SearchBar.html | 2 +- platform-bible-react/functions/Select.html | 2 +- .../functions/SelectContent.html | 2 +- .../functions/SelectGroup.html | 2 +- .../functions/SelectItem.html | 2 +- .../functions/SelectLabel.html | 2 +- .../functions/SelectScrollDownButton.html | 2 +- .../functions/SelectScrollUpButton.html | 2 +- .../functions/SelectSeparator.html | 2 +- .../functions/SelectTrigger.html | 2 +- .../functions/SelectValue.html | 2 +- platform-bible-react/functions/Separator.html | 2 +- .../functions/SettingsList.html | 2 +- .../functions/SettingsListHeader.html | 2 +- .../functions/SettingsListItem.html | 2 +- platform-bible-react/functions/Slider.html | 2 +- platform-bible-react/functions/Sonner-1.html | 2 +- platform-bible-react/functions/Spinner.html | 2 +- platform-bible-react/functions/Switch.html | 2 +- platform-bible-react/functions/Table.html | 2 +- platform-bible-react/functions/TableBody.html | 2 +- .../functions/TableCaption.html | 2 +- platform-bible-react/functions/TableCell.html | 2 +- .../functions/TableFooter.html | 2 +- platform-bible-react/functions/TableHead.html | 2 +- .../functions/TableHeader.html | 2 +- platform-bible-react/functions/TableRow.html | 2 +- platform-bible-react/functions/Tabs.html | 2 +- .../functions/TabsContent.html | 2 +- platform-bible-react/functions/TabsList.html | 2 +- .../functions/TabsTrigger.html | 2 +- platform-bible-react/functions/TextField.html | 2 +- .../functions/ToggleGroup.html | 2 +- .../functions/ToggleGroupItem.html | 2 +- platform-bible-react/functions/Toolbar.html | 2 +- .../functions/UpdateButton.html | 2 +- .../functions/VersionHistory.html | 2 +- .../functions/VerticalTabs.html | 2 +- .../functions/VerticalTabsContent.html | 2 +- .../functions/VerticalTabsList.html | 2 +- .../functions/VerticalTabsTrigger.html | 2 +- .../functions/buttonVariants.html | 2 +- platform-bible-react/functions/cn.html | 2 +- .../functions/getBookNumFromId.html | 2 +- .../functions/getLinesFromUSFM.html | 2 +- .../functions/getNumberFromUSFM.html | 2 +- .../functions/getStatusForItem.html | 2 +- .../functions/inventoryCountColumn.html | 2 +- .../functions/inventoryItemColumn.html | 2 +- .../functions/inventoryStatusColumn.html | 2 +- platform-bible-react/functions/useEvent.html | 2 +- .../functions/useEventAsync.html | 2 +- .../functions/usePromise.html | 2 +- .../interfaces/ButtonProps.html | 6 +-- .../interfaces/CommandHandler.html | 2 +- .../interfaces/MultiColumnMenuProvider.html | 2 +- .../types/BookSelectorLocalizedStrings.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- .../types/ChecklistProps.html | 2 +- platform-bible-react/types/ColumnDef.html | 2 +- .../types/ComboBoxLabelOption.html | 2 +- .../types/ComboBoxOption.html | 2 +- platform-bible-react/types/ComboBoxProps.html | 2 +- platform-bible-react/types/DropdownGroup.html | 2 +- platform-bible-react/types/DropdownItem.html | 2 +- .../types/DropdownMenuCheckboxItemProps.html | 2 +- .../types/DropdownMenuContentProps.html | 2 +- .../types/DropdownMenuItemProps.html | 2 +- .../types/DropdownMenuLabelProps.html | 2 +- .../types/DropdownMenuRadioItemProps.html | 2 +- .../types/DropdownMenuSeparatorProps.html | 2 +- .../types/DropdownMenuShortcutProps.html | 2 +- .../types/DropdownMenuSubContentProps.html | 2 +- .../types/DropdownMenuSubTriggerProps.html | 2 +- platform-bible-react/types/GridMenuInfo.html | 2 +- platform-bible-react/types/GridMenuProps.html | 2 +- .../types/IconButtonProps.html | 2 +- .../types/InventoryItemOccurrence.html | 2 +- .../types/InventoryLocalizedStrings.html | 2 +- .../types/InventoryTableData.html | 2 +- .../types/MenuItemListProps.html | 2 +- platform-bible-react/types/ResultsSet.html | 2 +- platform-bible-react/types/ResultsSource.html | 2 +- platform-bible-react/types/RowContents.html | 2 +- platform-bible-react/types/Scope.html | 2 +- .../types/ScriptureItemDetail.html | 2 +- .../ScriptureResultsViewerColumnInfo.html | 2 +- .../types/ScriptureResultsViewerProps.html | 2 +- .../types/ScriptureSrcItemDetail.html | 2 +- .../types/ScrollGroupSelectorProps.html | 2 +- .../types/SearchBarProps.html | 2 +- platform-bible-react/types/SortDirection.html | 2 +- platform-bible-react/types/SpinnerProps.html | 2 +- .../types/TabKeyValueContent.html | 2 +- platform-bible-react/types/TableContents.html | 2 +- .../types/TextFieldProps.html | 2 +- platform-bible-react/types/ToolbarProps.html | 2 +- .../types/UsePromiseOptions.html | 2 +- .../types/VersionHistoryType.html | 2 +- .../types/VersionInformation.html | 2 +- .../variables/BOOK_SELECTOR_STRING_KEYS.html | 2 +- .../variables/INVENTORY_STRING_KEYS.html | 2 +- .../classes/AsyncVariable.html | 12 ++--- platform-bible-utils/classes/Collator.html | 8 ++-- .../classes/DateTimeFormat.html | 14 +++--- .../classes/DocumentCombiner.html | 28 ++++++------ platform-bible-utils/classes/Mutex.html | 2 +- platform-bible-utils/classes/MutexMap.html | 4 +- .../NonValidatingDocumentCombiner.html | 28 ++++++------ .../classes/NumberFormat.html | 14 +++--- .../classes/PlatformEventEmitter.html | 16 +++---- .../classes/UnsubscriberAsyncList.html | 8 ++-- .../classes/UsjReaderWriter.html | 26 +++++------ .../aggregateUnsubscriberAsyncs.html | 2 +- .../functions/aggregateUnsubscribers.html | 2 +- platform-bible-utils/functions/at.html | 2 +- platform-bible-utils/functions/charAt.html | 2 +- .../functions/codePointAt.html | 2 +- .../functions/compareScrRefs.html | 2 +- .../createSyncProxyForAsyncObject.html | 2 +- platform-bible-utils/functions/debounce.html | 2 +- platform-bible-utils/functions/deepClone.html | 2 +- platform-bible-utils/functions/deepEqual.html | 2 +- .../functions/deserialize.html | 2 +- platform-bible-utils/functions/endsWith.html | 2 +- .../functions/ensureArray.html | 2 +- .../functions/escapeStringRegexp.html | 2 +- .../functions/formatBytes.html | 2 +- .../functions/formatReplacementString.html | 2 +- .../formatReplacementStringToArray.html | 2 +- .../functions/formatScrRef.html | 2 +- .../functions/getAllObjectFunctionNames.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../functions/getCurrentLocale.html | 2 +- .../functions/getErrorMessage.html | 2 +- .../getLocalizeKeyForScrollGroupId.html | 2 +- .../getLocalizeKeysForScrollGroupIds.html | 2 +- .../getLocalizedIdFromBookNumber.html | 2 +- platform-bible-utils/functions/groupBy.html | 2 +- .../functions/htmlEncode.html | 2 +- platform-bible-utils/functions/includes.html | 2 +- platform-bible-utils/functions/indexOf.html | 2 +- .../functions/isLocalizeKey.html | 2 +- .../functions/isSerializable.html | 2 +- platform-bible-utils/functions/isString.html | 2 +- platform-bible-utils/functions/isSubset.html | 2 +- .../functions/lastIndexOf.html | 2 +- platform-bible-utils/functions/newGuid.html | 2 +- platform-bible-utils/functions/normalize.html | 2 +- .../functions/offsetBook.html | 2 +- .../functions/offsetChapter.html | 2 +- .../functions/offsetVerse.html | 2 +- .../functions/ordinalCompare.html | 2 +- platform-bible-utils/functions/padEnd.html | 2 +- platform-bible-utils/functions/padStart.html | 2 +- .../functions/scrRefToBBBCCCVVV.html | 2 +- platform-bible-utils/functions/serialize.html | 2 +- platform-bible-utils/functions/slice.html | 2 +- platform-bible-utils/functions/split.html | 2 +- .../functions/startsWith.html | 2 +- .../functions/stringLength.html | 2 +- platform-bible-utils/functions/substring.html | 2 +- platform-bible-utils/functions/toArray.html | 2 +- .../transformAndEnsureRegExpArray.html | 2 +- .../transformAndEnsureRegExpRegExpArray.html | 2 +- platform-bible-utils/functions/wait.html | 2 +- .../functions/waitForDuration.html | 2 +- platform-bible-utils/interfaces/BookInfo.html | 4 +- .../interfaces/CannotHaveOnDidDispose.html | 6 +-- platform-bible-utils/interfaces/Dispose.html | 4 +- .../interfaces/IUsjReaderWriter.html | 24 +++++----- .../interfaces/LanguageStrings.html | 2 +- .../LocalizedStringDataContribution.html | 4 +- .../ModifierExtensionControlled.html | 4 +- .../interfaces/ModifierProject.html | 10 ++--- .../interfaces/OnDidDispose.html | 4 +- .../interfaces/ProjectSettingProperties.html | 2 +- .../interfaces/ProjectSettingsGroup.html | 6 +-- .../interfaces/ProjectStateContribution.html | 2 +- .../interfaces/ScriptureReference.html | 4 +- .../interfaces/SettingProperties.html | 2 +- .../interfaces/SettingsGroup.html | 6 +-- .../interfaces/StateBase.html | 6 +-- .../interfaces/StringMetadata.html | 6 +-- .../interfaces/StringsMetadata.html | 2 +- .../interfaces/UserStateContribution.html | 2 +- .../types/CanHaveOnDidDispose.html | 2 +- .../types/ColumnsWithHeaders.html | 2 +- platform-bible-utils/types/DeepPartial.html | 2 +- .../types/DocumentCombinerOptions.html | 2 +- .../ExtensionControlledProjectSetting.html | 2 +- .../types/ExtensionControlledSetting.html | 2 +- .../types/ExtensionControlledState.html | 2 +- .../types/GroupsInMultiColumnMenu.html | 2 +- .../types/GroupsInSingleColumnMenu.html | 2 +- .../types/JsonDocumentLike.html | 2 +- platform-bible-utils/types/LocalizeKey.html | 2 +- platform-bible-utils/types/Localized.html | 2 +- .../types/LocalizedStringValue.html | 2 +- .../types/MenuColumnWithHeader.html | 2 +- .../types/MenuGroupDetailsInColumn.html | 2 +- .../types/MenuGroupDetailsInSubMenu.html | 2 +- platform-bible-utils/types/MenuItemBase.html | 2 +- .../types/MenuItemContainingCommand.html | 2 +- .../types/MenuItemContainingSubmenu.html | 2 +- .../types/MultiColumnMenu.html | 2 +- .../types/OrderedExtensibleContainer.html | 2 +- platform-bible-utils/types/OrderedItem.html | 2 +- platform-bible-utils/types/PlatformEvent.html | 2 +- .../types/PlatformEventAsync.html | 2 +- .../types/PlatformEventHandler.html | 2 +- platform-bible-utils/types/PlatformMenus.html | 2 +- .../types/ProjectSetting.html | 2 +- .../types/ProjectSettingBase.html | 2 +- .../types/ProjectSettingsContribution.html | 2 +- .../types/ReferencedItem.html | 2 +- platform-bible-utils/types/ReplaceType.html | 2 +- platform-bible-utils/types/ScriptureNode.html | 2 +- .../types/ScriptureSelection.html | 2 +- .../types/ScriptureTextAnchor.html | 2 +- platform-bible-utils/types/ScrollGroupId.html | 2 +- platform-bible-utils/types/Setting.html | 2 +- platform-bible-utils/types/SettingBase.html | 2 +- .../types/SettingsContribution.html | 2 +- .../types/SingleColumnMenu.html | 2 +- .../types/UnionToIntersection.html | 2 +- platform-bible-utils/types/Unsubscriber.html | 2 +- .../types/UnsubscriberAsync.html | 2 +- platform-bible-utils/types/UserState.html | 2 +- .../types/UsjContentLocation.html | 2 +- .../types/VerseRefOffset.html | 2 +- platform-bible-utils/types/WebViewMenu.html | 2 +- platform-bible-utils/types/WebViewMenus.html | 2 +- .../variables/CHAPTER_TYPE.html | 2 +- .../variables/FIRST_SCR_BOOK_NUM.html | 2 +- .../variables/FIRST_SCR_CHAPTER_NUM.html | 2 +- .../variables/FIRST_SCR_VERSE_NUM.html | 2 +- .../variables/LAST_SCR_BOOK_NUM.html | 2 +- .../variables/VERSE_TYPE.html | 2 +- .../variables/defaultScrRef.html | 2 +- .../localizedStringsDocumentSchema.html | 2 +- .../variables/menuDocumentSchema.html | 2 +- .../projectSettingsDocumentSchema.html | 2 +- .../variables/settingsDocumentSchema.html | 2 +- 811 files changed, 1167 insertions(+), 1167 deletions(-) diff --git a/papi-dts/classes/_client_services_rpc_client_.default.html b/papi-dts/classes/_client_services_rpc_client_.default.html index 71dda0e0b5..55d883fc86 100644 --- a/papi-dts/classes/_client_services_rpc_client_.default.html +++ b/papi-dts/classes/_client_services_rpc_client_.default.html @@ -1,6 +1,6 @@ default | papi-dts

Manages the JSON-RPC protocol on the client end of a websocket that connects to main

Created by any process that connects to the websocket server owned by main

-

Implements

Constructors

Implements

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Methods

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • @@ -19,19 +19,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -
+
diff --git a/papi-dts/classes/_main_services_rpc_server_.default.html b/papi-dts/classes/_main_services_rpc_server_.default.html index f9af641af6..98649cb0e1 100644 --- a/papi-dts/classes/_main_services_rpc_server_.default.html +++ b/papi-dts/classes/_main_services_rpc_server_.default.html @@ -2,7 +2,7 @@ intended to be instantiated by anything other than RpcWebSocketListener.

Created by RpcWebSocketListener when a client connects to the web socket server. There is one RpcServer object per client that connects to the web socket server.

-

Implements

Constructors

Implements

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Methods

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • On servers: opening an endpoint for clients to connect

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -
+
diff --git a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html index afc48532dc..d297f2a02f 100644 --- a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html +++ b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html @@ -5,7 +5,7 @@ other processes will be tied to the RPCServer that services the connection for that other process.

Created by the main process on start up when the network service initializes

-

Implements

Constructors

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Accessors

Methods

Accessors

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • @@ -25,19 +25,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -
+
diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index c3272ace25..6e0b849d85 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,8 +1,8 @@ ExecutionToken | papi-dts

Execution tokens can be passed into API calls to provide context about their identity

-

Implements

Constructors

Implements

Constructors

Properties

Methods

Constructors

Properties

name: string

Name of an extension

-
nonce: string
type

Methods

+

Constructors

Properties

name: string

Name of an extension

+
nonce: string
type

Methods

diff --git a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html index eb46384fe8..fc76ca7f14 100644 --- a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html @@ -2,7 +2,7 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

Note that the Node WebSocket implementation is different and not wrapped here.

-

Implements

Constructors

Implements

  • WebSocket

Constructors

Properties

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

+

Constructors

Properties

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

Can be set, to change how binary data is returned. The default is "blob".

MDN Reference

-
bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

+
bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

MDN Reference

-
close: ((code?: number, reason?: string) => void)

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

+
close: ((code?: number, reason?: string) => void)

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

MDN Reference

-
CLOSED
CLOSING
CONNECTING
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+
CLOSED
CLOSING
CONNECTING
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-
extensions: string

Returns the extensions selected by the server, if any.

+
extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

-
onclose: null | ((this: WebSocket, ev: CloseEvent) => any)
onerror: null | ((this: WebSocket, ev: Event) => any)
onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)
onopen: null | ((this: WebSocket, ev: Event) => any)
OPEN
protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

+
onclose: null | ((this: WebSocket, ev: CloseEvent) => any)
onerror: null | ((this: WebSocket, ev: Event) => any)
onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)
onopen: null | ((this: WebSocket, ev: Event) => any)
OPEN
protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

MDN Reference

-
readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

+
readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

MDN Reference

-
removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

+
removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

MDN Reference

-
url: string

Returns the URL that was used to establish the WebSocket connection.

+
url: string

Returns the URL that was used to establish the WebSocket connection.

MDN Reference

-
+
diff --git a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html index 59ae719e2e..43766d1c18 100644 --- a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html @@ -2,7 +2,7 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

Note that Node doesn't have a native implementation, so this is only for the renderer.

-

Implements

Constructors

Implements

  • XMLHttpRequest

Constructors

Properties

Constructors

Properties

abort: (() => void)

Cancels any network activity.

+

Constructors

Properties

abort: (() => void)

Cancels any network activity.

MDN Reference

-
addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+
addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-
DONE
getAllResponseHeaders: (() => string)
getResponseHeader: ((name: string) => null | string)
HEADERS_RECEIVED
LOADING
onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)
ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

+
DONE
getAllResponseHeaders: (() => string)
getResponseHeader: ((name: string) => null | string)
HEADERS_RECEIVED
LOADING
onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)
ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

Throws a "SyntaxError" DOMException if either method is not a valid method or url cannot be parsed.

Throws a "SecurityError" DOMException if method is a case-insensitive match for CONNECT, TRACE, or TRACK.

Throws an "InvalidAccessError" DOMException if async is false, current global object is a Window object, and the timeout attribute is not zero or the responseType attribute is not the empty string.

MDN Reference

-
OPENED
overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

+
OPENED
overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

Throws an "InvalidStateError" DOMException if state is loading or done.

MDN Reference

-
readyState: number

Returns client's state.

+
readyState: number

Returns client's state.

MDN Reference

-
removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
response: any

Returns the response body.

+
removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
response: any

Returns the response body.

MDN Reference

-
responseText: string

Returns response as text.

+
responseText: string

Returns response as text.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".

MDN Reference

-
responseType: XMLHttpRequestResponseType

Returns the response type.

+
responseType: XMLHttpRequestResponseType

Returns the response type.

Can be set to change the response type. Values are: the empty string (default), "arraybuffer", "blob", "document", "json", and "text".

When set: setting to "document" is ignored if current global object is not a Window object.

When set: throws an "InvalidStateError" DOMException if state is loading or done.

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-
responseURL: string
responseXML: null | Document

Returns the response as document.

+
responseURL: string
responseXML: null | Document

Returns the response as document.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".

MDN Reference

-
send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

+
send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

MDN Reference

-
setRequestHeader: ((name: string, value: string) => void)

Combines a header in author request headers.

+
setRequestHeader: ((name: string, value: string) => void)

Combines a header in author request headers.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

Throws a "SyntaxError" DOMException if name is not a header name or if value is not a header value.

MDN Reference

-
status: number
statusText: string
timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

+
status: number
statusText: string
timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-
UNSENT
upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

+
UNSENT
upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

MDN Reference

-
withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

+
withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

When set: throws an "InvalidStateError" DOMException if state is not unsent or opened, or if the send() flag is set.

MDN Reference

-
+
diff --git a/papi-dts/classes/_shared_log_error_model_.default.html b/papi-dts/classes/_shared_log_error_model_.default.html index 78eb476300..98a949af31 100644 --- a/papi-dts/classes/_shared_log_error_model_.default.html +++ b/papi-dts/classes/_shared_log_error_model_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Error that force logs the error message before throwing. Useful for debugging in some situations.

-

Hierarchy

  • Error
    • default

Constructors

Hierarchy

  • Error
    • default

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
message: string
name: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
message: string
name: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stack?: string
stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html index a9138ce66b..72e799727b 100644 --- a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html @@ -7,7 +7,7 @@

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

Type Parameters

Hierarchy (view full)

Constructors

Methods

Constructors

Methods

+

Parameters

Returns void

diff --git a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 903d640f74..1b41afe777 100644 --- a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html @@ -2,7 +2,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Methods

Constructors

Methods

  • Method to run to send clients updates for a specific data type outside of the set<data_type> method. papi overwrites this function on the DataProviderEngine itself to emit an update based on @@ -28,4 +28,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Parameters

    Returns void

+

Parameters

Returns void

diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index a65ef94e78..fe1e5beb0b 100644 --- a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html @@ -7,7 +7,7 @@

WARNING: Do not use this class directly outside of NetworkService, or it will not do what you expect. Use NetworkService.createNetworkEventEmitter.

WARNING: You cannot emit events with complex types on the network.

-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

Properties

dispose emit subscribe @@ -19,23 +19,23 @@

Constructors

Properties

dispose: (() => Promise<boolean>)

Disposes of this event, preparing it to release from memory

-
emit: ((event: T) => void)

Runs the subscriptions for the event

+
    • (): void
    • Returns void

Returns "shared/models/papi-network-event-emitter.model".default<T>

Properties

dispose: (() => Promise<boolean>)

Disposes of this event, preparing it to release from memory

+
emit: ((event: T) => void)

Runs the subscriptions for the event

Type declaration

    • (event): void
    • Parameters

      • event: T

        Event data to provide to subscribed callbacks

        -

      Returns void

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+

Returns void

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Function to run with the event when it is emitted

Unsubscriber function to run to stop calling the passed-in function when the event is emitted

event

-

Accessors

  • get event(): PlatformEvent<T>
  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

Accessors

  • get event(): PlatformEvent<T>
  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. Use like const unsubscriber = event(callback)

    Returns PlatformEvent<T>

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    -

Methods

Methods

  • Disposes of this event, preparing it to release from memory. Added here so children can override emit and still call the base functionality.

    -

    Returns Promise<boolean>

  • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns Promise<boolean>

  • Function that runs the subscriptions for the event. Added here so children can override emit and still call the base functionality. See NetworkEventEmitter.emit for example

    -

    Parameters

    • event: T

    Returns void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    +

    Parameters

    • event: T

    Returns void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    Parameters

    • event: T

      Event data to provide to subscribed callbacks

      -

    Returns void

+

Returns void

diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html index 819f9a0204..b1b2e834ae 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html @@ -5,15 +5,15 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

-

Type Parameters

Constructors

Type Parameters

Constructors

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

-
projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces +

Returns "shared/models/project-data-provider-engine-factory.model".LayeringProjectDataProviderEngineFactory<SupportedProjectInterfaces>

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

+
projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included in the available projects this Layering PDPF @@ -33,14 +33,14 @@

  • Include one
  • Include both two and three.
  • -
    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    +
    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    providedProjectInterfaces: ['four', 'five'];
     

    This layering PDPF will announce that its provides the projectInterfaces four and five for projects that match projectInterfacesToLayerOver.

    -

    Methods

    Methods

    +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html index a17d720dba..fe2cdb2e71 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -7,7 +7,7 @@

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    Type Parameters

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    Methods

    +

    Parameters

    Returns void

    diff --git a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html index 2796ed494e..ee905ed509 100644 --- a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html +++ b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html @@ -13,13 +13,13 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    IWebViewProvider for more information on extending this class.

    -

    Type Parameters

    Implements

    Constructors

    Type Parameters

    Implements

    Constructors

    Properties

    webViewType: WebViewType

    Methods

    Constructors

    Properties

    webViewType: WebViewType

    Methods

    • Creates a WebViewController that corresponds to the WebViewDefinition provided. WebViewFactory calls this as part of its getWebView. WebViewFactory will automatically register this controller with the web view provider service (papi.webViewProviders.registerWebViewController), run its dispose when the web view is @@ -37,15 +37,15 @@ web view controller created for this web view.

    Returns Promise<WebViewControllers[WebViewType]>

    Web view controller for the web view with the webViewDefinition provided. Or undefined if you do not want to create a web view controller for this web view.

    -
    • Disposes of all WVCs that were created by this provider

      -

      Returns Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      +

      Returns Promise<boolean>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      WebViewFactory calls this as part of its getWebView, which is called by the PAPI @@ -72,4 +72,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html index 60829acc59..fff05fd737 100644 --- a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html +++ b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -
    options: DocumentCombinerOptions
    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +
    options: DocumentCombinerOptions
    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -33,13 +33,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Delete one of the contribution documents for the composition process

      Parameters

      • documentName: string

        Name of the contributed document to delete

      Returns undefined | JsonDocumentLike

      Recalculated output document given the remaining other documents

      -
    • This method is intended to be layered over by a child class to expose the localized setting +

    • This method is intended to be layered over by a child class to expose the localized setting info.

      Get the current set of settings contribution info given all the input documents with all localized string keys localized properly.

      @@ -49,7 +49,7 @@ addOrUpdateContribution wasn't called explicitly, those document changes will not be seen in the current set of settings contributions. If all the input documents are static, then there is no need to ever rebuild once all the documents have been contributed to this combiner.

      -

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.commentsEnabled: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.interfaceLanguage: undefined | {
                  default: string[];
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.paratextDataLastRegistryDataCachedTimes: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.ptxUtilsMementoData: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.verseRef: undefined | {
                  default: {
                      bookNum: number;
                      chapterNum: number;
                      verseNum: number;
                  };
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of settings contribution info given all the input documents with all +

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.commentsEnabled: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.interfaceLanguage: undefined | {
                  default: string[];
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.paratextDataLastRegistryDataCachedTimes: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.ptxUtilsMementoData: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.verseRef: undefined | {
                  default: {
                      bookNum: number;
                      chapterNum: number;
                      verseNum: number;
                  };
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of settings contribution info given all the input documents with all localized string keys localized properly.

      NOTE: If the input documents might have changed since the last time the settings contributions were retrieved, you can call rebuild to incorporate those document changes before calling @@ -57,7 +57,7 @@ addOrUpdateContribution wasn't called explicitly, those document changes will not be seen in the current set of settings contributions. If all the input documents are static, then there is no need to ever rebuild once all the documents have been contributed to this combiner.

      -

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of project settings contribution info given all the input documents. +

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of project settings contribution info given all the input documents. Localized string keys have not been localized to corresponding strings.

      NOTE: If the input documents might have changed since the last time the project settings contributions were retrieved, you can call rebuild to incorporate those document changes @@ -66,17 +66,17 @@ the current set of project settings contributions. If all the input documents are static, then there is no need to ever rebuild once all the documents have been contributed to this combiner.

      -

      Returns undefined | ProjectSettingsContributionInfo

    • Run the document composition process given the starting document and all contributions. Throws if the output document fails to validate properly.

      Returns undefined | JsonDocumentLike

      Recalculated output document given the starting and contributed documents

      -
    • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

      Parameters

      • baseDocument: JsonDocumentLike

        Initial input document. Already validated via validateBaseDocument

      Returns JsonDocumentLike

      Transformed base document

      -
    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -84,18 +84,18 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -

    Returns JsonDocumentLike

    Returns void

    +

    Returns void

    diff --git a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html index e736f61f6f..a5a0ad6818 100644 --- a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html +++ b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -
    options: DocumentCombinerOptions
    settingTypeName: string

    Name for type of setting to use in error messages

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +
    options: DocumentCombinerOptions
    settingTypeName: string

    Name for type of setting to use in error messages

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -31,13 +31,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Delete all present contribution documents for the composition process and return to the base +

    • Delete all present contribution documents for the composition process and return to the base document

      Returns undefined | JsonDocumentLike

      Recalculated output document consisting only of the base document

      -
    • Delete one of the contribution documents for the composition process

      +
    • Delete one of the contribution documents for the composition process

      Parameters

      • documentName: string

        Name of the contributed document to delete

      Returns undefined | JsonDocumentLike

      Recalculated output document given the remaining other documents

      -
    • This method is intended to be layered over by a child class to expose the localized setting +

    • This method is intended to be layered over by a child class to expose the localized setting info.

      Get the current set of settings contribution info given all the input documents with all localized string keys localized properly.

      @@ -47,17 +47,17 @@ addOrUpdateContribution wasn't called explicitly, those document changes will not be seen in the current set of settings contributions. If all the input documents are static, then there is no need to ever rebuild once all the documents have been contributed to this combiner.

      -

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.commentsEnabled: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.interfaceLanguage: undefined | {
                  default: string[];
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.paratextDataLastRegistryDataCachedTimes: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.ptxUtilsMementoData: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.verseRef: undefined | {
                  default: {
                      bookNum: number;
                      chapterNum: number;
                      verseNum: number;
                  };
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Validate the base and contribution documents against the JSON schema

      -

      Parameters

      • document: JsonDocumentLike
      • docType: string

      Returns void

    • Run the document composition process given the starting document and all contributions. Throws +

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.commentsEnabled: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.interfaceLanguage: undefined | {
                  default: string[];
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.paratextDataLastRegistryDataCachedTimes: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.ptxUtilsMementoData: undefined | {
                  default: {};
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.verseRef: undefined | {
                  default: {
                      bookNum: number;
                      chapterNum: number;
                      verseNum: number;
                  };
                  derivesFrom?: string;
                  description?: string;
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Validate the base and contribution documents against the JSON schema

      +

      Parameters

      • document: JsonDocumentLike
      • docType: string

      Returns void

    • Run the document composition process given the starting document and all contributions. Throws if the output document fails to validate properly.

      Returns undefined | JsonDocumentLike

      Recalculated output document given the starting and contributed documents

      -
    • Transform the starting document that is given to the combiner. This transformation occurs after +

    • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

      Parameters

      • baseDocument: JsonDocumentLike

        Initial input document. Already validated via validateBaseDocument

      Returns JsonDocumentLike

      Transformed base document

      -
    • Transform the contributed document associated with documentName. This transformation occurs +

    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -65,18 +65,18 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -

    Returns JsonDocumentLike

    Returns void

    +

    Returns void

    diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 0191a45739..33a507606a 100644 --- a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html +++ b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html @@ -1,5 +1,5 @@ EntryType | papi-dts

    Type of file system item in a directory

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Directory
    File
    Unknown
    +

    Enumeration Members

    Directory
    File
    Unknown
    diff --git a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html index 5f78f8458a..48d58ecaa5 100644 --- a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

    Whether an RPC object is setting up or has finished setting up its connection and is ready to communicate on the network

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Connected

    Finished setting up its connection

    -
    Connecting

    Attempting to connect to the network

    -
    Disconnected

    Not connected to the network

    -
    +
    Connecting

    Attempting to connect to the network

    +
    Disconnected

    Not connected to the network

    +
    diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index 53bb28638d..32a0a38f11 100644 --- a/papi-dts/enums/_shared_global_this_model_.ProcessType.html +++ b/papi-dts/enums/_shared_global_this_model_.ProcessType.html @@ -1,5 +1,5 @@ ProcessType | papi-dts

    Type of Paranext process

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ExtensionHost
    Main
    Renderer
    +

    Enumeration Members

    ExtensionHost
    Main
    Renderer
    diff --git a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html index 9af2ba02d7..f3c02e3858 100644 --- a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html +++ b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html @@ -1,4 +1,4 @@ ElevatedPrivilegeNames | papi-dts

    String constants that are listed in an extension's manifest.json to state needed privileges

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    createProcess
    manageExtensions
    +

    Enumeration Members

    createProcess
    manageExtensions
    diff --git a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index 8b1af9d3fb..3867b11297 100644 --- a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html +++ b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html @@ -1,11 +1,11 @@ WebViewContentType | papi-dts

    The type of code that defines a webview's content

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    HTML

    This webview is a raw HTML/JS/CSS webview.

    -
    React

    This webview is a React webview. It must specify its component by setting it to +

    React

    This webview is a React webview. It must specify its component by setting it to globalThis.webViewComponent

    -
    URL

    This webview's content is fetched from the url specified (iframe src attribute). Note that +

    URL

    This webview's content is fetched from the url specified (iframe src attribute). Note that webViews of this type cannot access the papi because they cannot be on the same origin as the parent window.

    -
    +
    diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index dd90ff0bcf..030b39d78e 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    This is just an alias for internet.fetch

    • Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    +

    Parameters

    Returns Promise<Response>

  • Parameters

    • input: string | Request | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index f468562ab3..e81e5192e8 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    This is just an alias for internet.fetch

    • Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    +

    Parameters

    Returns Promise<Response>

  • Parameters

    • input: string | Request | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index 874ed40356..d6538201a5 100644 --- a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html +++ b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html @@ -1,3 +1,3 @@ createWebSocket | papi-dts

    Creates a WebSocket for the renderer or extension host depending on where you're running

    • Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -
    +
    diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index 3b84e54d38..2f4ab49eaa 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html @@ -1,2 +1,2 @@ buildExtensionPathFromName | papi-dts
    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    +

    Parameters

    Returns string

    diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index 9af5aaca11..ff518b7b83 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html @@ -1,3 +1,3 @@ setExtensionUris | papi-dts
    • This is only intended to be called by the extension service. This service cannot call into the extension service or it causes a circular dependency.

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html index 104f4abbe9..7b3924313a 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html @@ -5,4 +5,4 @@
  • Optionalmode: number

    Bitwise modifiers that affect how the copy works. See fsPromises.copyFile for more information

    -
  • Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index b654017dfc..9dadc73115 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html @@ -1,4 +1,4 @@ createDir | papi-dts
    • Create a directory in the file system if it does not exist. Does not throw if it already exists.

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index f8510584de..1fcf5b36b7 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html @@ -1,4 +1,4 @@ deleteDir | papi-dts
    • Remove a directory and all its contents recursively from the file system

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index f3cf667439..7e4196795c 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html @@ -1,4 +1,4 @@ deleteFile | papi-dts
    • Delete a file if it exists

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

      Promise that resolves when the file is deleted or determined to not exist

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index ec8eba3251..aa2b4bda58 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<BigIntStats | undefined>

    Promise that resolves to object of type https://nodejs.org/api/fs.html#class-fsstats if file or directory exists, undefined if it doesn't

    -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html index a497b5e953..634015b2c5 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html @@ -1,4 +1,4 @@ moveFile | papi-dts
    • Moves a file from one location to another

      Parameters

      • sourceUri: string

        The location of the file to move

      • destinationUri: string

        The uri where the file should be moved

        -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index f1b6263cf6..4e03b8c6b4 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

    Map of entry type to list of uris for each entry in the directory with that type.

    -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 9a8d046733..df123fcb4b 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html @@ -1,4 +1,4 @@ readFileBinary | papi-dts
    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index ca3aabfef7..657a362eeb 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html @@ -1,4 +1,4 @@ readFileText | papi-dts
    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index bcd89f78c8..f244c25ae1 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.touch.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.touch.html @@ -1,4 +1,4 @@ touch | papi-dts
    • Set the last modified and accessed times for the file or directory

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index eabb4f20b7..e8f80b3f24 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -
    +
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 179a4e34fe..79e72c088f 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html @@ -1,4 +1,4 @@ createNonce | papi-dts
    +
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index c4b9f7df23..79575b45f6 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html @@ -1 +1 @@ -createUuid | papi-dts
    +createUuid | papi-dts
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index 3fa6e312db..ef75030dd8 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html +++ b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html @@ -3,4 +3,4 @@
  • encodingType:
        | "base64"
        | "base64url"
        | "binary"
        | "hex"

    String encoding to use for returning the binary hash value that is calculated

  • buffer: Buffer

    Raw data to be fed into the hash algorithm

  • Returns string

    String encoded value of the digest (https://csrc.nist.gov/glossary/term/hash_digest)

    -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index b0cc19ce5c..f33e0931ca 100644 --- a/papi-dts/functions/_node_utils_util_.getAppDir.html +++ b/papi-dts/functions/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts

    Gets the platform-specific user Platform.Bible folder for this application

    When running in development: <repo_directory>/dev-appdata

    When packaged: <user_home_directory>/.platform.bible

    -

    Properties

    Properties

    Properties

    clear: (() => void)
    diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 75e0f4644b..4799ce6f73 100644 --- a/papi-dts/functions/_node_utils_util_.getPathFromUri.html +++ b/papi-dts/functions/_node_utils_util_.getPathFromUri.html @@ -1,4 +1,4 @@ getPathFromUri | papi-dts
    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index b5e9fd060e..060c15ffc5 100644 --- a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html +++ b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html @@ -1,3 +1,3 @@ isNoisyDevModeEnvVariableSet | papi-dts

    FunctionisNoisyDevModeEnvVariableSet

    Determines if running in noisy dev mode

    • Returns boolean

      True if the process is running in noisy dev mode, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 45cf53187b..5ffa92d798 100644 --- a/papi-dts/functions/_node_utils_util_.joinUriPaths.html +++ b/papi-dts/functions/_node_utils_util_.joinUriPaths.html @@ -2,4 +2,4 @@

    Parameters

    Returns Uri

    One uri that combines the uri and the paths in left-to-right order

    -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index e0970029a6..ce8fe6bcea 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts
    +resolveHtmlPath | papi-dts
    diff --git a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html index eea96b65e9..a06dce528b 100644 --- a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html +++ b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html @@ -3,4 +3,4 @@ mitigate a dependency cycle

    Parameters

    Returns void

    +

    Returns void

    diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index ce094d1880..7af0cae0e5 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html index 7f2f45c623..4c8072115f 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html @@ -9,4 +9,4 @@ (result of this hook, if you want this hook to just return the network object again)

    Returns ((...args: THookParams) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html index 6c930823bb..681db26155 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html @@ -31,4 +31,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html index 83aee19681..2a935a77a1 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html @@ -3,4 +3,4 @@ useDataProvider, if you want this hook to just return the data provider again)

    Returns undefined | DataProviders[DataProviderName]

    Undefined if the data provider has not been retrieved, data provider if it has been retrieved and is not disposed, and undefined again if the data provider is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html index 69fb452084..b9e280e834 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html @@ -9,4 +9,4 @@ dataProviderSources. Each item in the array will be (a) undefined if the data provider has not been retrieved or has been disposed, or (b) a data provider if it has been retrieved and is not disposed.

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index 6051832051..e25f0b734f 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html @@ -59,7 +59,7 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook -
  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will open a dialog with the provided dialogType and options then run the resolveCallback with the dialog response or rejectCallback if there is an error. By default, only one dialog can be open at a time.

    @@ -105,4 +105,4 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html index f491a2d746..fd8f55597f 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html @@ -15,4 +15,4 @@
  • localizedStrings: The current state of the localizations, either defaultState or the stored state on the papi, if any
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index 08b9011693..e06c4b15c0 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -39,4 +39,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html index 220f0d7e68..592a9d3fa6 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html @@ -12,4 +12,4 @@

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

    undefined if the Project Data Provider has not been retrieved, the requested Project Data Provider if it has been retrieved and is not disposed, and undefined again if the Project Data Provider is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html index ae3242b25d..116eb743ea 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -30,4 +30,4 @@ setting
  • isLoading: whether the setting value is awaiting retrieval from the Project Data Provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html index cf6b9d5894..1ed2ff8d9b 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html @@ -22,4 +22,4 @@
  • setScrollGroupId: Function to use to update the scroll group with which this scrollGroupScrRef is synced
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 637bbd2550..f300d25590 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -18,4 +18,4 @@
  • setSetting: Function that updates the setting to a new value
  • resetSetting: Function that removes the setting and resets the value to defaultState
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html index 66037dc60e..da1de4ff08 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html @@ -9,4 +9,4 @@

    Returns undefined | NetworkObject<WebViewControllers[WebViewType]>

    undefined if the Web View Controller has not been retrieved, the requested Web View Controller if it has been retrieved and is not disposed, and undefined again if the Web View Controller is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index 67c4418b5e..eeb501bff2 100644 --- a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html +++ b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html @@ -1,2 +1,2 @@ blockWebSocketsToPapiNetwork | papi-dts

    Once our network is running, run this to stop extensions from connecting to it directly

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html index 4fa6030054..dc44b22621 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html @@ -1,2 +1,2 @@ getScrRefSync | papi-dts
    • See IScrollGroupRemoteService.getScrRef

      -

      Parameters

      • OptionalscrollGroupId: number

      Returns ScriptureReference

    +

    Parameters

    Returns ScriptureReference

    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html index 793ffcf2f4..47179d09e0 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html @@ -1,2 +1,2 @@ onDidUpdateScrRef | papi-dts

    Event that emits with information about a changed Scripture Reference for a scroll group

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html index ecbb4692f9..a2a8cd83af 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    +

    Returns boolean

    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html index 1fb43e81e3..abf1379d92 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html @@ -1,2 +1,2 @@ startScrollGroupService | papi-dts
    • Register the network object that backs the scroll group service

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html index a208124ba2..d1d663f7ab 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html @@ -4,4 +4,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

  • Returns JSONRPCErrorResponse

    JSONRPCErrorResponse message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html index 0e43280366..cc441d41e1 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html @@ -3,4 +3,4 @@
  • requestParams: RequestParams

    Parameters to pass along when the request is processed

  • requestId: RequestId

    Unique ID for this connection of this request

  • Returns JSONRPCRequest

    JSONRPCRequest message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html index 803f36ad03..f686b24b0c 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html @@ -3,4 +3,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

  • Returns JSONRPCSuccessResponse

    JSONRPCSuccessResponse message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html index 4c9c037000..75a06b075c 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html +++ b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html @@ -4,4 +4,4 @@ must not be converted to undefined per the JSONRPC protocol.

    After a request has been processed by the protocol stack, call fixupResponse to restore undefined responses.

    -

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    +

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html index 4b45b00a79..a832a513d9 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html @@ -1,4 +1,4 @@ fixupResponse | papi-dts
    • Convert null results back to undefined once we're out of the protocol stack.

      This works in tandem with deserializeMessage to properly handle null values in JSONRPC messages.

      -

      Parameters

      • response: JSONRPCResponse

      Returns JSONRPCResponse

    +

    Parameters

    Returns JSONRPCResponse

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html index 666d96079a..c1d3c69504 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html +++ b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html @@ -5,4 +5,4 @@
  • name: string

    Name of the handler running this request for logging purposes

  • requestType: string

    Type of request for logging purposes

  • Returns Promise<JSONRPCResponse>

    The response from the request including the method not found error if it times out

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html index f40a3a10f8..3ba8686d8f 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html +++ b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html @@ -1,2 +1,2 @@ sendPayloadToWebSocket | papi-dts
    • Serialize a payload, if needed, and send it over the provided WebSocket

      -

      Parameters

      • ws: undefined | WebSocket
      • payload: unknown

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index cba0e80ddb..e065c6cdc9 100644 --- a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html +++ b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html @@ -1,4 +1,4 @@ getDataProviderDataTypeFromFunctionName | papi-dts
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html index 812f89305d..9369b36a9c 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html @@ -15,4 +15,4 @@ expressions defining which interfaces should be excluded.

    Returns boolean

    A boolean value indicating whether the project interfaces satisfy the inclusion and exclusion criteria.

    -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html index c9d00f20de..c0ab5bd969 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html @@ -5,4 +5,4 @@

    Parameters

    Returns -1 | 0 | 1

    -1 if a is less than b, 0 if equal, and 1 otherwise

    -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html index bfac0cabfb..1045c079d8 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html @@ -1,4 +1,4 @@ getPDPFactoryIdFromNetworkObjectName | papi-dts
    • Transform a network object id for a pdp factory into its well-known pdp factory id

      Parameters

      • pdpFactoryNetworkObjectName: string

        Id for then network object for this pdp factory

      Returns string

      Id extensions use to identify this pdp factory

      -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html index a494975d4f..c21551e0a8 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html @@ -1,4 +1,4 @@ getPDPFactoryNetworkObjectNameFromId | papi-dts
    • Transform the well-known pdp factory id into an id for its network object to use

      Parameters

      • pdpFactoryId: string

        Id extensions use to identify this pdp factory

      Returns string

      Id for then network object for this pdp factory

      -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html index 7e9cf7203e..9f3107b486 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html @@ -3,4 +3,4 @@ provided by the PDP Factory with the matching id (or all PDP Factories if no id is specified) for the project will be returned. If you need projectInterfaces supported by specific PDP Factories, you can access it at ProjectMetadata.pdpFactoryInfo.

    -

    Parameters

    Returns Promise<ProjectMetadata[]>

    +

    Parameters

    Returns Promise<ProjectMetadata[]>

    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html index 5cc5955203..427867bbc7 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html @@ -1 +1 @@ -transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    +transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index 972451de36..6d5737751e 100644 --- a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html +++ b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html @@ -3,4 +3,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index a0709cef51..c96f06ba7d 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -7,4 +7,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

  • Returns Promise<UnsubscriberAsync>

    Promise that resolves if the command successfully registered and unsubscriber function to run to stop the passed-in function from handling commands

    -
    +
    diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index ec5c6eff45..bf42fdd710 100644 --- a/papi-dts/functions/_shared_services_command_service_.sendCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.sendCommand.html @@ -1,2 +1,2 @@ sendCommand | papi-dts

    Send a command to the backend.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index 55381a0b63..0e8dc111d0 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html @@ -1,4 +1,4 @@ getByType | papi-dts
    • Get a data provider that has previously been set up

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

      The data provider with the given name if one exists, undefined otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index 8e43863633..4cfa0f60ee 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -12,4 +12,4 @@ set methods are layered over to facilitate data provider subscriptions.

    Returns Promise<IDisposableDataProvider<"shared/models/data-provider.interface".default<TDataTypes>>>

    The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 4066ed088a..225ac2741b 100644 --- a/papi-dts/functions/_shared_services_logger_service_.formatLog.html +++ b/papi-dts/functions/_shared_services_logger_service_.formatLog.html @@ -3,4 +3,4 @@
  • serviceName: string

    Name of the service to show in the log

  • Optionaltag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html index dc126287f5..d00c925ebd 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html @@ -1,3 +1,3 @@ onDidCreateNetworkObject | papi-dts

    Event that fires when a new object has been created on the network (locally or remotely). The event contains information about the new network object.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html index 4cd0758ce0..a997d831ce 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html @@ -1,2 +1,2 @@ onDidDisposeNetworkObject | papi-dts

    Event that fires with a network object ID when that object is disposed locally or remotely

    -
    • Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index 97ca0fd22f..9ffc87f530 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html +++ b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html @@ -1,2 +1,2 @@ overrideDispose | papi-dts
    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index fb2dd1ff79..60ea9b27bc 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -4,4 +4,4 @@ emitters.

    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 353e540664..223803b915 100644 --- a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html +++ b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html @@ -3,4 +3,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index 4d86bee3e8..f546c5826d 100644 --- a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html +++ b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html @@ -1,4 +1,4 @@ getNetworkEvent | papi-dts

    Gets the network event with the specified type. Creates the emitter if it does not exist

    • Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PlatformEvent<T>

      Event for the event type that runs the callback provided when the event is emitted

      -
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index fc39e36fdf..86bef1f37e 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1 +1 @@ -initialize | papi-dts
    +initialize | papi-dts
    diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index 6658a13835..3d0b67a2eb 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<UnsubscriberAsync>

    Promise that resolves if the request successfully registered and unsubscriber function to run to stop the passed-in function from handling requests

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 8ac400ea09..3e3c2c12ca 100644 --- a/papi-dts/functions/_shared_services_network_service_.request.html +++ b/papi-dts/functions/_shared_services_network_service_.request.html @@ -2,4 +2,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 0247e1ddad..aaf8a42487 100644 --- a/papi-dts/functions/_shared_services_network_service_.shutdown.html +++ b/papi-dts/functions/_shared_services_network_service_.shutdown.html @@ -1,2 +1,2 @@ shutdown | papi-dts

    Closes the network services gracefully

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index 9f393d0f97..79cd13552c 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -13,4 +13,4 @@

    If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html index 64ac6a3e9a..38571e8e2e 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ should be available on the PDPEs created by this factory.

  • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

    Used in a ProjectDataProviderFactory to create ProjectDataProviders

  • Returns Promise<Dispose>

    Promise that resolves to a disposable object when the registration operation completes

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html index 5457190a8a..5f540e3667 100644 --- a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html +++ b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html @@ -7,4 +7,4 @@ contributions by.

    Returns Localized<ProjectSettingsContributionInfo["contributions"]> | undefined

    A filtered set of contributions, or undefined if no contributions match the project interfaces.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html index 36800434e7..67b2d165aa 100644 --- a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html +++ b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html @@ -1,2 +1,2 @@ createRpcHandler | papi-dts

    Creates a server or client RPC handler depending on if we're in main or some other process

    -
    +
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html index 8d776959ab..b3939032be 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html @@ -1 +1 @@ -getWebViewController | papi-dts
    +getWebViewController | papi-dts
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html index 93d5dbc307..ed1a0b4b38 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html @@ -1,2 +1,2 @@ getWebViewControllerObjectId | papi-dts

    Gets the id for the web view controller network object with the given name

    -
    +
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html index 3946a2e55a..e2752b2061 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html @@ -1,2 +1,2 @@ getWebViewMessageRequestType | papi-dts
    • Get request type for posting a message to a web view

      -

      Parameters

      • webViewId: string

      Returns `${string}:${string}`

    +

    Parameters

    Returns `${string}:${string}`

    diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index e0a961600d..50186463f0 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html +++ b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html @@ -1,3 +1,3 @@ getProcessType | papi-dts

    Gets which kind of process this is (main, renderer, extension-host)

    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index 57a63c5d53..4f7ed4a33b 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isClient.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isClient.html @@ -1,3 +1,3 @@ isClient | papi-dts

    Determine if running on a client process (renderer, extension-host) or on the server.

    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index a2a43ed7e8..e46e88ad9f 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html @@ -1,3 +1,3 @@ isExtensionHost | papi-dts

    Determine if running on the extension host

    • Returns boolean

      Returns true if running on the extension host, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index c5003a408b..a599fe6a58 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html @@ -1,3 +1,3 @@ isRenderer | papi-dts

    Determine if running on the renderer process

    • Returns boolean

      Returns true if running on the renderer, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index df4a0e74ed..3361088f96 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isServer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isServer.html @@ -1,3 +1,3 @@ isServer | papi-dts

    Determine if running on the server process (main)

    +
    diff --git a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html index 76fe4e64b0..2171dcf1c6 100644 --- a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html +++ b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html @@ -2,4 +2,4 @@ "this" in its functions refer to the object rather than the caller of the function. For example, if a function on the class is provided to a callback, if "this" isn't bound to the object then "this" will refer to the entity running the callback.

    -

    Type Parameters

    Parameters

    Returns void

    +

    Type Parameters

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index 5a00415732..f6bbd2114b 100644 --- a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html @@ -1,2 +1,2 @@ deserializeRequestType | papi-dts
    +

    Parameters

    Returns RequestType

    diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index 99d8e4ddc4..9a7cc1352a 100644 --- a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts
    • Get a message that says the module import was rejected and to try a similar api if available.

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

      String that says the import was rejected and a similar api to try

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index fc36b3d41a..5ad7236988 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

    WARNING: THIS IS NOT CURRENTLY CRYPTOGRAPHICALLY SECURE! TODO: Make this cryptographically random! Use some polymorphic library that works in all contexts? https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues only works in browser

    -

    Returns string

    +

    Returns string

    diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 2da44df28e..72cc741e1d 100644 --- a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -
    +
    diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index c7924ebcfe..6ad41dda3b 100644 --- a/papi-dts/functions/getSavedWebViewDefinition.html +++ b/papi-dts/functions/getSavedWebViewDefinition.html @@ -1,4 +1,4 @@ getSavedWebViewDefinition | papi-dts

    FunctiongetSavedWebViewDefinition

    Gets the saved properties on this WebView's WebView definition

    @returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -
    +
    diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index 7cdbce628b..d10df519b1 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    +getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index e51229912b..2cd5eceb48 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    FunctiongetWebViewState

    Retrieve the value from web view state with the given 'stateKey', if it exists. Otherwise return default value

    -
    +
    diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 56a8eb5bd0..79f6a84494 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    FunctionresetWebViewState

    Remove the value for a given key in the web view state

    -
    +
    diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index cb807cabd4..2f845a67cb 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    FunctionsetWebViewState

    Set the value for a given key in the web view state.

    -
    • Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    +
    diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index c9cfa94f96..7a4ccc6885 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -7,4 +7,4 @@
    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -
    +
    diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 449ddb792f..334ec7336e 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    +updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    diff --git a/papi-dts/functions/useWebViewScrollGroupScrRef.html b/papi-dts/functions/useWebViewScrollGroupScrRef.html index 1c0c7d824b..c699fd6da7 100644 --- a/papi-dts/functions/useWebViewScrollGroupScrRef.html +++ b/papi-dts/functions/useWebViewScrollGroupScrRef.html @@ -16,4 +16,4 @@
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -
    +
    diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 4b69a7335f..5d308c4f86 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -25,4 +25,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 463d56eec4..52edeeb7f9 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,7 +1,7 @@ webViewComponent | papi-dts

    FunctionwebViewComponent

    A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index 3206cb66ab..01c2e8bfae 100644 --- a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html +++ b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html @@ -1,10 +1,10 @@ IExtension | papi-dts

    Interface for all extensions to implement

    -
    interface IExtension {
        activate: ((context: ExecutionActivationContext) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    interface IExtension {
        activate: ((context: ExecutionActivationContext) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    activate: ((context: ExecutionActivationContext) => Promise<void>)

    Sets up this extension! Runs when paranext wants this extension to activate. For example, activate() should register commands for this extension

    Type declaration

      • (context): Promise<void>
      • Parameters

        Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context +

    Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context object given to activate().

    Promise that resolves to true if successfully deactivated

    -
    +
    diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index 13c53420e5..1a6896c4f4 100644 --- a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html +++ b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html @@ -1,4 +1,4 @@ -ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token: ExecutionToken, key: string) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>);
        readUserData: ((token: ExecutionToken, key: string) => Promise<string>);
        writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>);
    }

    Properties

    deleteUserData +ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token: ExecutionToken, key: string) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>);
        readUserData: ((token: ExecutionToken, key: string) => Promise<string>);
        writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>);
    }

    Properties

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

    -
    readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        +
    readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

        -
    readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        +
    readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

        -
    readUserData: ((token: ExecutionToken, key: string) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the +

    readUserData: ((token: ExecutionToken, key: string) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

        -
    writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the +

    writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 6ce09eca27..8b06c7cc5e 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -7,7 +7,7 @@
    declare module 'papi-shared-types' {
    export interface CommandHandlers {
    'myExtension.myCommand1': (foo: string, bar: number) => string;
    'myExtension.myCommand2': (foo: string) => Promise<void>;
    }
    }
    -
    interface CommandHandlers {
        platform.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }
    interface CommandHandlers {
        platform.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }

    Properties

    platform.openProjectSettings: ((webViewId: string) => Promise<void>)
    platform.openUserSettings: (() => Promise<void>)
    platform.quit: (() => Promise<void>)

    Shut down the application

    -
    platform.restart: (() => Promise<void>)

    Restart the application

    -
    platform.restartExtensionHost: (() => Promise<void>)
    test.addMany: ((...nums: number[]) => number)
    test.echo: ((message: string) => string)
    test.echoExtensionHost: ((message: string) => Promise<string>)
    test.throwError: ((message: string) => void)
    test.throwErrorExtensionHost: ((message: string) => void)
    +

    Properties

    platform.openProjectSettings: ((webViewId: string) => Promise<void>)
    platform.openUserSettings: (() => Promise<void>)
    platform.quit: (() => Promise<void>)

    Shut down the application

    +
    platform.restart: (() => Promise<void>)

    Restart the application

    +
    platform.restartExtensionHost: (() => Promise<void>)
    test.addMany: ((...nums: number[]) => number)
    test.echo: ((message: string) => string)
    test.echoExtensionHost: ((message: string) => Promise<string>)
    test.throwError: ((message: string) => void)
    test.throwErrorExtensionHost: ((message: string) => void)
    diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index ea02eaee71..ce4d6b4f01 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -11,6 +11,6 @@
    declare module 'papi-shared-types' {
    export type PeopleDataTypes = {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    };

    export type PeopleDataMethods = {
    deletePerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    };

    export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

    export interface DataProviders {
    'helloSomeone.people': PeopleDataProvider;
    }
    }
    -
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Properties

    +

    Properties

    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index 48a82644e0..ae71665489 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -34,10 +34,10 @@
    declare module 'papi-shared-types' {
    export type MyBaseProjectDataTypes = {
    MyProjectData: DataProviderDataType<string, string, string>;
    };

    export type MyLayeringProjectDataTypes = {
    MyOtherProjectData: DataProviderDataType<number, number, number>;
    };

    export interface ProjectDataProviderInterfaces {
    // Note that the base PDP implements `I**Base**ProjectDataProvider`
    MyExtensionBaseProjectInterface: IBaseProjectDataProvider<MyProjectDataTypes>;
    // Note that the layering PDP only implements `IProjectDataProvider` because the base PDP already
    // provides the `platform.base` data types
    MyExtensionLayeringProjectInterface: IProjectDataProvider<MyLayeringProjectDataTypes>;
    }
    }
    -
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    Properties

    Base projectInterface that all PDPs that expose their own unique project ids must implement.

    There should be a PDP that provides platform.base for all available project ids.

    -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index 4f4fd94a79..32eaad82a7 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -10,7 +10,7 @@
    declare module 'papi-shared-types' {
    export interface ProjectSettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    'World English Bible'
     
    -
    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it +

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it is editable by the current user.

    Projects that are not editable are sometimes called "resources".

    -
    platform.language: string

    Localized name of the language in which this project is written. This will be displayed +

    platform.language: string

    Localized name of the language in which this project is written. This will be displayed directly in the UI.

    'English'
     
    -
    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the +

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the UI.

    'WEB'
     
    -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 99c6b4a47b..28e8395e18 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -9,19 +9,19 @@
    declare module 'papi-shared-types' {
    export interface SettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.commentsEnabled: boolean

    Enable reading and writing comments in projects. This is an experimental feature.

    -
    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest +

    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest priority. Please always add 'en' (English) at the end when using this setting so everything localizes to English if it does not have a localization in a higher-priority locale.

    -
    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for +

    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for interacting with ParatextData.

    -
    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are +

    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are persisted objects containing some data. They are stored as xml strings.

    -
    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and +

    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and useWebViewScrollGroupScrRef

    -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html index af29adab4a..800fe4a383 100644 --- a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html +++ b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html @@ -18,6 +18,6 @@
    declare module 'papi-shared-types' {
    export type PeopleWebViewController = NetworkableObject<{
    setSelectedPerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    }>;

    export interface WebViewControllers {
    'helloSomeone.peopleWebView': PeopleWebViewController;
    }
    }
    -
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }

    Properties

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>
    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>
    +

    Properties

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>
    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>
    diff --git a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html index 17846e3c40..58dbbb9322 100644 --- a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html +++ b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html @@ -1,7 +1,7 @@ DialogTypes | papi-dts

    Mapped type for dialog functions to use in getting various types for dialogs

    Keys should be dialog names, and values should be DialogDataTypes

    If you add a dialog here, you must also add it on DIALOGS

    -

    Properties

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    +

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index 762148d4ae..6a0c44316e 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html @@ -1,6 +1,6 @@ FloatLayout | papi-dts

    Information about a floating window

    -
    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -
    type
    +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html index 9415a96d0a..9ba70e7f32 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html @@ -1,6 +1,6 @@ PanelLayout | papi-dts

    Information about a panel

    -
    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    -
    type
    +

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    +
    type
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index e23da6279a..e396497aac 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type
    +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index 33efa0902d..822a5da353 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    +
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html index c9ba28fbdb..3407fdc646 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,10 +1,10 @@ NetworkObjectStatusServiceType | papi-dts

    Provides functions related to the set of available network objects

    -
    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    +
    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    Type declaration

      • (objectDetailsToMatch, timeoutInMS?): Promise<NetworkObjectDetails>
      • Parameters

        • objectDetailsToMatch: Partial<NetworkObjectDetails>

          Subset of object details on the network object to wait for. Compared to object details using isSubset

        • OptionaltimeoutInMS: number

          Max duration to wait for the network object. If not provided, it will wait @@ -12,4 +12,4 @@

        Returns Promise<NetworkObjectDetails>

        Promise that either resolves to the NetworkObjectDetails for a network object once the network object is registered, or rejects if a timeout is provided and the timeout is reached before the network object is registered

        -
    +
    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html index 435802a583..72af027302 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html @@ -20,7 +20,7 @@

    To make creating a Layering PDPF easier, you can extend LayeringProjectDataProviderEngineFactory, which automatically fulfills the special requirements for Layering PDPFs. We highly recommend using it.

    -
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -46,4 +46,4 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index 19a64d41a1..884dffe9f6 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -6,11 +6,11 @@ and provide additional projectInterfaces on those projects (Layering PDP Factory). Base PDP Factories must create PDPs that support the platform.base projectInterface. See IBaseProjectDataProvider and ProjectDataProviderInterfaces for more information.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    Properties

    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    Methods

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -28,11 +28,11 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Returns the registered network object name of a PDP for the given project ID. Called by the +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Returns the registered network object name of a PDP for the given project ID. Called by the platform when someone uses the project data provider service to access a project's data.

      Parameters

      • projectId: string

        Id of the project for which to return a project data provider.

      Returns Promise<string>

      Id of the project data provider this IProjectDataProviderFactory created for this project id. It should return the same project data provider for the same combination of parameters throughout one session (in other words, in general, there should just be one project data provider for one project id).

      -
    +
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html index a946d86a38..6a867a5cab 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html @@ -4,7 +4,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    Type declaration

      • (localEventHandler): Promise<boolean>
      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves when finished connecting

        -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    +
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -
    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Unique network event type for coordinating between processes

    Event data to emit on the network

    -
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>
      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -
    +
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html index b3f8c6a157..99d8f7dacb 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html @@ -5,7 +5,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    Type declaration

      • (localEventHandler): Promise<boolean>
      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves when finished connecting

        -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    +
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -
    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Unique network event type for coordinating between processes

    Event data to emit on the network

    -
    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    -
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +
    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    +
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>
      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -
    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    -
    +
    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html index 3b1c70a0b0..bc19b6a8c1 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html @@ -1,12 +1,12 @@ IDisposableWebViewProvider | papi-dts

    A web view provider that has been registered with the PAPI and returned to the extension that registered it. It is able to be disposed with dispose.

    The PAPI returns this type from papi.webViewProviders.register.

    -
    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -34,4 +34,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html index a79c5dd0e1..74d6cc0565 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html @@ -2,10 +2,10 @@

    This is what the papi gives on webViewProviderService.get (not exposed on the PAPI). Basically a layer over NetworkObject

    This type is internal to core and is not used by extensions

    -
    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -33,4 +33,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html index d0c321023a..5088517d63 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html @@ -6,12 +6,12 @@ and extensions, you can extend the abstract class WebViewFactory to make the process easier. Alternatively, if you want to manage web view controllers manually, you can register them in IWebViewProvider.getWebView.

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -39,4 +39,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html index 9dfa034fe1..4983123096 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method: Function & {
                    doNotNotify?: boolean;
                }): void;
                (target: object, member: string): void;
            };
            ignore: {
                (method: Function & {
                    isIgnored?: boolean;
                }): void;
                (target: object, member: string): void;
            };
        };
        get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName: string) => boolean);
        registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method: Function & {
                    doNotNotify?: boolean;
                }): void;
                (target: object, member: string): void;
            };
            ignore: {
                (method: Function & {
                    isIgnored?: boolean;
                }): void;
                (target: object, member: string): void;
            };
        };
        get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName: string) => boolean);
        registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine decorators get hasKnown @@ -7,7 +7,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    IDataProviderEngine for more information on extending this class.

    -
    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

    A collection of decorators to be used with the data provider service

    +
    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

    A collection of decorators to be used with the data provider service

    Type declaration

    • doNotNotify: {
          (method: Function & {
              doNotNotify?: boolean;
          }): void;
          (target: object, member: string): void;
      }

      Decorator function that marks a data provider engine set<data_type> method not to automatically emit an update and notify subscribers of a change to the data. papi will still consider the set<data_type> method to be a data type method, but it will not layer over it to emit updates.

      @@ -81,19 +81,19 @@

      WARNING: Do not copy and paste this example. The @ symbol does not render correctly in JSDoc code blocks, so a different unicode character was used. Please use a normal @ when using a decorator.

      -
    get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    +
    get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    Type declaration

      • <DataProviderName>(providerName): Promise<DataProviders[DataProviderName] | undefined>
      • Get a data provider that has previously been set up

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

        The data provider with the given name if one exists, undefined otherwise

    Name of the desired data provider

    The data provider with the given name if one exists, undefined otherwise

    -
    hasKnown: ((providerName: string) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown: ((providerName: string) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider +

    Parameters

    • providerName: string

    Returns boolean

    registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider engine.

    Type declaration

      • <DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?): Promise<DisposableDataProviders[DataProviderName]>
      • Creates a data provider to be shared on the network layering over the provided data provider engine.

        @@ -121,4 +121,4 @@ set methods are layered over to facilitate data provider subscriptions.

        The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html index d35781ee68..74e9257c81 100644 --- a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html +++ b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html @@ -1,11 +1,11 @@ DialogService | papi-dts

    Prompt the user for responses with dialogs

    -
    interface DialogService {
        selectProject(options?: ProjectDialogOptionsBase): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType: DialogTabType, options?: DialogTypes[DialogTabType]["options"]): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    interface DialogService {
        selectProject(options?: ProjectDialogOptionsBase): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType: DialogTabType, options?: DialogTypes[DialogTabType]["options"]): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    • Shows a select project dialog to the user and prompts the user to select a dialog

      Parameters

      Returns Promise<undefined | string>

      Returns the user's selected project id or undefined if the user cancels

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index c8b01589ad..d8eeb9cddd 100644 --- a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html +++ b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html @@ -1,3 +1,3 @@ -InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    fetch +InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    Properties

    fetch: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Type declaration

      • (input, init?): Promise<Response>
      • Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input, init?): Promise<Response>
      • Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    +

    Parameters

    • input: RequestInfo | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • (input, init?): Promise<Response>
  • Parameters

    • input: string | Request | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html index d5c2b81130..9a8f0e8904 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html @@ -1,4 +1,4 @@ -MinimalNetworkObjectService | papi-dts
    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +MinimalNetworkObjectService | papi-dts
    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>)

    Type declaration

      • <T>(id, createLocalObjectToProxy?): Promise<undefined | NetworkObject<T>>
      • Get a network object that has previously been set up to be shared on the network. A network @@ -10,7 +10,7 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -
    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        +
    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -19,4 +19,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html index 777fc5e418..bcfca6c53a 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html @@ -1,4 +1,4 @@ -NetworkObjectService | papi-dts
    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts
    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get hasKnown initialize onDidCreateNetworkObject @@ -12,12 +12,12 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -
    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean
      • Search locally known network objects for the given ID. Don't look on the network for more +

    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean
      • Search locally known network objects for the given ID. Don't look on the network for more objects.

        Parameters

        • id: string

        Returns boolean

        Whether we know of an existing network object with the provided ID already on the network

        -
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        +
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -26,4 +26,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index bece8f0660..5c3dcdef9a 100644 --- a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html +++ b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html @@ -1,4 +1,4 @@ -PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>)

    Type declaration

      • <T>(eventType): PlatformEventEmitter<T>
      • Creates an event emitter that works properly over the network. Other connections receive this event when it is emitted.

        @@ -6,7 +6,7 @@ emitters.

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEventEmitter<T>

        Event emitter whose event works between connections

        -
    getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        +
    getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEvent<T>

        Event for the event type that runs the callback provided when the event is emitted

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index 5ca5dc87e4..16269159ce 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript @@ -15,11 +15,11 @@

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -
    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        +
    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        Type Parameters

        Parameters

        • pdpFactoryId: string

          Unique id for this PDP factory

        • projectInterfaces: SupportedProjectInterfaces

          The standardized sets of methods (projectInterfaces) supported by the Project Data Provider Engines produced by this factory. Indicates what sort of project data should be available on the PDPEs created by this factory.

        • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

        Promise that resolves to a disposable object when the registration operation completes

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index 64e59977cc..d74578a6c2 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    Properties

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript type for the returned project data provider will have the project data provider interface type @@ -14,4 +14,4 @@

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html index f65a4856aa..3b5a34bf1d 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,5 +1,5 @@ IProjectSettingsService | papi-dts

    Provides utility functions that project data providers should call when handling project settings

    -
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    Type Parameters

    Parameters

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

    The default value for the setting if a default value is registered

    If a default value is not registered for the setting

    -
    • Get the current set of project settings contribution info given all the input documents with +

    • Get the current set of project settings contribution info given all the input documents with all localized string keys localized properly.

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

      Localized project settings contribution info or undefined

      -
    • Calls registered project settings validators to determine whether or not a project setting change is valid.

      Every Project Data Provider must run this function when it receives a request to set a project setting before changing the value of the setting.

      @@ -23,7 +23,7 @@
    • currentValue: ProjectSettingTypes[ProjectSettingName]

      The current project setting value

    • OptionalallChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -
    +
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html index ecc0408ce4..5ec5147240 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html @@ -1,12 +1,12 @@ IScrollGroupRemoteService | papi-dts

    Parts of the Scroll Group Service that are exposed through the network object

    -
    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -
    • Sets the ScriptureReference associated with the provided scroll group

      +
    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html index ecf4ba9dd5..735ff8d949 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html @@ -1,14 +1,14 @@ IScrollGroupService | papi-dts

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>

    Event that emits with information about a changed Scripture Reference for a scroll group

    -

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      +

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -
    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 6c67824f00..b6d50692cd 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html @@ -1,4 +1,4 @@ -PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView +PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView register registerWebViewController registerWebViewProvider @@ -19,8 +19,8 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

    -

    Returns Promise<void>

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    13 November 2024. Renamed to registerWebViewProvider

    -
    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    13 November 2024. Renamed to registerWebViewProvider

    +
    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -33,10 +33,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<IDisposableWebViewProvider>

        webViewProvider modified to be a network object and able to be disposed with dispose

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index aeee6b40a6..df3b6d4063 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html @@ -1,4 +1,4 @@ -WebViewProviderService | papi-dts
    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider +WebViewProviderService | papi-dts
    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>)

    Type declaration

      • (webViewType): Promise<IRegisteredWebViewProvider | undefined>
      • Get a web view provider that has previously been set up

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<IRegisteredWebViewProvider | undefined>

        Web view provider with the given name if one exists, undefined otherwise

        -
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>
      • Sends a message to the specified web view. Expected to be used only by the +

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>
      • Sends a message to the specified web view. Expected to be used only by the IWebViewProvider that created the web view or the WebViewControllers that represents the web view created by the Web View Provider.

        postMessage is used to @@ -24,7 +24,7 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

        -

    Returns Promise<void>

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -37,10 +37,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<IDisposableWebViewProvider>

        webViewProvider modified to be a network object and able to be disposed with dispose

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html index 8e6077ad75..0cd6a603e1 100644 --- a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html +++ b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html @@ -1,7 +1,7 @@ WebViewServiceType | papi-dts

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    interface WebViewServiceType {
        getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    interface WebViewServiceType {
        getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    6 November 2024. Renamed to openWebView.

    -
    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    13 November 2024. Renamed to onDidOpenWebView

    -
    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    -
    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    -
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    -
    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and +

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    13 November 2024. Renamed to onDidOpenWebView

    +
    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    +
    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    +
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    +
    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and if the web view provider decides to give that existing one to you (it is up to the provider).

    Type declaration

      • (webViewType, layout?, options?): Promise<undefined | string>
      • Parameters

        • webViewType: string

          Type of WebView to create

        • Optionallayout: Layout

          Information about where you want the web view to go. Defaults to adding as a tab

          @@ -24,7 +24,7 @@

        Returns Promise<undefined | string>

        Promise that resolves to the ID of the webview we got or undefined if the provider did not create a WebView for this request.

    If something went wrong like the provider for the webViewType was not found

    -

    Methods

    • Gets the saved properties on the WebView definition with the specified ID

      +

    Methods

    • Gets the saved properties on the WebView definition with the specified ID

      Note: this only returns a representation of the current web view definition, not the actual web view definition itself. Changing properties on the returned definition does not affect the actual web view definition. You can possibly change the actual web view definition by calling @@ -33,8 +33,8 @@

      Parameters

      • webViewId: string

        The ID of the WebView whose saved properties to get

      Returns Promise<undefined | SavedWebViewDefinition>

      Saved properties of the WebView definition with the specified ID or undefined if not found

      -
    • Get an existing web view controller for an open web view.

      A Web View Controller is a network object that represents a web view and whose methods facilitate communication between its associated web view and extensions that want to interact with it.

      @@ -44,4 +44,4 @@
    • webViewId: string

      Id of web view for which to get the corresponding web view controller if one exists

    Returns Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>

    Web view controller with the given name if one exists, undefined otherwise

    -
    +
    diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index 2e0a9890dd..008102ba7d 100644 --- a/papi-dts/modules/__papi_backend_.html +++ b/papi-dts/modules/__papi_backend_.html @@ -1,4 +1,4 @@ -"@papi/backend" | papi-dts

    Namespace"@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine +"@papi/backend" | papi-dts

    Namespace"@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine commands DataProviderEngine dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 780b8c0b10..f1bd28f051 100644 --- a/papi-dts/modules/__papi_core_.html +++ b/papi-dts/modules/__papi_core_.html @@ -1,4 +1,4 @@ -"@papi/core" | papi-dts

    Namespace"@papi/core"

    References

    DataProviderDataType +"@papi/core" | papi-dts

    Namespace"@papi/core"

    References

    DataProviderDataType DataProviderSubscriberOptions DataProviderUpdateInstructions DialogOptions diff --git a/papi-dts/modules/__papi_frontend_.html b/papi-dts/modules/__papi_frontend_.html index ad8f236f7a..04e86cf668 100644 --- a/papi-dts/modules/__papi_frontend_.html +++ b/papi-dts/modules/__papi_frontend_.html @@ -1,4 +1,4 @@ -"@papi/frontend" | papi-dts

    Namespace"@papi/frontend"

    Index

    Type Aliases

    Papi +"@papi/frontend" | papi-dts

    Namespace"@papi/frontend"

    Index

    Type Aliases

    Variables

    commands dataProviders default diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index 60ec6cc466..9156e5d477 100644 --- a/papi-dts/modules/__papi_frontend_react_.html +++ b/papi-dts/modules/__papi_frontend_react_.html @@ -1,4 +1,4 @@ -"@papi/frontend/react" | papi-dts

    Namespace"@papi/frontend/react"

    References

    useData +"@papi/frontend/react" | papi-dts

    Namespace"@papi/frontend/react"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_client_services_rpc_client_.html b/papi-dts/modules/_client_services_rpc_client_.html index e98265de63..1a72744677 100644 --- a/papi-dts/modules/_client_services_rpc_client_.html +++ b/papi-dts/modules/_client_services_rpc_client_.html @@ -1,2 +1,2 @@ -"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    default +"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index bb389fa32e..e3a656dcb9 100644 --- a/papi-dts/modules/_client_services_web_socket_factory_.html +++ b/papi-dts/modules/_client_services_web_socket_factory_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.factory" | papi-dts

    Namespace"client/services/web-socket.factory"

    Index

    Functions

    createWebSocket +"client/services/web-socket.factory" | papi-dts

    Namespace"client/services/web-socket.factory"

    Index

    Functions

    diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 5885f95de2..881df06e1a 100644 --- a/papi-dts/modules/_client_services_web_socket_interface_.html +++ b/papi-dts/modules/_client_services_web_socket_interface_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.interface" | papi-dts

    Namespace"client/services/web-socket.interface"

    Index

    Type Aliases

    IWebSocket +"client/services/web-socket.interface" | papi-dts

    Namespace"client/services/web-socket.interface"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html index 5c4bb78c77..ce01131334 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace"extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    ExecutionActivationContext +"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace"extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html index edd2fd6314..d5c0c52a6f 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension.interface" | papi-dts

    Namespace"extension-host/extension-types/extension.interface"

    Index

    Interfaces

    IExtension +"extension-host/extension-types/extension.interface" | papi-dts

    Namespace"extension-host/extension-types/extension.interface"

    Index

    Interfaces

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html index 906e08f4d3..8d5a421ee3 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace"extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    ExtensionManifest +"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace"extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html index 4334a2f6dc..9cc3a3ca37 100644 --- a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html +++ b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html @@ -1,3 +1,3 @@ -"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace"extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    default +"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace"extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    Classes

    diff --git a/papi-dts/modules/_extension_host_services_extension_storage_service_.html b/papi-dts/modules/_extension_host_services_extension_storage_service_.html index 94e51d6688..a36dc88e20 100644 --- a/papi-dts/modules/_extension_host_services_extension_storage_service_.html +++ b/papi-dts/modules/_extension_host_services_extension_storage_service_.html @@ -1,4 +1,4 @@ -"extension-host/services/extension-storage.service" | papi-dts

    Namespace"extension-host/services/extension-storage.service"

    Index

    Interfaces

    ExtensionStorageService +"extension-host/services/extension-storage.service" | papi-dts

    Namespace"extension-host/services/extension-storage.service"

    Index

    Interfaces

    Variables

    Functions

    buildExtensionPathFromName setExtensionUris diff --git a/papi-dts/modules/_main_services_rpc_server_.html b/papi-dts/modules/_main_services_rpc_server_.html index 6e7bc1f5e9..aa86ac431c 100644 --- a/papi-dts/modules/_main_services_rpc_server_.html +++ b/papi-dts/modules/_main_services_rpc_server_.html @@ -1,3 +1,3 @@ -"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    default +"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_main_services_rpc_websocket_listener_.html b/papi-dts/modules/_main_services_rpc_websocket_listener_.html index 62b56198dc..adc2ef3661 100644 --- a/papi-dts/modules/_main_services_rpc_websocket_listener_.html +++ b/papi-dts/modules/_main_services_rpc_websocket_listener_.html @@ -1,2 +1,2 @@ -"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    default +"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 867188015b..e78349b187 100644 --- a/papi-dts/modules/_node_models_execution_token_model_.html +++ b/papi-dts/modules/_node_models_execution_token_model_.html @@ -1,3 +1,3 @@ -"node/models/execution-token.model" | papi-dts

    Namespace"node/models/execution-token.model"

    Index

    Classes

    ExecutionToken +"node/models/execution-token.model" | papi-dts

    Namespace"node/models/execution-token.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index c1de33a820..195f27ea39 100644 --- a/papi-dts/modules/_node_services_execution_token_service_.html +++ b/papi-dts/modules/_node_services_execution_token_service_.html @@ -1,2 +1,2 @@ -"node/services/execution-token.service" | papi-dts

    Namespace"node/services/execution-token.service"

    Index

    Variables

    default +"node/services/execution-token.service" | papi-dts

    Namespace"node/services/execution-token.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index dd9488361a..363a14e733 100644 --- a/papi-dts/modules/_node_services_node_file_system_service_.html +++ b/papi-dts/modules/_node_services_node_file_system_service_.html @@ -1,4 +1,4 @@ -"node/services/node-file-system.service" | papi-dts

    Namespace"node/services/node-file-system.service"

    Index

    Enumerations

    EntryType +"node/services/node-file-system.service" | papi-dts

    Namespace"node/services/node-file-system.service"

    Index

    Enumerations

    Type Aliases

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 43ac666e10..b980b0222c 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,4 +1,4 @@ -"node/utils/crypto-util" | papi-dts

    Namespace"node/utils/crypto-util"

    Index

    Functions

    createNonce +"node/utils/crypto-util" | papi-dts
    diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 4a07ccef2b..b351308090 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace"node/utils/util"

    Index

    Variables

    FILE_PROTOCOL +"node/utils/util" | papi-dts

    Namespace"node/utils/util"

    Index

    Variables

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 26b0060fa5..7d370521be 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace"papi-shared-types"

    Index

    Interfaces

    CommandHandlers +"papi-shared-types" | papi-dts

    Namespace"papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviderInterfaces ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index a366c52ff7..24cacd85af 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace"renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    DialogDefinitionBase +"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace"renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    Variables

    Functions

    hookUpDialogService diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html index 201fd0af74..5d5c331342 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace"renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    DialogTypes +"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace"renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    Type Aliases

    DialogDataTypes DialogDefinition DialogTabTypes diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html index 30c5cf224d..890d263b25 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index 6c6e12322d..4990509451 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index a256bb7e0f..71f430ae2e 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html @@ -1,4 +1,4 @@ -"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace"renderer/hooks/papi-hooks/index"

    References

    useData +"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace"renderer/hooks/papi-hooks/index"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html index e6eabbc089..3ea69feb92 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index 93a5ff1a4c..5ac2503af8 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index 6d58164495..2022b3ed08 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index f5999f8f08..c42db9773f 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    UseDialogCallbackOptions +"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html index f9c794c004..173fe4a074 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index c4bfadf808..fb94dec858 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index e3f135b7b5..5591521f6e 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html index 354c6db3f7..92769a4dd3 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html index 0cb49f5567..66a3ba1e2e 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index a7a3d46857..46c9e37cb7 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html index c9df90eea5..f185921ef4 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index 019a6f348f..c83abd65f5 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace"renderer/services/renderer-web-socket.service"

    Index

    Classes

    default +"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace"renderer/services/renderer-web-socket.service"

    Index

    Classes

    Functions

    diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index cf75d2eb72..637161d2d3 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace"renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    default +"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace"renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    diff --git a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html index 1a89e19edb..aebda2cf39 100644 --- a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html +++ b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html @@ -1,4 +1,4 @@ -"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    availableScrollGroupIds +"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    Functions

    getScrRefSync onDidUpdateScrRef setScrRefSync diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index d8830b8606..c19b23a3a6 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

    Namespace"shared/data/file-system.model"

    Index

    Type Aliases

    Uri +"shared/data/file-system.model" | papi-dts

    Namespace"shared/data/file-system.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_data_platform_data_.html b/papi-dts/modules/_shared_data_platform_data_.html index c6f4a1f5d9..19c1fef76f 100644 --- a/papi-dts/modules/_shared_data_platform_data_.html +++ b/papi-dts/modules/_shared_data_platform_data_.html @@ -1,3 +1,3 @@ -"shared/data/platform.data" | papi-dts

    Namespace"shared/data/platform.data"

    Index

    Variables

    DEV_MODE_RENDERER_INDICATOR +"shared/data/platform.data" | papi-dts
    diff --git a/papi-dts/modules/_shared_data_rpc_model_.html b/papi-dts/modules/_shared_data_rpc_model_.html index b768585ce8..acb0b73074 100644 --- a/papi-dts/modules/_shared_data_rpc_model_.html +++ b/papi-dts/modules/_shared_data_rpc_model_.html @@ -1,4 +1,4 @@ -"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    Type Aliases

    EventHandler InternalRequestHandler RequestId diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index f0db4d60ea..2ed6536b6f 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace"shared/global-this.model"

    Index

    Enumerations

    ProcessType +"shared/global-this.model" | papi-dts

    Namespace"shared/global-this.model"

    Index

    Enumerations

    diff --git a/papi-dts/modules/_shared_log_error_model_.html b/papi-dts/modules/_shared_log_error_model_.html index b9e85449ec..bcd2ab7a40 100644 --- a/papi-dts/modules/_shared_log_error_model_.html +++ b/papi-dts/modules/_shared_log_error_model_.html @@ -1,2 +1,2 @@ -"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    default +"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html index de0d87ddc3..a2919f07ad 100644 --- a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/base-project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/base-project-data-provider-engine.model"

    Index

    Classes

    BaseProjectDataProviderEngine +"shared/models/base-project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/base-project-data-provider-engine.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_create_process_privilege_model_.html b/papi-dts/modules/_shared_models_create_process_privilege_model_.html index 334e26ac2e..24f197f57f 100644 --- a/papi-dts/modules/_shared_models_create_process_privilege_model_.html +++ b/papi-dts/modules/_shared_models_create_process_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess +"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess OperatingSystemData PlatformFork PlatformSpawn diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index dd4c961342..f84c3e7b40 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

    Namespace"shared/models/data-provider-engine.model"

    Index

    Classes

    DataProviderEngine +"shared/models/data-provider-engine.model" | papi-dts

    Namespace"shared/models/data-provider-engine.model"

    Index

    Classes

    Type Aliases

    DataProviderEngineNotifyUpdate default WithNotifyUpdate diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 17ff3dfcc9..532b3e9df8 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

    Namespace"shared/models/data-provider.interface"

    Index

    Type Aliases

    default +"shared/models/data-provider.interface" | papi-dts

    Namespace"shared/models/data-provider.interface"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index 40f0b768f6..5eced6ed05 100644 --- a/papi-dts/modules/_shared_models_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider.model" | papi-dts

    Namespace"shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType +"shared/models/data-provider.model" | papi-dts

    Namespace"shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType DataProviderDataTypes DataProviderGetter DataProviderGetters diff --git a/papi-dts/modules/_shared_models_dialog_options_model_.html b/papi-dts/modules/_shared_models_dialog_options_model_.html index e0cf9af6a5..d19d426745 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,4 +1,4 @@ -"shared/models/dialog-options.model" | papi-dts

    Namespace"shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index f36a7b4b54..435cdb3240 100644 --- a/papi-dts/modules/_shared_models_docking_framework_model_.html +++ b/papi-dts/modules/_shared_models_docking_framework_model_.html @@ -1,4 +1,4 @@ -"shared/models/docking-framework.model" | papi-dts

    Namespace"shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout +"shared/models/docking-framework.model" | papi-dts

    Namespace"shared/models/docking-framework.model"

    Index

    Interfaces

    Type Aliases

    FloatPosition diff --git a/papi-dts/modules/_shared_models_elevated_privileges_model_.html b/papi-dts/modules/_shared_models_elevated_privileges_model_.html index 4ee686e662..8b6c4f3696 100644 --- a/papi-dts/modules/_shared_models_elevated_privileges_model_.html +++ b/papi-dts/modules/_shared_models_elevated_privileges_model_.html @@ -1,3 +1,3 @@ -"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames +"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_extension_basic_data_model_.html b/papi-dts/modules/_shared_models_extension_basic_data_model_.html index 4187187ab9..0f965e8b40 100644 --- a/papi-dts/modules/_shared_models_extension_basic_data_model_.html +++ b/papi-dts/modules/_shared_models_extension_basic_data_model_.html @@ -1,2 +1,2 @@ -"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    ExtensionBasicData +"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html index f7ca8b0351..b18d54c733 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace"shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    default +"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace"shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html index 220e7a92c5..39d714e0df 100644 --- a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html +++ b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction +"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction EnableExtensionFunction ExtensionIdentifier GetInstalledExtensionsFunction diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index 5b07969895..ef74eb07fc 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

    Namespace"shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject +"shared/models/network-object.model" | papi-dts

    Namespace"shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkableObject NetworkObject diff --git a/papi-dts/modules/_shared_models_network_object_status_service_model_.html b/papi-dts/modules/_shared_models_network_object_status_service_model_.html index b6595d56f3..b7e637d66e 100644 --- a/papi-dts/modules/_shared_models_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_models_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object-status.service-model" | papi-dts

    Namespace"shared/models/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/models/network-object-status.service-model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index edd6b714c6..9b096d09c6 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace"shared/models/papi-network-event-emitter.model"

    Index

    Classes

    default +"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace"shared/models/papi-network-event-emitter.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html index 573fdeb33b..44046b62af 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine-factory.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine-factory.model"

    Index

    Classes

    LayeringProjectDataProviderEngineFactory +"shared/models/project-data-provider-engine-factory.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index 5befbe533e..f5e053c64b 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine.model"

    Index

    Classes

    ProjectDataProviderEngine +"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index 3b6d4bbb35..551f44cad2 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace"shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    default +"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace"shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    Type Aliases

    Variables

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 0fec224655..38b4cb1ba9 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

    Namespace"shared/models/project-data-provider.model"

    Index

    Type Aliases

    ExtensionDataScope +"shared/models/project-data-provider.model" | papi-dts

    Namespace"shared/models/project-data-provider.model"

    Index

    Type Aliases

    Variables

    PROJECT_INTERFACE_PLATFORM_BASE diff --git a/papi-dts/modules/_shared_models_project_lookup_service_model_.html b/papi-dts/modules/_shared_models_project_lookup_service_model_.html index 44d41b7aa8..a5297a89fc 100644 --- a/papi-dts/modules/_shared_models_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_models_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-lookup.service-model" | papi-dts

    Namespace"shared/models/project-lookup.service-model"

    Index

    Type Aliases

    ProjectLookupServiceType +"shared/models/project-lookup.service-model" | papi-dts

    Namespace"shared/models/project-lookup.service-model"

    Index

    Type Aliases

    Variables

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE projectLookupServiceBase testingProjectLookupService diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index f386f6480d..f4c9b26742 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace"shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo +"shared/models/project-metadata.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_rpc_interface_.html b/papi-dts/modules/_shared_models_rpc_interface_.html index 49e9db0cc5..f711afdc9d 100644 --- a/papi-dts/modules/_shared_models_rpc_interface_.html +++ b/papi-dts/modules/_shared_models_rpc_interface_.html @@ -1,3 +1,3 @@ -"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    IRpcHandler +"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    diff --git a/papi-dts/modules/_shared_models_web_view_factory_model_.html b/papi-dts/modules/_shared_models_web_view_factory_model_.html index e629254dc0..7b5c324751 100644 --- a/papi-dts/modules/_shared_models_web_view_factory_model_.html +++ b/papi-dts/modules/_shared_models_web_view_factory_model_.html @@ -1,2 +1,2 @@ -"shared/models/web-view-factory.model" | papi-dts

    Namespace"shared/models/web-view-factory.model"

    Index

    Classes

    WebViewFactory +"shared/models/web-view-factory.model" | papi-dts

    Namespace"shared/models/web-view-factory.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 95ef1d36dd..b4d5967dd7 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

    Namespace"shared/models/web-view.model"

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

    Namespace"shared/models/web-view.model"

    Index

    Enumerations

    Type Aliases

    GetSavedWebViewDefinition GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index 3537d465f9..8faf1db7ef 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

    Namespace"shared/models/web-view-provider.model"

    Index

    Interfaces

    IDisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index 1692597045..e4650d183c 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace"shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace"shared/services/command.service"

    Index

    Type Aliases

    Functions

    createSendCommandFunction registerCommand sendCommand diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index 59b3b29434..3188d2fdbc 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

    Namespace"shared/services/data-provider.service"

    Index

    Interfaces

    DataProviderService +"shared/services/data-provider.service" | papi-dts

    Namespace"shared/services/data-provider.service"

    Index

    Interfaces

    Variables

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index a0dba89874..ce3e897c13 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace"shared/services/dialog.service"

    Index

    Variables

    default +"shared/services/dialog.service" | papi-dts

    Namespace"shared/services/dialog.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 4cbcc8a10e..98a03a56fe 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

    Namespace"shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

    Namespace"shared/services/dialog.service-model"

    Index

    Interfaces

    Variables

    diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index 9fbc331828..81ef7b5307 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace"shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Namespace"shared/services/internet.service"

    Index

    Interfaces

    Variables

    diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 6cb538530c..c4528b2c48 100644 --- a/papi-dts/modules/_shared_services_localization_service_.html +++ b/papi-dts/modules/_shared_services_localization_service_.html @@ -1,2 +1,2 @@ -"shared/services/localization.service" | papi-dts

    Namespace"shared/services/localization.service"

    Index

    Variables

    default +"shared/services/localization.service" | papi-dts

    Namespace"shared/services/localization.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index 7bd38e455b..386d88a7c3 100644 --- a/papi-dts/modules/_shared_services_localization_service_model_.html +++ b/papi-dts/modules/_shared_services_localization_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/localization.service-model" | papi-dts

    Namespace"shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService +"shared/services/localization.service-model" | papi-dts

    Namespace"shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationSelector diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 4488bc44a3..756a555aa3 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace"shared/services/logger.service"

    Index

    Variables

    default +"shared/services/logger.service" | papi-dts

    Namespace"shared/services/logger.service"

    Index

    Variables

    Functions

    diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index 497e62382a..1bebcef146 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

    Namespace"shared/services/menu-data.service"

    Index

    Variables

    default +"shared/services/menu-data.service" | papi-dts

    Namespace"shared/services/menu-data.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index fb1aeac136..c7a2b778e7 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

    Namespace"shared/services/menu-data.service-model"

    Index

    Type Aliases

    IMenuDataService +"shared/services/menu-data.service-model" | papi-dts

    Namespace"shared/services/menu-data.service-model"

    Index

    Type Aliases

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 5f088ea60c..8e4879fafd 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

    Namespace"shared/services/network-object.service"

    Index

    Interfaces

    MinimalNetworkObjectService +"shared/services/network-object.service" | papi-dts

    Namespace"shared/services/network-object.service"

    Index

    Interfaces

    Variables

    default minimalNetworkObjectService diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index 08ace64ee4..53dc309f90 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

    Namespace"shared/services/network-object-status.service"

    Index

    Variables

    default +"shared/services/network-object-status.service" | papi-dts

    Namespace"shared/services/network-object-status.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index afb09dd876..d5a47e7213 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace"shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService +"shared/services/network.service" | papi-dts

    Namespace"shared/services/network.service"

    Index

    Interfaces

    Variables

    Functions

    createNetworkEventEmitter createRequestFunction diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index 9ae73a6dab..4959961ee5 100644 --- a/papi-dts/modules/_shared_services_project_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_project_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/project-data-provider.service" | papi-dts

    Namespace"shared/services/project-data-provider.service"

    Index

    Interfaces

    PapiBackendProjectDataProviderService +"shared/services/project-data-provider.service" | papi-dts

    Namespace"shared/services/project-data-provider.service"

    Index

    Interfaces

    Variables

    papiBackendProjectDataProviderService papiFrontendProjectDataProviderService diff --git a/papi-dts/modules/_shared_services_project_lookup_service_.html b/papi-dts/modules/_shared_services_project_lookup_service_.html index 9026d256e4..d2c50fa88d 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace"shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Namespace"shared/services/project-lookup.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index b1c30417a0..4640252f24 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-settings.service" | papi-dts

    Namespace"shared/services/project-settings.service"

    Index

    Variables

    default +"shared/services/project-settings.service" | papi-dts
    diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index 94b924f116..7b52224106 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

    Namespace"shared/services/project-settings.service-model"

    Index

    Interfaces

    IProjectSettingsService +"shared/services/project-settings.service-model" | papi-dts

    Namespace"shared/services/project-settings.service-model"

    Index

    Interfaces

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_rpc_handler_factory_.html b/papi-dts/modules/_shared_services_rpc_handler_factory_.html index 776065cecd..651f6d027c 100644 --- a/papi-dts/modules/_shared_services_rpc_handler_factory_.html +++ b/papi-dts/modules/_shared_services_rpc_handler_factory_.html @@ -1,2 +1,2 @@ -"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    createRpcHandler +"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_.html b/papi-dts/modules/_shared_services_scroll_group_service_.html index 5cb705d62d..60277e3cbb 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_.html @@ -1,2 +1,2 @@ -"shared/services/scroll-group.service" | papi-dts

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

    default +"shared/services/scroll-group.service" | papi-dts

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_model_.html b/papi-dts/modules/_shared_services_scroll_group_service_model_.html index 40916f01cf..88bbbfd783 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_model_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    IScrollGroupRemoteService +"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    Type Aliases

    ScrollGroupScrRef ScrollGroupUpdateInfo diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 964bc3e0cb..c55030069e 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace"shared/services/settings.service"

    Index

    Variables

    default +"shared/services/settings.service" | papi-dts

    Namespace"shared/services/settings.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index 9b6f887210..272a3d0f30 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

    Namespace"shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData +"shared/services/settings.service-model" | papi-dts

    Namespace"shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index 779f3983c8..fefeaf37d4 100644 --- a/papi-dts/modules/_shared_services_web_view_provider_service_.html +++ b/papi-dts/modules/_shared_services_web_view_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/web-view-provider.service" | papi-dts

    Namespace"shared/services/web-view-provider.service"

    Index

    Interfaces

    PapiWebViewProviderService +"shared/services/web-view-provider.service" | papi-dts

    Namespace"shared/services/web-view-provider.service"

    Index

    Interfaces

    Variables

    default papiWebViewProviderService diff --git a/papi-dts/modules/_shared_services_web_view_service_.html b/papi-dts/modules/_shared_services_web_view_service_.html index 7290e556f9..06d1bb5f6b 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

    Namespace"shared/services/web-view.service"

    Index

    Variables

    default +"shared/services/web-view.service" | papi-dts

    Namespace"shared/services/web-view.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index 5c789519a8..90aba300f9 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

    Namespace"shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Namespace"shared/services/web-view.service-model"

    Index

    Interfaces

    Type Aliases

    CloseWebViewEvent OpenWebViewEvent UpdateWebViewEvent diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 6fe9111c1f..2a91cbdfb1 100644 --- a/papi-dts/modules/_shared_utils_internal_util_.html +++ b/papi-dts/modules/_shared_utils_internal_util_.html @@ -1,4 +1,4 @@ -"shared/utils/internal-util" | papi-dts

    Namespace"shared/utils/internal-util"

    Index

    Functions

    getProcessType +"shared/utils/internal-util" | papi-dts

    Namespace"shared/utils/internal-util"

    Index

    Functions

    getProcessType isClient isExtensionHost isRenderer diff --git a/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html index 850b30cb36..9f455bb625 100644 --- a/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html +++ b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html @@ -1,4 +1,4 @@ -"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    default +"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    Type Aliases

    AllProjectSettingsInfo LocalizedProjectSettingsContributionInfo ProjectSettingInfo diff --git a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html index 3534e1777f..261fa107d5 100644 --- a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html +++ b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html @@ -1,4 +1,4 @@ -"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    default +"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    Type Aliases

    AllSettingsInfo LocalizedSettingsContributionInfo SettingInfo diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index c8b63d4304..9796a2fda4 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace"shared/utils/util"

    Index

    Type Aliases

    RequestType +"shared/utils/util" | papi-dts

    Namespace"shared/utils/util"

    Index

    Type Aliases

    Variables

    MODULE_SIMILAR_APIS REQUEST_TYPE_SEPARATOR diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 0ef75ea5c5..e247487abe 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts
    +Papi | papi-dts
    diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index efb4983ee1..69bbf822e8 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -
    +
    diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index a36f1ec847..06567908a1 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -9,4 +9,4 @@
  • executionToken: ExecutionToken

    Used to save and load data by the storage service.

  • name: string

    Canonical name of the extension

  • registrations: UnsubscriberAsyncList

    Tracks all registrations made by an extension so they can be cleaned up when it is unloaded

    -
  • +
    diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index 154206c70d..bae10c9706 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -23,4 +23,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -
  • +
    diff --git a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html index 2dd7a311eb..a2b9d316cf 100644 --- a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html +++ b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html @@ -1 +1 @@ -PropagateEventMethod | papi-dts
    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)
    +PropagateEventMethod | papi-dts
    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)
    diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index 2c363edeac..b4b298fd27 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts
    ExecutionTokenType

    For now this is just for extensions, but maybe we will want to expand this in the future

    -
    +
    diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index 2924d8ccdd..27bff58fd6 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts
    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 3d94ef43ae..9699a8a2d9 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -3,4 +3,4 @@
    'platform.quit';
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index 2dc3a1194d..583404f3d1 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -3,4 +3,4 @@
    'platform.placeholder'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index e4dfb078ce..b9050a76f2 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -4,4 +4,4 @@
    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index c953b6cf47..2cf7768be1 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index c81d0b13d0..8311a6b40f 100644 --- a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html @@ -19,4 +19,4 @@
  • callback: ((value: ProjectSettingTypes[ProjectSettingName]) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index 876265c8e1..eb71f17286 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -10,4 +10,4 @@ IBaseProjectDataProvider, which imposes additional requirements.

    See more information, including the difference between Base and Layering PDPs, at ProjectDataProviderInterfaces.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 46137b3316..3e6a5fe0bf 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Type AliasNotesOnlyProjectDataTypes

    NotesOnlyProjectDataTypes: MandatoryProjectDataTypes & {
        Notes: DataProviderDataType<string, string | undefined, string>;
    }

    This is just a simple example so we have more than one. It's not intended to be real.

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 95db6efbe3..e9c8cd5fb1 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }
    +PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index 1fe1e9583d..f492a5eea6 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -8,4 +8,4 @@
    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index 7ce0f16fd0..62cd28e31c 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -7,4 +7,4 @@
    'platform.notesOnly'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index a463739b09..36758eeb1b 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -4,4 +4,4 @@
    'platform.fullName'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 337fddf850..f1b1ab8ffd 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -3,4 +3,4 @@
    'platform.verseRef'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index 1f9e530a10..6c3231d286 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }
    +StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }
    diff --git a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html index 84596fcefa..5256275c7f 100644 --- a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html +++ b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html @@ -4,4 +4,4 @@
    'platform.placeholderWebView'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index ab7cb1de83..6782fabd00 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@
  • newSetting: ProjectSettingTypes[ProjectSettingName]

    The value that is to be set to the project setting.

  • Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index 0d134e8d47..7a04e54315 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -14,4 +14,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • OptionaltabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index 7f3412f52a..cd30aa0a8b 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts
    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage: string): void;
        submitDialog(data: TData): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

    • cancelDialog:function
      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

    • submitDialog:function
      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • Sends the data as a resolved response to the dialog request and closes the dialog

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

  • +

    Returns void

    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index e8b8bff6a3..5f05ca7056 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -
  • +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 58ce30e3a4..98312a3a58 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    +DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 7c042174b6..270798f08e 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts
    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index 9524359a65..13c0f72a91 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts
    +ProjectDialogOptionsBase | papi-dts
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html index 49fe6d52e5..4b0907eb6c 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html @@ -1,3 +1,3 @@ SelectBooksDialogOptions | papi-dts
    SelectBooksDialogOptions: DialogOptions & {
        selectedBookIds?: string[];
    }

    Options to provide when showing the Select Books dialog

    Type declaration

    • OptionalselectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index ecc45d8903..f36391c638 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts
    SelectMultipleProjectsDialogOptions: ProjectDialogOptionsBase & {
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • OptionalselectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index d1ada26757..6f3c8067e5 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,2 +1,2 @@ SelectProjectDialogOptions | papi-dts
    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -
    +
    diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index 91875eb847..3396ccd5a4 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts
    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • OptionalmaximumOpenDialogs?: number

      How many dialogs are allowed to be open at once from this dialog callback. Calling the callback when this number of maximum open dialogs has been reached does nothing. Set to -1 for unlimited. Defaults to 1.

      -
    +
    diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index a22363d3c9..26a0f64594 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -29,4 +29,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html index 477b2bbf9c..aff03360ef 100644 --- a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html @@ -1,2 +1,2 @@ EventHandler | papi-dts
    EventHandler: (<T>(eventType: string, event: T) => void)

    Function that processes an event received locally or over the network

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html index 66f53ce0b7..7db68e50b8 100644 --- a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html @@ -1,4 +1,4 @@ InternalRequestHandler | papi-dts
    InternalRequestHandler: ((...requestParams: RequestParams) => any)

    Function to call internally when a request is received. The return value is sent back as the response to the request. If the request was received over the network, the response will be packaged into a JSONRPCSuccessResponse message.

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestId.html b/papi-dts/types/_shared_data_rpc_model_.RequestId.html index d9dc0b2888..3f8da5928a 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestId.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestId.html @@ -1,3 +1,3 @@ RequestId | papi-dts
    RequestId: number | string

    ID of an individual request. It must be unique between an RPC client and server for a single connection. Once a connection has closed and reopens, IDs can be reused.

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html index 42ed0c0fee..8707743237 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html @@ -1,2 +1,2 @@ RequestParams | papi-dts
    RequestParams: any[]

    Parameters provided to an RPC request message

    -
    +
    diff --git a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html index 55593360ed..8a2d5ebc0c 100644 --- a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html @@ -30,4 +30,4 @@
    class MyPDPE implements IBaseProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html index 501ef5c967..58768897a9 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html @@ -1 +1 @@ -CreateProcess | papi-dts
    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }
    +CreateProcess | papi-dts
    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html index e29b4d0273..888ee5952e 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html @@ -2,4 +2,4 @@

    Type declaration

    • platform: string

      Value of os.platform() in Node

    • release: string

      Value of os.release() in Node

    • type: string

      Value of os.type() in Node

      -
    +
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html index 52cd2a0773..d94b41262d 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html @@ -19,4 +19,4 @@ createProcess.fork(executionToken, 'assets/childProcess.js'); -
    +
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html index f2abb4f6f1..b9bd1b4226 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html @@ -31,4 +31,4 @@ } -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 28203dac41..f9fd13fae4 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -22,4 +22,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index aeabe0fe87..c89177b294 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -29,4 +29,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index b4a8d36484..bfc924a70f 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -26,4 +26,4 @@
    class MyDPE implements IDataProviderEngine<MyDataTypes> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index 18099df208..8ab8b8000f 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    +
    diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 04021e3ad8..7ea34b9196 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with papi.dataProviders.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index 425cdf6baa..1913a70fa7 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -
  • +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index 02e8ff4843..4d5f69115b 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -8,4 +8,4 @@
    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index 9c34f1736b..d2490a0c37 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Type Parameters

    Type declaration

      • (selector): Promise<TDataType["getData"]>
      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

        The subset of data represented by the selector

        -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index ead821383d..f33140b3cd 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Type AliasDataProviderGetters<TDataTypes>

    DataProviderGetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `get${DataType & string}`]: DataProviderGetter<TDataTypes[DataType]>
    }

    Set of all get<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderGetter for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index fd248ead4c..388e72fc09 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    DataProviderUpdateInstructions for more info on what to return

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 5562bb4f57..a374d9807e 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Type AliasDataProviderSetters<TDataTypes>

    DataProviderSetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `set${DataType & string}`]: DataProviderSetter<TDataTypes, DataType>
    }

    Set of all set<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderSetter for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 726f83eaa1..f32c793578 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PlatformEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optionaloptions: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index f24d2fba66..fdbb03f134 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -25,4 +25,4 @@
    'deeply-equal'
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index 0c75f835db..a920e91f55 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Type AliasDataProviderSubscribers<TDataTypes>

    DataProviderSubscribers<TDataTypes>: {
        [DataType in keyof TDataTypes as `subscribe${DataType & string}`]: DataProviderSubscriber<TDataTypes[DataType]>
    }

    Set of all subscribe<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderSubscriber for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index ae67c39bab..3418907c54 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -21,4 +21,4 @@

    false (or falsy) do not update subscriptions

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index 7e94e097d1..bf3b69147d 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts
    DataTypeNames<TDataTypes>: keyof TDataTypes & string

    Names of data types in a DataProviderDataTypes type. Indicates the data types that a data provider can handle (so it will have methods with these names like set<data_type>)

    Type Parameters

    DataProviderDataTypes for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index 4e0e1c45c0..d787e6eb8e 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    IDataProvider

    -
    +
    diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 39545b95e9..71e26be048 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts
    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -
    +
    diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index 8255fa1f9f..58dd117db0 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -6,4 +6,4 @@
  • Optionaltitle?: string | LocalizeKey

    Dialog title to display in the header. If you provide a LocalizeKey, it will be localized before displaying.

    Default depends on the dialog

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index bf3acc20b7..77c0a4a848 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
  • -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index 563ae972d3..2474e7da94 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts
    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index 2afb826901..fc048395f3 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Information about how a Paranext tab fits into the dock layout

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index dd1122b06a..bd67d34e0e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -7,4 +7,4 @@
  • OptionalwebViewDefinition: WebViewDefinition

    The web view definition if the edit was on a web view; undefined otherwise

  • Returns Promise<void>

    Promise that resolves when finished doing things

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index d33c6ac65f..dcbc39d0ef 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts
    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"
    +PanelDirection | papi-dts
    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index cb6cb4019f..e3d2481098 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

  • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index a043d04621..c3395faf5e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 1b82838b06..df469ba316 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -11,4 +11,4 @@
  • tabTitle: string | LocalizeKey

    Text to show (or a localizeKey that will automatically be localized) on the title bar of the tab

  • OptionaltabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 6985ef6c47..46f4e55b1a 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts
    TabLoader: ((savedTabInfo: SavedTabInfo) => TabInfo)

    Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

    For now all tab creators must do their own data type verification

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index d2b707026d..3647c444bd 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Type declaration

      • (tabInfo): SavedTabInfo | undefined
      • Parameters

        • tabInfo: TabInfo

          The Paranext tab to save

        Returns SavedTabInfo | undefined

        The saved tab info for Paranext to persist. If undefined, does not save the tab

        -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index 189b5f0efa..770f22f133 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts
    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -
    +
    diff --git a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html index d15d4a039b..90510625eb 100644 --- a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html +++ b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html @@ -1,4 +1,4 @@ ElevatedPrivileges | papi-dts
    ElevatedPrivileges: {
        createProcess: CreateProcess | undefined;
        manageExtensions: ManageExtensions | undefined;
    }

    Object that contains properties with special capabilities for extensions that required them

    Type declaration

    • createProcess: CreateProcess | undefined

      Functions that can be run to start new processes

    • manageExtensions: ManageExtensions | undefined

      Functions that can be run to manage what extensions are running

      -
    +
    diff --git a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html index 118131ee3e..62a4486adb 100644 --- a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html +++ b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html @@ -1,3 +1,3 @@ ExtensionBasicData | papi-dts
    ExtensionBasicData: {
        name: string;
    }

    Represents an object that contains the most basic information about an extension

    Type declaration

    • name: string

      Name of an extension

      -
    +
    diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index e41b00b409..e910388327 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    • TDataProvider
    +

    Type Parameters

    • TDataProvider
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html index 2672ac0343..23d861aae1 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html @@ -1,4 +1,4 @@ DisableExtensionFunction | papi-dts
    DisableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Stop running an extension that had been previously downloaded and enabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html index 7333850a76..30413b2821 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html @@ -1,4 +1,4 @@ EnableExtensionFunction | papi-dts
    EnableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Start running an extension that had been previously downloaded and disabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html index 96201b7522..6715a13e1b 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html @@ -1,2 +1,2 @@ ExtensionIdentifier | papi-dts
    ExtensionIdentifier: {
        extensionName: string;
        extensionVersion: string;
    }

    Represents an extension that can be enabled or disabled

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html index dedb4b18e7..a877d7c84c 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html @@ -1,2 +1,2 @@ GetInstalledExtensionsFunction | papi-dts
    GetInstalledExtensionsFunction: (() => Promise<InstalledExtensions>)

    Get extension identifiers of all extensions on the system

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html index 7cf8057ae3..9e6cf06213 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html @@ -1,2 +1,2 @@ HashValues | papi-dts
    HashValues: Partial<{
        sha256: string;
        sha512: string;
    }>

    Base64 encoded hash values

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html index b42a7a9f64..b4dc23f5ac 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html @@ -6,4 +6,4 @@ validation. For example, if you provide a sha256 hash value and a sha512 hash value, the installer may only use the sha512 hash value for validation.

    Returns Promise<void>

    Promise that resolves when the extension has been installed

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html index c5fa180105..3584c032c4 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html @@ -8,4 +8,4 @@ or removed from the set of enabled extensions.

  • packaged: ExtensionIdentifier[]

    Extensions that are explicitly bundled to be part of the application. They cannot be disabled. At runtime no extensions can be added or removed from the set of packaged extensions.

    -
  • +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html index eeff3121d2..be68c6cf83 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html @@ -3,4 +3,4 @@
  • enableExtension: EnableExtensionFunction

    Function to start running an extension that had been previously downloaded and disabled

  • getInstalledExtensions: GetInstalledExtensionsFunction

    Function to retrieve details about all installed extensions

  • installExtension: InstallExtensionFunction

    Function to download an extension and enable it

    -
  • +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index 44c9e59ab5..794cd51674 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts
    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

    An object of this type is returned from networkObjectService.set.

    Type Parameters

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index aa760d2c0d..361ca5d603 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 5375ffb212..76a641768b 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 33be2824e7..185f55a37b 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index a8448ee7f3..45290fbdc0 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts
    NetworkableObject<T>: T & CannotHaveOnDidDispose

    An object of this type is passed into networkObjectService.set.

    Type Parameters

    • T = object

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index f844153115..5f5379a6fb 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -29,4 +29,4 @@
    class MyPDPE implements IProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html index ddb13927dd..73177c826d 100644 --- a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html @@ -1,3 +1,3 @@ ProjectMetadataFilterOptions | papi-dts
    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • OptionalexcludeProjectIds?: string | string[]

      Project IDs to exclude

    • OptionalincludeProjectIds?: string | string[]

      Project IDs to include

      -
    +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index a0406f2899..359dfe5543 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index 37d3caddc3..9bbb329f98 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -54,4 +54,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -
    +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index 74b7b33929..8d64b6257e 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function
  • +
    diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index 8d58d3d015..f7dee4b825 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -8,8 +8,8 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator:

    Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b, a ≠ á, a = A.

    -

    Parameters

    • projectIdA: string
    • projectIdB: string

    Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
    • Provide metadata for all projects that have PDP factories

      +

      Parameters

      • projectIdA: string
      • projectIdB: string

      Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
    • Provide metadata for all projects that have PDP factories

      Note: If there are multiple PDPs available whose metadata matches the conditions provided by the parameters, their project metadata will all be combined, so all available projectInterfaces provided by the PDP Factory with the matching id (or all PDP Factories if @@ -20,7 +20,7 @@ As a result, a PDP factory that intends to layer over other PDP factories must specify its id in options.excludePdpFactoryIds to avoid an infinite loop of calling this function.

    Returns Promise<ProjectMetadata[]>

    ProjectMetadata for all projects stored on the local system

    -
  • getMetadataForProject:function
  • getMetadataForProject:function
    • Look up metadata for a specific project ID

      Note: If there are multiple PDPs available whose metadata matches the conditions provided by the parameters, their project metadata will all be combined, so all available projectInterfaces provided by the PDP Factory with the matching id (or all PDP Factories if @@ -32,7 +32,7 @@

    • OptionalpdpFactoryId: string

      Optional ID of the PDP factory where the project ID should be loaded. If not provided, then look in all available PDP factories for the given project ID.

    Returns Promise<ProjectMetadata>

    ProjectMetadata for the given project

    -
  • getMinimalMatchPdpFactoryId:function
    • Get the PDP Factory info whose projectInterfaces are most minimally matching to the provided +

  • getMinimalMatchPdpFactoryId:function
    • Get the PDP Factory info whose projectInterfaces are most minimally matching to the provided projectInterface

      Hopefully this will allow us to get the PDP that most closely matches the projectInterfaces to avoid unnecessary redirects through layered PDPs

      @@ -41,5 +41,5 @@

    Returns undefined | string

    PDP Factory id whose projectInterfaces minimally match the provided projectInterface if at least one PDP Factory was found that supports the projectInterface provided

    -
  • mergeMetadataFilters:function
  • +
  • mergeMetadataFilters:function
  • diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html index c2f41735df..90add7a787 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html @@ -1,4 +1,4 @@ ProjectDataProviderFactoryMetadataInfo | papi-dts
    ProjectDataProviderFactoryMetadataInfo: {
        projectInterfaces: ProjectInterfaces[];
    }

    Type declaration

    • projectInterfaces: ProjectInterfaces[]

      Which projectInterfaces (aka standardized sets of methods on a PDP) the Project Data Provider for this project created by this Project Data Provider Factory supports. Indicates what sort of project data should be available on this project from this PDP Factory.

      -
    +
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index c385667497..0f3985382d 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -12,4 +12,4 @@

    The keys of this object are ids of the PDP Factories that provide the metadata, namely the projectInterfaces for this project (meaning this PDPF can provide a Project Data Provider for this project with these projectInterfaces)

    -
    +
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html index de428e5e18..e069ad70fa 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html @@ -6,4 +6,4 @@
  • projectInterfaces: ProjectInterfaces[]

    All projectInterfaces (aka standardized sets of methods on a PDP) that Project Data Providers for this project support. Indicates what sort of project data should be available on this project.

    -
  • +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html index c61cc13afd..eed1f38b9e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html @@ -1,4 +1,4 @@ GetSavedWebViewDefinition | papi-dts
    GetSavedWebViewDefinition: (() => SavedWebViewDefinition | undefined)

    Gets the saved properties on this WebView's WebView definition

    @returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 1689421023..f7065c6bae 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index c93fcf3402..9bc1586545 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html index 0d7bd0185d..ed67a45310 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html @@ -1,3 +1,3 @@ SavedWebViewDefinitionOmittedKeys | papi-dts
    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index 9b4a7ae65a..de5cc77801 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -7,4 +7,4 @@
    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html index 7af1634bcb..38d3efe40c 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html @@ -16,4 +16,4 @@
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index bc0075e456..0e3f85c795 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -25,4 +25,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index 592ffe78a9..814b3eeaef 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Properties defining a type of WebView created by extensions to show web content

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index 5d074b3e1e..0231d71b31 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -106,4 +106,4 @@ WebView

  • Optionaltooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index 1073ed470f..65881106ce 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts
    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 181db75eff..bdfaf4dfa2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts
    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • OptionalcontentType?: React

      Indicates this WebView uses React

    • Optionalstyles?: string

      String of styles to be loaded into the iframe for this WebView

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index 64b9404661..451ecd997e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts
    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index 42c1242eac..74fb7150b7 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts
    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, typeof WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS[number]>

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index c1600a689a..5a270c80d1 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts
    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index 6b0b83f162..3e23749eb3 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts
    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index a2e1d1cc59..78cb27c6c3 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -53,4 +53,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index 0a8d3851d5..71da224d8a 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts
    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -
    +
    diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 641ae123a9..8974d1a4a7 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts
    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index 4d56f7d227..dd9d89f4c8 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@

    Returns Promise<LocalizationData>

    Object whose keys are localizeKeys and values are localized strings

  • setLocalizedString:function
  • setLocalizedStrings:function
  • setLocalizedStrings:function
  • Type declaration

    • getLocalizedIdFromBookNumber:function
      • This function is used to take a book number from a verse ref and return the localized name of +

    Type declaration

    • getLocalizedIdFromBookNumber:function
      • This function is used to take a book number from a verse ref and return the localized name of the book so that the book name can be displayed in the UI language within the UI

        -

        Parameters

        • bookNum: number
        • localizationLanguage: string

        Returns Promise<string>

    +

    Parameters

    • bookNum: number
    • localizationLanguage: string

    Returns Promise<string>

    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index 86e720c52f..5d7a923ee5 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts
    LocalizationData: LanguageStrings
    +LocalizationData | papi-dts
    LocalizationData: LanguageStrings
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index f828d97bb3..5883ee8840 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts
    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }
    +LocalizationDataDataTypes | papi-dts
    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index cbfb1655ee..3864283e41 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts
    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }
    +LocalizationSelector | papi-dts
    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index 793defe352..b1236c429f 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts
    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }
    +LocalizationSelectors | papi-dts
    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index 848bb250c8..df71bc395c 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

    Type declaration

    • getMainMenu:function
      • Get menu content for the main menu

        Parameters

        • mainMenuType: undefined

          Does not have to be defined

        Returns Promise<MultiColumnMenu>

        MultiColumnMenu object of main menu content

        -
      • Get menu content for the main menu

        +
      • Get menu content for the main menu

        Returns Promise<MultiColumnMenu>

        MultiColumnMenu object of main menu content

        -
    • getWebViewMenu:function
    • getWebViewMenu:function
      • Get menu content for a web view

        Parameters

        • webViewType: `${string}.${string}`

          The type of webview for which a menu should be retrieved

        Returns Promise<WebViewMenu>

        WebViewMenu object of web view menu content

        -
    • rebuildMenus:function
      • Rebuild the menus with the latest inputs from all extensions.

        -

        Returns Promise<void>

    • setMainMenu:function
    • rebuildMenus:function
      • Rebuild the menus with the latest inputs from all extensions.

        +

        Returns Promise<void>

    • setMainMenu:function
    • setWebViewMenu:function
    • setWebViewMenu:function
    • subscribeMainMenu:function
      • Subscribe to run a callback function when the main menu data is changed

        +
    • subscribeMainMenu:function
      • Subscribe to run a callback function when the main menu data is changed

        Parameters

        • mainMenuType: undefined

          Does not have to be defined

        • callback: ((menuContent: {
              columns: ColumnsWithHeaders;
              groups: GroupsInMultiColumnMenu;
              items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
          }) => void)

          Function to run with the updated menuContent for this selector

            • (menuContent): void
            • Parameters

              • menuContent: {
                    columns: ColumnsWithHeaders;
                    groups: GroupsInMultiColumnMenu;
                    items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
                }
                • columns: ColumnsWithHeaders

                  Columns that belong in this menu

                  @@ -24,7 +24,7 @@
                • items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[]

                  List of menu items that belong in this menu

              Returns void

        • Optionaloptions: DataProviderSubscriberOptions

          Various options to adjust how the subscriber emits updates

        Returns Promise<UnsubscriberAsync>

        Unsubscriber function (run to unsubscribe from listening for updates)

        -
    • subscribeWebViewMenu:function
      • Subscribe to run a callback function when the web view menu data is changed

        +
    • subscribeWebViewMenu:function
      • Subscribe to run a callback function when the web view menu data is changed

        Parameters

        • webViewType: `${string}.${string}`

          The type of webview for which a menu should be subscribed

        • callback: ((menuContent: {
              contextMenu: SingleColumnMenu | undefined;
              includeDefaults: boolean | undefined;
              topMenu: MultiColumnMenu | undefined;
          }) => void)

          Function to run with the updated menuContent for this selector

            • (menuContent): void
            • Parameters

              • menuContent: {
                    contextMenu: SingleColumnMenu | undefined;
                    includeDefaults: boolean | undefined;
                    topMenu: MultiColumnMenu | undefined;
                }
                • contextMenu: SingleColumnMenu | undefined

                  Menu that opens when you right click on the main body/area of a tab

                  @@ -32,4 +32,4 @@
                • topMenu: MultiColumnMenu | undefined

                  Menu that opens when you click on the top left corner of a tab

              Returns void

        • Optionaloptions: DataProviderSubscriberOptions

          Various options to adjust how the subscriber emits updates

        Returns Promise<UnsubscriberAsync>

        Unsubscriber function (run to unsubscribe from listening for updates)

        -
    +
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index 5aa3bc9f16..4565785d5d 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts
    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }
    +MenuDataDataTypes | papi-dts
    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index d2454d94b6..812fd86086 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts
    AllProjectSettingsValidators: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
    }

    Validators for all project settings. Keys are setting keys, values are functions to validate new settings

    -
    +
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index f0d1246633..4c1c9d81e8 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    +

    Returns Promise<boolean>

    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index bccf2ed2a3..17f4199670 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts
    SimultaneousProjectSettingsChanges: {
        [ProjectSettingName in ProjectSettingNames]?: {
            currentValue: ProjectSettingTypes[ProjectSettingName];
            newValue: ProjectSettingTypes[ProjectSettingName];
        }
    }

    All project settings changes being set in one batch

    Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

    -
    +
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html index bed92c9e96..87b7785307 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html @@ -2,4 +2,4 @@ that means this should be synced with the scroll group sharing that number. If this value is an object, that means it is an independent Scripture reference and should not be synced with any scroll group.

    -
    +
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html index bcb9f4b6b7..0b13fca6e2 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html @@ -1,3 +1,3 @@ ScrollGroupUpdateInfo | papi-dts
    ScrollGroupUpdateInfo: {
        scrollGroupId: ScrollGroupId;
        scrRef: ScriptureReference;
    }

    Information about an update to a scroll group. Informs about the new ScriptureReference at a ScrollGroupId

    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index a558f76f41..77c0a67ea3 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts
    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }
    +AllSettingsData | papi-dts
    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index 0f0685ad0e..c00b61a4e8 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts
    AllSettingsValidators: {
        [SettingName in SettingNames]: SettingValidator<SettingName>
    }

    Validators for all settings. Keys are setting keys, values are functions to validate new settings

    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index 31bf71661b..47d290edb4 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,30 +3,30 @@

    Returns Promise<SettingTypes[SettingName]>

    The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

    If no default value is available for the setting.

    -
  • getLocalizedSettingsContributionInfo:function
    • Get the current set of settings contribution info given all the input documents with all +

  • getLocalizedSettingsContributionInfo:function
    • Get the current set of settings contribution info given all the input documents with all localized string keys localized properly.

      Returns Promise<undefined | {
          contributions: {
              [extensionName: string]: SettingsGroup[] | undefined;
          };
          settings: Partial<AllSettingsInfo>;
      }>

      Localized project settings contribution info or undefined

      -
  • registerValidator:function
    • Registers a function that validates whether a new setting value is allowed to be set.

      +
  • registerValidator:function
    • Registers a function that validates whether a new setting value is allowed to be set.

      Type Parameters

      Parameters

      Returns Promise<UnsubscriberAsync>

      Unsubscriber that should be called whenever the providing extension is deactivated

      -
  • reset:function
  • reset:function
    • Removes the setting from memory and resets it to its default value

      Type Parameters

      Parameters

      • key: SettingName

        The string id of the setting for which the value is being removed

      Returns Promise<boolean>

      true if successfully reset the project setting. false otherwise

      -
  • set:function
  • set:function
  • subscribe:function
    • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the +

  • subscribe:function
    • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the callback function is executed.

      Type Parameters

      Parameters

      Returns Promise<UnsubscriberAsync>

      Unsubscriber that should be called whenever the subscription should be deleted

      -
  • validateSetting:function
    • Validates the setting at the given key with the new value provided

      +
  • validateSetting:function
  • +
  • OptionalallChanges: Partial<SettingTypes>
  • Returns Promise<boolean>

    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 8670c59a06..a81ad61ed8 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -10,4 +10,4 @@
    '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
     
    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index dae6cbfad2..819e96012a 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts
    SettingValidator<SettingName>: ((newValue: SettingTypes[SettingName], currentValue: SettingTypes[SettingName], allChanges: Partial<SettingTypes>) => Promise<boolean>)

    Function that validates whether a new setting value should be allowed to be set

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html index b0cfb58b6c..497b6837f8 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html @@ -1,2 +1,2 @@ CloseWebViewEvent | papi-dts
    CloseWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are closed

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html index 9500406256..1b0ac2be12 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html @@ -1,2 +1,2 @@ OpenWebViewEvent | papi-dts
    OpenWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html index dcd57f38a1..769ec68ea9 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html @@ -1,2 +1,2 @@ UpdateWebViewEvent | papi-dts
    UpdateWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are updated

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html index c5cf6fcf52..d62c3cb880 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html @@ -1,4 +1,4 @@ WebViewMessageRequestHandler | papi-dts
    WebViewMessageRequestHandler: ((webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type of function to receive messages sent to a web view.

    See web-view-provider.service.ts's postMessageToWebView and web-view.component for information on this type

    -
    +
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html index 02e4a39a1c..80694b52a2 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html @@ -1,2 +1,2 @@ AllProjectSettingsInfo | papi-dts
    AllProjectSettingsInfo: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingInfo<ProjectSettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -
    +
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html index d63325082a..1ff20d629f 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedProjectSettingsContributionInfo | papi-dts
    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>
    +LocalizedProjectSettingsContributionInfo | papi-dts
    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html index 9d85168e07..2a770bb308 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html @@ -1,3 +1,3 @@ ProjectSettingInfo | papi-dts
    ProjectSettingInfo<ProjectSettingName>: ProjectSetting & {
        default: ProjectSettingTypes[ProjectSettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html index 9cac93c639..060aff9c1e 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html @@ -1,4 +1,4 @@ ProjectSettingsContributionInfo | papi-dts
    ProjectSettingsContributionInfo: {
        contributions: {
            [extensionName: string]: ProjectSettingsGroup[] | undefined;
        };
        settings: Partial<AllProjectSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: ProjectSettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: ProjectSettingsGroup[] | undefined
    • settings: Partial<AllProjectSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -
    +
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html index ceb895e449..4c28e2d907 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html @@ -1,2 +1,2 @@ AllSettingsInfo | papi-dts
    AllSettingsInfo: {
        [SettingName in SettingNames]: SettingInfo<SettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -
    +
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html index e3cd448474..25de0bd34c 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedSettingsContributionInfo | papi-dts
    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>
    +LocalizedSettingsContributionInfo | papi-dts
    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html index a5f8a50781..7e3f2f889f 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html @@ -1,3 +1,3 @@ SettingInfo | papi-dts
    SettingInfo<SettingName>: Setting & {
        default: SettingTypes[SettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html index 5e51786afc..900c64819f 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html @@ -1,4 +1,4 @@ SettingsContributionInfo | papi-dts
    SettingsContributionInfo: {
        contributions: {
            [extensionName: string]: SettingsGroup[] | undefined;
        };
        settings: Partial<AllSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: SettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: SettingsGroup[] | undefined
    • settings: Partial<AllSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -
    +
    diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index a4a3f2d086..fbb013a51a 100644 --- a/papi-dts/types/_shared_utils_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts
    RequestType: {
        category: string;
        directive: string;
    }

    Information about a request that tells us what to do with it

    Type declaration

    • category: string

      The general category of request

    • directive: string

      Specific identifier for this type of request

      -
    +
    diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 05e4cb33bd..32011e7ae3 100644 --- a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

    Type AliasSerializedRequestType

    SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

    String version of a request type that tells us what to do with a request.

    Consists of two strings concatenated by a colon

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index a246d79402..e55d4824d0 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    IBaseProjectDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index eca12b3997..406e0c5ca9 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    IDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 195cb3bb07..daf7d8ec3d 100644 --- a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 52a86046e6..9b911d1296 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    IProjectDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.WebViewFactory.html b/papi-dts/variables/__papi_backend_.WebViewFactory.html index 1cfbfcb7c6..cc29b3b5bc 100644 --- a/papi-dts/variables/__papi_backend_.WebViewFactory.html +++ b/papi-dts/variables/__papi_backend_.WebViewFactory.html @@ -13,4 +13,4 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    IWebViewProvider for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index 1513818517..99f72f23d0 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index e80327cc40..294398f8e8 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index fb0683f427..da8eed6964 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -89,4 +89,4 @@
  • webViews: WebViewServiceType

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
  • +
    diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 85237cea86..bf0e533e23 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 4f97ea8c99..b2bf2bc59a 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 24576cd839..0afba53baa 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index b2ceb5debb..60291827f3 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index eb3b268d94..97cb4231d1 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    Service that allows to get and store menu data

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 93157d8085..db702c3a53 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index 5f62d14e90..3357b0d390 100644 --- a/papi-dts/variables/__papi_backend_.networkObjectStatus.html +++ b/papi-dts/variables/__papi_backend_.networkObjectStatus.html @@ -1,2 +1,2 @@ networkObjectStatus | papi-dts

    VariablenetworkObjectStatusConst

    networkObjectStatus: NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index 9ec5b7eede..74d34c526f 100644 --- a/papi-dts/variables/__papi_backend_.networkObjects.html +++ b/papi-dts/variables/__papi_backend_.networkObjects.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 4903ce4dbd..1f14ca0b54 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index c45771abf6..110f3ee688 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index 37993b9ff3..bf1be83f54 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

    VariableprojectSettingsConst

    projectSettings: IProjectSettingsService

    Provides utility functions that project data providers should call when handling project settings

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.scrollGroups.html b/papi-dts/variables/__papi_backend_.scrollGroups.html index 5c3da31f78..4c6e9e8e77 100644 --- a/papi-dts/variables/__papi_backend_.scrollGroups.html +++ b/papi-dts/variables/__papi_backend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index 5dfedaf068..f49c0daaf1 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts
    +settings | papi-dts
    diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index dc50c697ac..75d88875f3 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

    VariablestorageConst

    This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index f8d2b7654e..eedd2df484 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,3 +1,3 @@ webViewProviders | papi-dts

    VariablewebViewProvidersConst

    webViewProviders: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 90d198755f..20a4cd955c 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    +
    diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 0b7dece472..6e8302256e 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    VariabledefaultConst

    default: {}

    Exporting empty object so people don't have to put 'type' in their import statements

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index d1c769e433..11558600ff 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

    Note that the Node WebSocket implementation is different and not wrapped here.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index 75af50dbfd..a9bbbb0947 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

    Note that Node doesn't have a native implementation, so this is only for the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 5425a04d37..b44997e282 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index 2c8b09a9fa..68bb5219ec 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 775c07143f..8ec1aedefa 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -27,4 +27,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

    Note that Node doesn't have a native implementation, so this is only for the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index b1085554ac..a5958ef07c 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 3be445b8d7..f34e9e1051 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index 2f37ef61ae..76468a2caa 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index d5dad5b938..a79c2a2bfe 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index a2addbda64..42b3914b31 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    Service that allows to get and store menu data

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 8e83b4783a..311b00714a 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 7994ccc8d3..dadb5d71c9 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 2cd29dc47b..e1a5eb404a 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 2ce0dd3dfa..39aad5762c 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

    React hooks that enable interacting with the papi in React components more easily.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.scrollGroups.html b/papi-dts/variables/__papi_frontend_.scrollGroups.html index 70a44ba60a..f326f0b44d 100644 --- a/papi-dts/variables/__papi_frontend_.scrollGroups.html +++ b/papi-dts/variables/__papi_frontend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index a9f4633f5b..a5a12993d0 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts
    +settings | papi-dts
    diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index b53b62cc58..149a8f5d9a 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    +
    diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index 85dd46032a..db278bc3bd 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

    This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

    -
    +
    diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index 54835ca16b..b4a516e0c9 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts
    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }
    +default | papi-dts
    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }
    diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index 5b8001c017..77aa6792fa 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'
    +FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'
    diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index c7ebc46747..3028d15a8b 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'
    +RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index 217e8acb26..f5ed09a7db 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html index 15c7ae2327..d66e9ebbf2 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_BOOKS_DIALOG_TYPE | papi-dts
    SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

    The tabType for the select books dialog in select-books.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 078bb8691e..5e0ab1be32 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts
    SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

    The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 43414cbd33..54929a43a4 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts
    SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

    The tabType for the select project dialog in select-project.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html index 15c394c397..b659f0a483 100644 --- a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html +++ b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html @@ -1,4 +1,4 @@ availableScrollGroupIds | papi-dts
    availableScrollGroupIds: (number | undefined)[]

    All Scroll Group IDs that are intended to be shown in scroll group selectors. This is a placeholder and will be refactored significantly in https://github.com/paranext/paranext-core/issues/788

    -
    +
    diff --git a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html index d22d463f5e..4246aef7a4 100644 --- a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html +++ b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html @@ -1,2 +1,2 @@ DEV_MODE_RENDERER_INDICATOR | papi-dts
    DEV_MODE_RENDERER_INDICATOR: "?noisyDevMode" = '?noisyDevMode'

    Query string passed to the renderer when starting if it should enable noisy dev mode

    -
    +
    diff --git a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html index 6641bc00b3..548778186f 100644 --- a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html +++ b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html @@ -1,3 +1,3 @@ PLATFORM_NAMESPACE | papi-dts
    PLATFORM_NAMESPACE: "platform" = 'platform'

    Namespace to use for features like commands, settings, etc. on the PAPI that are provided by Platform.Bible core

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html index 5dceaeff5e..ca978e5d00 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts
    CATEGORY_COMMAND: "command" = 'command'

    Prefix on requests that indicates that the request is a command

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html index 595eefbb46..e5250ac791 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html +++ b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html @@ -1,2 +1,2 @@ GET_METHODS | papi-dts
    GET_METHODS: "network:getMethods" = 'network:getMethods'

    Get all methods that are currently registered on the network.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html index 754e1104b0..280a92e768 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html @@ -1,3 +1,3 @@ REGISTER_METHOD | papi-dts
    REGISTER_METHOD: "network:registerMethod" = 'network:registerMethod'

    Register a method on the network so that requests of the given type are routed to your request handler.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html index dab0460b1a..d17df0d773 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html @@ -1,3 +1,3 @@ UNREGISTER_METHOD | papi-dts
    UNREGISTER_METHOD: "network:unregisterMethod" = 'network:unregisterMethod'

    Unregister a method on the network so that requests of the given type are no longer routed to your request handler.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html index 976a527756..b6e13d5e01 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts
    WEBSOCKET_PORT = 8876

    Port to use for the WebSocket

    -
    +
    diff --git a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html index cf7509ff72..0751c397fe 100644 --- a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html @@ -1,2 +1,2 @@ DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS | papi-dts
    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

    Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

    -
    +
    diff --git a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 4c5220b40f..0acb0fbc5b 100644 --- a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts
    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
    +networkObjectStatusServiceNetworkObjectName | papi-dts
    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html index 53474f8213..3c1f3398b6 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html @@ -1 +1 @@ -PDP_FACTORY_OBJECT_TYPE | papi-dts
    PDP_FACTORY_OBJECT_TYPE: string
    +PDP_FACTORY_OBJECT_TYPE | papi-dts
    PDP_FACTORY_OBJECT_TYPE: string
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html index 86171a23d1..0d0db35bc6 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html @@ -1,3 +1,3 @@ PROJECT_INTERFACE_PLATFORM_BASE | papi-dts
    PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

    The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

    -
    +
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html index 5bcb955f21..3e6d109246 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
    +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html index 9966739fda..e31b140586 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html @@ -1,2 +1,2 @@ projectLookupServiceBase | papi-dts
    projectLookupServiceBase: ProjectLookupServiceType

    Local object of functions to run locally on each process as part of the project lookup service

    -
    +
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html index 1b5f134791..01cca60750 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html @@ -1,2 +1,2 @@ testingProjectLookupService | papi-dts
    testingProjectLookupService: {
        compareProjectDataProviderFactoryMetadataInfoMinimalMatch: typeof compareProjectDataProviderFactoryMetadataInfoMinimalMatch;
        internalGetMetadata: typeof internalGetMetadata;
        transformGetMetadataForProjectParametersToFilter: typeof transformGetMetadataForProjectParametersToFilter;
    }

    This is an internal-only export for testing purposes and should not be used in development

    -
    +
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html index 0dbc220f69..68c1e86d61 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html @@ -1,3 +1,3 @@ SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS | papi-dts

    VariableSAVED_WEBVIEW_DEFINITION_OMITTED_KEYSConst

    SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS: readonly ["content", "styles", "allowScripts", "allowSameOrigin", "allowedFrameSources", "allowPopups"]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -
    +
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html index abdc3b12d4..d6591ea8a2 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html @@ -1,3 +1,3 @@ WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS | papi-dts

    VariableWEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYSConst

    WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS: readonly ["iconUrl", "title", "tooltip", "projectId", "scrollGroupScrRef"]

    The keys of properties on a WebViewDefinition that may be updated when that webview is already displayed

    -
    +
    diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 681018ad8c..8c3aadcffe 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 26672c4c8e..ebcc966342 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index 7671477e54..a1cb290cc3 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts
    CATEGORY_DIALOG: "dialog" = 'dialog'

    Prefix on requests that indicates that the request is related to dialog operations

    -
    +
    diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 241774c979..d56c414fc2 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index 0ed7bd4b2e..54fb4299fa 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index 77c9e2e873..30d8a42372 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts
    localizationServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.localizationDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.localizationDataServiceDataProvider"

      This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -
    +
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index 81cc84b571..e0ddb656d7 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts
    localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

    This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index f9e5e274f3..07ebb36dab 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts
    WARN_TAG: "<WARN>" = '<WARN>'
    +WARN_TAG | papi-dts
    WARN_TAG: "<WARN>" = '<WARN>'
    diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 6651b65081..010b9dd549 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts
    default: log.MainLogger & {
        default: log.MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 779c448f66..f31abb0bd7 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index 1d327a95b4..3775f194b3 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts
    menuDataServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.menuDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.menuDataServiceDataProvider"

      This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -
    +
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index 022f450130..37b0a752fc 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts
    menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

    This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index dba441412d..6c1be9fccd 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html index 9a0d2c310a..02b6ca0540 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html +++ b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 102f5123eb..bc9d98508f 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Provides functions related to the set of available network objects

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 35c75756d6..1579b81d47 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts
    papiNetworkService: PapiNetworkService

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index b31ed7515f..49d35f0ac2 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts
    papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index cea9a1609e..a816b5ec05 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts
    papiFrontendProjectDataProviderService: {
        get: typeof get;
    }

    Service that gets project data providers

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index cf45f68b31..e02333036d 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index 89792141e5..30e2546ce4 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index 2ebea59890..f49b69e46b 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts
    CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

    Name prefix for registered commands that call project settings validators

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index 2536107616..45eeeff39b 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts
    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
    +projectSettingsServiceNetworkObjectName | papi-dts
    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index f35811620b..5f5782104b 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -2,4 +2,4 @@
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_.default.html b/papi-dts/variables/_shared_services_scroll_group_service_.default.html index 2d051ab71c..0fced8068a 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_.default.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html index 6a0a002554..55cf9eb1ce 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_SCR_REF | papi-dts
    EVENT_NAME_ON_DID_UPDATE_SCR_REF: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html index be8038f81e..ae64ea5855 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'
    +NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'
    diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index cf9d2b08f2..1ac6249a37 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index fc157a3325..05f8113beb 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts
    CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

    Name prefix for registered commands that call settings validators

    -
    +
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index 9695fca98c..43e73ab70c 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts
    settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

    This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index 12632991bb..a86616e9ee 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index 9e75470d9c..117609b81c 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index 6c647df9d8..e305291f17 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,3 +1,3 @@ papiWebViewProviderService | papi-dts
    papiWebViewProviderService: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index d907649583..e7b8dbd549 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index 8901a60478..584f530d89 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

    13 November 2024. Renamed to EVENT_NAME_ON_DID_OPEN_WEB_VIEW

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html index 5d9897b2c5..689a07d15b 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_CLOSE_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_CLOSE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are closed

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html index d220b37072..1a035538de 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_OPEN_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_OPEN_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are created

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html index f17104265b..dba9cb397c 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_UPDATE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 12036d573c..49d800b467 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
    +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html index 31f00c89fd..affd834258 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html @@ -1,2 +1,2 @@ WEB_VIEW_CONTROLLER_OBJECT_TYPE | papi-dts
    WEB_VIEW_CONTROLLER_OBJECT_TYPE: "webViewController" = 'webViewController'

    Network object type for web view controllers

    -
    +
    diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index 30716a7d0b..344e42a01a 100644 --- a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

    VariableMODULE_SIMILAR_APISConst

    MODULE_SIMILAR_APIS: Readonly<{
        [moduleName: string]: string | {
            [process in ProcessType | "default"]?: string
        } | undefined;
    }>

    Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

    -
    +
    diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index 4a63e1bab9..265d4d8517 100644 --- a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

    VariableREQUEST_TYPE_SEPARATORConst

    REQUEST_TYPE_SEPARATOR: ":" = ':'

    Separator between parts of a serialized request

    -
    +
    diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index 2e75510949..1e26e50001 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

    VariableisNoisyDevModeEnabled

    isNoisyDevModeEnabled: boolean

    Indicates whether test code meant just for developers to see should be run

    -
    +
    diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 896bb8d2f6..dfbd45008e 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

    VariableisPackaged

    isPackaged: boolean

    Whether this process is packaged or running from sources

    -
    +
    diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 58f9191858..8286fcb414 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

    VariablelogLevel

    logLevel: LogLevel

    How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

    -
    +
    diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 0c4dd9213f..858f7f03a1 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

    VariableprocessType

    processType: ProcessType

    Type of process this is. Helps with running specific code based on which process you're in

    -
    +
    diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index a208d1bdd5..926af7d568 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

    VariableresourcesPath

    resourcesPath: string

    Path to the app's resources directory. This is a string representation of the resources uri on frontend

    -
    +
    diff --git a/papi-dts/variables/webViewId.html b/papi-dts/variables/webViewId.html index 8b614d1162..e339ff6c0d 100644 --- a/papi-dts/variables/webViewId.html +++ b/papi-dts/variables/webViewId.html @@ -1,2 +1,2 @@ webViewId | papi-dts

    VariablewebViewId

    webViewId: WebViewId

    The id of the current web view. Only used in WebView iframes.

    -
    +
    diff --git a/platform-bible-react/enums/BookSelectionMode.html b/platform-bible-react/enums/BookSelectionMode.html index b3cd34810f..d740ff258d 100644 --- a/platform-bible-react/enums/BookSelectionMode.html +++ b/platform-bible-react/enums/BookSelectionMode.html @@ -1,3 +1,3 @@ -BookSelectionMode | platform-bible-react

    EnumerationBookSelectionMode

    Enumeration Members

    CHOOSE_BOOKS +BookSelectionMode | platform-bible-react
    +

    Enumeration Members

    CHOOSE_BOOKS
    CURRENT_BOOK
    diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index 1353ba978f..be3326573f 100644 --- a/platform-bible-react/enums/DropdownMenuItemType.html +++ b/platform-bible-react/enums/DropdownMenuItemType.html @@ -1,3 +1,3 @@ -DropdownMenuItemType | platform-bible-react

    EnumerationDropdownMenuItemType

    Enumeration Members

    Check +DropdownMenuItemType | platform-bible-react
    +

    Enumeration Members

    Check
    Radio
    diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index f377f7fe36..e2090389b1 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react
    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof +Alert | platform-bible-react
    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertDescription.html b/platform-bible-react/functions/AlertDescription.html index 7ed598acfb..ea83161870 100644 --- a/platform-bible-react/functions/AlertDescription.html +++ b/platform-bible-react/functions/AlertDescription.html @@ -1,4 +1,4 @@ -AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof +AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertTitle.html b/platform-bible-react/functions/AlertTitle.html index 995c7844f4..9ca809b729 100644 --- a/platform-bible-react/functions/AlertTitle.html +++ b/platform-bible-react/functions/AlertTitle.html @@ -1,4 +1,4 @@ -AlertTitle | platform-bible-react

    Properties

    $$typeof +AlertTitle | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index d5c360245c..b5107713c4 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    +BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    diff --git a/platform-bible-react/functions/BookSelector.html b/platform-bible-react/functions/BookSelector.html index abf00e3abe..5fdf23c302 100644 --- a/platform-bible-react/functions/BookSelector.html +++ b/platform-bible-react/functions/BookSelector.html @@ -1 +1 @@ -BookSelector | platform-bible-react
    +BookSelector | platform-bible-react
    diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 0cc0f5e80d..1f59410eb8 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

    Properties

    $$typeof +Button | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Card.html b/platform-bible-react/functions/Card.html index 4894273847..8d21e3d0e4 100644 --- a/platform-bible-react/functions/Card.html +++ b/platform-bible-react/functions/Card.html @@ -1,4 +1,4 @@ -Card | platform-bible-react

    Properties

    $$typeof +Card | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardContent.html b/platform-bible-react/functions/CardContent.html index 6ebfa382cb..5fb013c562 100644 --- a/platform-bible-react/functions/CardContent.html +++ b/platform-bible-react/functions/CardContent.html @@ -1,4 +1,4 @@ -CardContent | platform-bible-react

    Properties

    $$typeof +CardContent | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardDescription.html b/platform-bible-react/functions/CardDescription.html index 8ca4a0113e..cb0b252dca 100644 --- a/platform-bible-react/functions/CardDescription.html +++ b/platform-bible-react/functions/CardDescription.html @@ -1,4 +1,4 @@ -CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof +CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardFooter.html b/platform-bible-react/functions/CardFooter.html index 6324d319b2..dc8e3b9653 100644 --- a/platform-bible-react/functions/CardFooter.html +++ b/platform-bible-react/functions/CardFooter.html @@ -1,4 +1,4 @@ -CardFooter | platform-bible-react

    Properties

    $$typeof +CardFooter | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardHeader.html b/platform-bible-react/functions/CardHeader.html index d5890beff1..783e6861f8 100644 --- a/platform-bible-react/functions/CardHeader.html +++ b/platform-bible-react/functions/CardHeader.html @@ -1,4 +1,4 @@ -CardHeader | platform-bible-react

    Properties

    $$typeof +CardHeader | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardTitle.html b/platform-bible-react/functions/CardTitle.html index 5c9f68da82..2b1140d2a2 100644 --- a/platform-bible-react/functions/CardTitle.html +++ b/platform-bible-react/functions/CardTitle.html @@ -1,4 +1,4 @@ -CardTitle | platform-bible-react

    Properties

    $$typeof +CardTitle | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 1aa138313c..5cd9575ef8 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    +ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index a05722ab27..c7d6425dab 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,4 +1,4 @@ -Checkbox | platform-bible-react

    Properties

    $$typeof +Checkbox | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index 8f2343871b..7fb3216d40 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,2 +1,2 @@ Checklist | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 52544d455e..520e883172 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react
    +

    Type Parameters

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index 68b7bf871e..787b414d13 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1,3 +1,3 @@ DataTable | platform-bible-react
    +

    Type Parameters

    • TData
    • TValue

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index 989a9a8c5d..d7703f49a4 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

    FunctionDisableButton

    +
    diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index ad88a28ed8..232e1bf82d 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,5 +1,5 @@ DropdownMenu | platform-bible-react

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index 5ac9ab0648..d740465d3c 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof +DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index f0a75cd831..2be6134b63 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof +DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index 3aa42bc11b..5ec9a10df6 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof +DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index a278cfbbf1..d3771a2868 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,6 @@ DropdownMenuItem | platform-bible-react

    FunctionDropdownMenuItem

    TODO: fix: direction is not automatically handled by this component, so that shortcuts are display always to the right

    -

    Properties

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index 28208839be..27e35099ee 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof +DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index 8972baea6e..d2f46919e1 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,5 +1,5 @@ DropdownMenuPortal | platform-bible-react

    FunctionDropdownMenuPortal

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index 2992d7ce96..43c78f8a67 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof +DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index b54d23a9d4..dd4349812c 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof +DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index 783a15cfdf..e75989fff1 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof +DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index 92b45cc3ed..84b44695c8 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    Properties

    displayName: string
    +DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    Properties

    displayName: string
    diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index 79f81f49db..c86c7c4770 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,5 +1,5 @@ DropdownMenuSub | platform-bible-react

    FunctionDropdownMenuSub

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index 2b7a163415..d83675c8e2 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof +DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index 29b937c668..ed24f9216a 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof +DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index e19713a0df..60375f0e45 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof +DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/EnableButton.html b/platform-bible-react/functions/EnableButton.html index 37bfd80443..d6e8d35dd0 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index 65848091bc..b40d6403ce 100644 --- a/platform-bible-react/functions/FilterButton.html +++ b/platform-bible-react/functions/FilterButton.html @@ -2,7 +2,7 @@ to be used with the dropdown menu. It uses forwardRef to pass the button to the dropdown trigger asChild.

    Properties

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index 940ef10ae0..8ea5a57bc6 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

    FunctionFilterDropdown

    +
    diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index 55590d70e1..e81f03d103 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index a500b1087a..122cd5aab7 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react
    +GridMenu | platform-bible-react
    diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 852a18ad8f..324083c7e3 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    +HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 2ced6d0f70..bcc39b55e0 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 6f83d82488..1efe79cb43 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

    Properties

    $$typeof +Input | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/InstallButton.html b/platform-bible-react/functions/InstallButton.html index 251bbabf0c..608301ad6a 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

    FunctionInstallButton

    +
    diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index 857a28a719..b29434fce1 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1,2 +1,2 @@ Inventory | platform-bible-react
    +

    Parameters

    • __namedParameters: InventoryProps

    Returns Element

    diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index a2964019fa..9fdb1c133c 100644 --- a/platform-bible-react/functions/Label.html +++ b/platform-bible-react/functions/Label.html @@ -1,4 +1,4 @@ -Label | platform-bible-react

    Properties

    $$typeof +Label | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MarkdownRenderer.html b/platform-bible-react/functions/MarkdownRenderer.html index 384f79d73d..59d33e3009 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

    FunctionMarkdownRenderer

    +
    diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index f843e62134..9600875d19 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react
    +MenuItem | platform-bible-react
    diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index 7f615d0505..18fc74ef20 100644 --- a/platform-bible-react/functions/MoreInfo.html +++ b/platform-bible-react/functions/MoreInfo.html @@ -4,4 +4,4 @@
  • Returns the more info component that displays the category, number of downloads, languages, and links to the website and support
  • -
    +
    diff --git a/platform-bible-react/functions/NavigationContentSearch.html b/platform-bible-react/functions/NavigationContentSearch.html index 9a91189b18..08a5991bf5 100644 --- a/platform-bible-react/functions/NavigationContentSearch.html +++ b/platform-bible-react/functions/NavigationContentSearch.html @@ -1 +1 @@ -NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    +NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index 56c1ab5e4f..ee6fdaf484 100644 --- a/platform-bible-react/functions/NoExtensionsFound.html +++ b/platform-bible-react/functions/NoExtensionsFound.html @@ -2,4 +2,4 @@

    Parameters

    • __namedParameters: NoExtensionsFoundProps

    Returns Element

    • Returns the message component that displays the message to the user.
    -
    +
    diff --git a/platform-bible-react/functions/RadioGroup.html b/platform-bible-react/functions/RadioGroup.html index dd1168a5df..5c6e0d8933 100644 --- a/platform-bible-react/functions/RadioGroup.html +++ b/platform-bible-react/functions/RadioGroup.html @@ -1,4 +1,4 @@ -RadioGroup | platform-bible-react

    Properties

    $$typeof +RadioGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/RadioGroupItem.html b/platform-bible-react/functions/RadioGroupItem.html index a70fb7cac4..25c95a6e74 100644 --- a/platform-bible-react/functions/RadioGroupItem.html +++ b/platform-bible-react/functions/RadioGroupItem.html @@ -1,4 +1,4 @@ -RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof +RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ScriptureResultsViewer.html b/platform-bible-react/functions/ScriptureResultsViewer.html index 8ca01a801e..b843d0c5ce 100644 --- a/platform-bible-react/functions/ScriptureResultsViewer.html +++ b/platform-bible-react/functions/ScriptureResultsViewer.html @@ -5,4 +5,4 @@ displays somewhat "tree-like" which allows it to be more horizontally compact and intuitive. But it also has the option of displaying as a traditional table with column headings (with or without the source column showing).

    -

    Parameters

    Returns Element

    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ScrollGroupSelector.html b/platform-bible-react/functions/ScrollGroupSelector.html index 20bd49cd44..143a631bf3 100644 --- a/platform-bible-react/functions/ScrollGroupSelector.html +++ b/platform-bible-react/functions/ScrollGroupSelector.html @@ -1,2 +1,2 @@ ScrollGroupSelector | platform-bible-react

    FunctionScrollGroupSelector

    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index a9a2b9e990..93deb71526 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react
    +SearchBar | platform-bible-react
    diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index 26291c9762..05b534fdce 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,5 +1,5 @@ Select | platform-bible-react

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index d3c7767be9..bef38d14b2 100644 --- a/platform-bible-react/functions/SelectContent.html +++ b/platform-bible-react/functions/SelectContent.html @@ -1,4 +1,4 @@ -SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof +SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectGroup.html b/platform-bible-react/functions/SelectGroup.html index b11eee5daa..9f60d57403 100644 --- a/platform-bible-react/functions/SelectGroup.html +++ b/platform-bible-react/functions/SelectGroup.html @@ -1,4 +1,4 @@ -SelectGroup | platform-bible-react

    Properties

    $$typeof +SelectGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectItem.html b/platform-bible-react/functions/SelectItem.html index 094fb3d452..8f9d08efe2 100644 --- a/platform-bible-react/functions/SelectItem.html +++ b/platform-bible-react/functions/SelectItem.html @@ -1,4 +1,4 @@ -SelectItem | platform-bible-react

    Properties

    $$typeof +SelectItem | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectLabel.html b/platform-bible-react/functions/SelectLabel.html index e253957575..b15338ed4b 100644 --- a/platform-bible-react/functions/SelectLabel.html +++ b/platform-bible-react/functions/SelectLabel.html @@ -1,4 +1,4 @@ -SelectLabel | platform-bible-react

    Properties

    $$typeof +SelectLabel | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollDownButton.html b/platform-bible-react/functions/SelectScrollDownButton.html index b514f392da..e099b6d2ad 100644 --- a/platform-bible-react/functions/SelectScrollDownButton.html +++ b/platform-bible-react/functions/SelectScrollDownButton.html @@ -1,4 +1,4 @@ -SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof +SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollUpButton.html b/platform-bible-react/functions/SelectScrollUpButton.html index 9d27e848c2..4d76e6c670 100644 --- a/platform-bible-react/functions/SelectScrollUpButton.html +++ b/platform-bible-react/functions/SelectScrollUpButton.html @@ -1,4 +1,4 @@ -SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof +SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectSeparator.html b/platform-bible-react/functions/SelectSeparator.html index 411ae8cb89..af8aeddd1b 100644 --- a/platform-bible-react/functions/SelectSeparator.html +++ b/platform-bible-react/functions/SelectSeparator.html @@ -1,4 +1,4 @@ -SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof +SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectTrigger.html b/platform-bible-react/functions/SelectTrigger.html index 0c11806bf8..a444caed56 100644 --- a/platform-bible-react/functions/SelectTrigger.html +++ b/platform-bible-react/functions/SelectTrigger.html @@ -1,4 +1,4 @@ -SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof +SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectValue.html b/platform-bible-react/functions/SelectValue.html index d9f0af2e1f..f154808a0e 100644 --- a/platform-bible-react/functions/SelectValue.html +++ b/platform-bible-react/functions/SelectValue.html @@ -1,4 +1,4 @@ -SelectValue | platform-bible-react

    Properties

    $$typeof +SelectValue | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Separator.html b/platform-bible-react/functions/Separator.html index 5d747600d8..e8122bcc8a 100644 --- a/platform-bible-react/functions/Separator.html +++ b/platform-bible-react/functions/Separator.html @@ -1,4 +1,4 @@ -Separator | platform-bible-react

    Properties

    $$typeof +Separator | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SettingsList.html b/platform-bible-react/functions/SettingsList.html index 1b3c8b73f1..7f560cef0c 100644 --- a/platform-bible-react/functions/SettingsList.html +++ b/platform-bible-react/functions/SettingsList.html @@ -1,4 +1,4 @@ SettingsList | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/SettingsListHeader.html b/platform-bible-react/functions/SettingsListHeader.html index 70efbaa5a4..5b73ac02fe 100644 --- a/platform-bible-react/functions/SettingsListHeader.html +++ b/platform-bible-react/functions/SettingsListHeader.html @@ -1,3 +1,3 @@ SettingsListHeader | platform-bible-react

    FunctionSettingsListHeader

    +
    diff --git a/platform-bible-react/functions/SettingsListItem.html b/platform-bible-react/functions/SettingsListItem.html index a459f78e0d..deb5a3fdd9 100644 --- a/platform-bible-react/functions/SettingsListItem.html +++ b/platform-bible-react/functions/SettingsListItem.html @@ -1,3 +1,3 @@ SettingsListItem | platform-bible-react

    FunctionSettingsListItem

    +
    diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index f5ea10523c..11a496c01b 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ -Slider | platform-bible-react

    Properties

    $$typeof +Slider | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Sonner-1.html b/platform-bible-react/functions/Sonner-1.html index 5434de6c05..b95db1af6c 100644 --- a/platform-bible-react/functions/Sonner-1.html +++ b/platform-bible-react/functions/Sonner-1.html @@ -1 +1 @@ -Sonner | platform-bible-react
    +Sonner | platform-bible-react
    diff --git a/platform-bible-react/functions/Spinner.html b/platform-bible-react/functions/Spinner.html index 562c24c048..367b2d40d6 100644 --- a/platform-bible-react/functions/Spinner.html +++ b/platform-bible-react/functions/Spinner.html @@ -1,4 +1,4 @@ -Spinner | platform-bible-react

    Properties

    $$typeof +Spinner | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 4a20ed8537..dcf7da0155 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ -Switch | platform-bible-react

    Properties

    $$typeof +Switch | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index bccd922a61..75547bd2bf 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ -Table | platform-bible-react

    Properties

    $$typeof +Table | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableBody.html b/platform-bible-react/functions/TableBody.html index 0c3b4f53ae..272e719498 100644 --- a/platform-bible-react/functions/TableBody.html +++ b/platform-bible-react/functions/TableBody.html @@ -1,4 +1,4 @@ -TableBody | platform-bible-react

    Properties

    $$typeof +TableBody | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCaption.html b/platform-bible-react/functions/TableCaption.html index 6aa8bbf7fe..ab0d4989cd 100644 --- a/platform-bible-react/functions/TableCaption.html +++ b/platform-bible-react/functions/TableCaption.html @@ -1,4 +1,4 @@ -TableCaption | platform-bible-react

    Properties

    $$typeof +TableCaption | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCell.html b/platform-bible-react/functions/TableCell.html index 3fbaeaed2c..c031ba355f 100644 --- a/platform-bible-react/functions/TableCell.html +++ b/platform-bible-react/functions/TableCell.html @@ -1,4 +1,4 @@ -TableCell | platform-bible-react

    Properties

    $$typeof +TableCell | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableFooter.html b/platform-bible-react/functions/TableFooter.html index 4a7ed5171e..4082f7d85d 100644 --- a/platform-bible-react/functions/TableFooter.html +++ b/platform-bible-react/functions/TableFooter.html @@ -1,4 +1,4 @@ -TableFooter | platform-bible-react

    Properties

    $$typeof +TableFooter | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHead.html b/platform-bible-react/functions/TableHead.html index c5efec5703..6ad407b454 100644 --- a/platform-bible-react/functions/TableHead.html +++ b/platform-bible-react/functions/TableHead.html @@ -1,4 +1,4 @@ -TableHead | platform-bible-react

    Properties

    $$typeof +TableHead | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHeader.html b/platform-bible-react/functions/TableHeader.html index 453e3d484a..4c54e0466f 100644 --- a/platform-bible-react/functions/TableHeader.html +++ b/platform-bible-react/functions/TableHeader.html @@ -1,4 +1,4 @@ -TableHeader | platform-bible-react

    Properties

    $$typeof +TableHeader | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableRow.html b/platform-bible-react/functions/TableRow.html index 6d81c9bb05..413883a3f8 100644 --- a/platform-bible-react/functions/TableRow.html +++ b/platform-bible-react/functions/TableRow.html @@ -1,4 +1,4 @@ -TableRow | platform-bible-react

    Properties

    $$typeof +TableRow | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index eb280e2b18..85f0f65d8d 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

    Properties

    $$typeof +Tabs | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index 260f429754..c37995e1b4 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

    Properties

    $$typeof +TabsContent | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index 2975184dd1..fee55a95ac 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

    Properties

    $$typeof +TabsList | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index 4d4d54fccf..ffcaf011a1 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

    Properties

    $$typeof +TabsTrigger | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index c7c96a5a35..18707565f0 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ToggleGroup.html b/platform-bible-react/functions/ToggleGroup.html index 69d4e62590..cf5e9fea36 100644 --- a/platform-bible-react/functions/ToggleGroup.html +++ b/platform-bible-react/functions/ToggleGroup.html @@ -1,4 +1,4 @@ -ToggleGroup | platform-bible-react

    Properties

    $$typeof +ToggleGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ToggleGroupItem.html b/platform-bible-react/functions/ToggleGroupItem.html index d3730b78db..fee1b414f6 100644 --- a/platform-bible-react/functions/ToggleGroupItem.html +++ b/platform-bible-react/functions/ToggleGroupItem.html @@ -1,4 +1,4 @@ -ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof +ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index cc438637b5..2be9b7c543 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react
    +Toolbar | platform-bible-react
    diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index f35c1ac6de..6e83c12c1d 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index ae7157c7ab..1335875e71 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

    FunctionVersionHistory

    +
    diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index f8b0799b93..89b4d877f9 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

    Properties

    $$typeof +VerticalTabs | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index 2cb12136f0..39fab9388e 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof +VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 409b76a884..8d6f5a4d1e 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof +VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index 4476269ce8..18fe87539b 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof +VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index fc08e28b12..44791d5ee3 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    +buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    diff --git a/platform-bible-react/functions/cn.html b/platform-bible-react/functions/cn.html index 90659c487f..6b14a89307 100644 --- a/platform-bible-react/functions/cn.html +++ b/platform-bible-react/functions/cn.html @@ -29,4 +29,4 @@ therefore it was not applied
  • Notice that 'some-class' was applied. This function is not limited only to Tailwind classes.
  • -
    +
    diff --git a/platform-bible-react/functions/getBookNumFromId.html b/platform-bible-react/functions/getBookNumFromId.html index e37ac2b0d0..376dec60e9 100644 --- a/platform-bible-react/functions/getBookNumFromId.html +++ b/platform-bible-react/functions/getBookNumFromId.html @@ -2,4 +2,4 @@
    +
    diff --git a/platform-bible-react/functions/getLinesFromUSFM.html b/platform-bible-react/functions/getLinesFromUSFM.html index e8af1249a7..49e2fe1d6f 100644 --- a/platform-bible-react/functions/getLinesFromUSFM.html +++ b/platform-bible-react/functions/getLinesFromUSFM.html @@ -1,4 +1,4 @@ getLinesFromUSFM | platform-bible-react

    FunctiongetLinesFromUSFM

    Splits USFM string into shorter line-like segments

    +
    diff --git a/platform-bible-react/functions/getNumberFromUSFM.html b/platform-bible-react/functions/getNumberFromUSFM.html index b799250cd9..88237621e1 100644 --- a/platform-bible-react/functions/getNumberFromUSFM.html +++ b/platform-bible-react/functions/getNumberFromUSFM.html @@ -1,4 +1,4 @@ getNumberFromUSFM | platform-bible-react

    FunctiongetNumberFromUSFM

    Extracts chapter or verse number from USFM strings that start with a \c or \v marker

    +
    diff --git a/platform-bible-react/functions/getStatusForItem.html b/platform-bible-react/functions/getStatusForItem.html index 71d4eb0464..74ed1c7e69 100644 --- a/platform-bible-react/functions/getStatusForItem.html +++ b/platform-bible-react/functions/getStatusForItem.html @@ -3,4 +3,4 @@
  • approvedItems: string[]

    Array of approved items, typically as defined in Settings.xml

  • unapprovedItems: string[]

    Array of unapproved items, typically as defined in Settings.xml

  • Returns Status

    The status for the specified item

    -
    +
    diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index 48f8ae1785..5d7665d76f 100644 --- a/platform-bible-react/functions/inventoryCountColumn.html +++ b/platform-bible-react/functions/inventoryCountColumn.html @@ -1,4 +1,4 @@ inventoryCountColumn | platform-bible-react

    FunctioninventoryCountColumn

    Function that creates the count column for inventories. Should be used with the DataTable component.

    +
    diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index 549eaf8d89..14f3d4e8b5 100644 --- a/platform-bible-react/functions/inventoryItemColumn.html +++ b/platform-bible-react/functions/inventoryItemColumn.html @@ -1,4 +1,4 @@ inventoryItemColumn | platform-bible-react

    FunctioninventoryItemColumn

    Function that creates the item column for inventories

    +
    diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index bc2bd22d5c..ba86868f01 100644 --- a/platform-bible-react/functions/inventoryStatusColumn.html +++ b/platform-bible-react/functions/inventoryStatusColumn.html @@ -7,4 +7,4 @@
  • onUnapprovedItemsChange: ((items: string[]) => void)

    Callback function that stores the updated list of unapproved items

      • (items): void
      • Parameters

        • items: string[]

        Returns void

  • Returns ColumnDef<InventoryTableData>

    Column that shows the status buttons for the related inventory item. The button for the current status of the item is selected

    -
    +
    diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index a250ca21c8..e3a9f6d152 100644 --- a/platform-bible-react/functions/useEvent.html +++ b/platform-bible-react/functions/useEvent.html @@ -9,4 +9,4 @@
  • eventHandler: PlatformEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    +

    Returns void

    diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index 80590943b5..2f95e3deb0 100644 --- a/platform-bible-react/functions/useEventAsync.html +++ b/platform-bible-react/functions/useEventAsync.html @@ -10,4 +10,4 @@
  • eventHandler: PlatformEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    +

    Returns void

    diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index 78658a146a..2dd726598d 100644 --- a/platform-bible-react/functions/usePromise.html +++ b/platform-bible-react/functions/usePromise.html @@ -21,4 +21,4 @@
  • value: the current value for the promise, either the defaultValue or the resolved promise value
  • isLoading: whether the promise is waiting to be resolved
  • -
    +
    diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index ae652a4801..fd14469535 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    about? +ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    aria-valuenow?: number

    Defines the current value for a range widget.

    aria-valuetext.

    aria-valuetext?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    -
    asChild?: boolean
    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    children?: ReactNode
    className?: string
    color?: string
    content?: string
    contentEditable?: "inherit" | Booleanish | "plaintext-only"
    contextMenu?: string
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }
    datatype?: string
    defaultChecked?: boolean
    defaultValue?: string | number | readonly string[]
    dir?: string
    disabled?: boolean
    draggable?: Booleanish
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"
    form?: string
    formAction?: string
    formEncType?: string
    formMethod?: string
    formNoValidate?: boolean
    formTarget?: string
    hidden?: boolean
    id?: string
    inlist?: any
    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    asChild?: boolean
    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    children?: ReactNode
    className?: string
    color?: string
    content?: string
    contentEditable?: "inherit" | Booleanish | "plaintext-only"
    contextMenu?: string
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }
    datatype?: string
    defaultChecked?: boolean
    defaultValue?: string | number | readonly string[]
    dir?: string
    disabled?: boolean
    draggable?: Booleanish
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"
    form?: string
    formAction?: string
    formEncType?: string
    formMethod?: string
    formNoValidate?: boolean
    formTarget?: string
    hidden?: boolean
    id?: string
    inlist?: any
    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    itemID?: string
    itemProp?: string
    itemRef?: string
    itemScope?: boolean
    itemType?: string
    lang?: string
    name?: string
    nonce?: string
    onAbort?: ReactEventHandler<HTMLButtonElement>
    onAbortCapture?: ReactEventHandler<HTMLButtonElement>
    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>
    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>
    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>
    onAuxClick?: MouseEventHandler<HTMLButtonElement>
    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>
    onBeforeInput?: FormEventHandler<HTMLButtonElement>
    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>
    onBlur?: FocusEventHandler<HTMLButtonElement>
    onBlurCapture?: FocusEventHandler<HTMLButtonElement>
    onCanPlay?: ReactEventHandler<HTMLButtonElement>
    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>
    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>
    onChange?: FormEventHandler<HTMLButtonElement>
    onChangeCapture?: FormEventHandler<HTMLButtonElement>
    onClick?: MouseEventHandler<HTMLButtonElement>
    onClickCapture?: MouseEventHandler<HTMLButtonElement>
    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>
    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>
    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>
    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>
    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>
    onContextMenu?: MouseEventHandler<HTMLButtonElement>
    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>
    onCopy?: ClipboardEventHandler<HTMLButtonElement>
    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>
    onCut?: ClipboardEventHandler<HTMLButtonElement>
    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>
    onDoubleClick?: MouseEventHandler<HTMLButtonElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>
    onDrag?: DragEventHandler<HTMLButtonElement>
    onDragCapture?: DragEventHandler<HTMLButtonElement>
    onDragEnd?: DragEventHandler<HTMLButtonElement>
    onDragEndCapture?: DragEventHandler<HTMLButtonElement>
    onDragEnter?: DragEventHandler<HTMLButtonElement>
    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>
    onDragExit?: DragEventHandler<HTMLButtonElement>
    onDragExitCapture?: DragEventHandler<HTMLButtonElement>
    onDragLeave?: DragEventHandler<HTMLButtonElement>
    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>
    onDragOver?: DragEventHandler<HTMLButtonElement>
    onDragOverCapture?: DragEventHandler<HTMLButtonElement>
    onDragStart?: DragEventHandler<HTMLButtonElement>
    onDragStartCapture?: DragEventHandler<HTMLButtonElement>
    onDrop?: DragEventHandler<HTMLButtonElement>
    onDropCapture?: DragEventHandler<HTMLButtonElement>
    onDurationChange?: ReactEventHandler<HTMLButtonElement>
    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onEmptied?: ReactEventHandler<HTMLButtonElement>
    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>
    onEncrypted?: ReactEventHandler<HTMLButtonElement>
    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>
    onEnded?: ReactEventHandler<HTMLButtonElement>
    onEndedCapture?: ReactEventHandler<HTMLButtonElement>
    onError?: ReactEventHandler<HTMLButtonElement>
    onErrorCapture?: ReactEventHandler<HTMLButtonElement>
    onFocus?: FocusEventHandler<HTMLButtonElement>
    onFocusCapture?: FocusEventHandler<HTMLButtonElement>
    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onInput?: FormEventHandler<HTMLButtonElement>
    onInputCapture?: FormEventHandler<HTMLButtonElement>
    onInvalid?: FormEventHandler<HTMLButtonElement>
    onInvalidCapture?: FormEventHandler<HTMLButtonElement>
    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>
    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>
    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

    Use onKeyUp or onKeyDown instead

    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

    Use onKeyUpCapture or onKeyDownCapture instead

    -
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
    onLoad?: ReactEventHandler<HTMLButtonElement>
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedData?: ReactEventHandler<HTMLButtonElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadStart?: ReactEventHandler<HTMLButtonElement>
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onMouseDown?: MouseEventHandler<HTMLButtonElement>
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>
    onMouseMove?: MouseEventHandler<HTMLButtonElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOut?: MouseEventHandler<HTMLButtonElement>
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOver?: MouseEventHandler<HTMLButtonElement>
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseUp?: MouseEventHandler<HTMLButtonElement>
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
    onPaste?: ClipboardEventHandler<HTMLButtonElement>
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
    onPause?: ReactEventHandler<HTMLButtonElement>
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>
    onPlay?: ReactEventHandler<HTMLButtonElement>
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onPlaying?: ReactEventHandler<HTMLButtonElement>
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerDown?: PointerEventHandler<HTMLButtonElement>
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>
    onPointerMove?: PointerEventHandler<HTMLButtonElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOut?: PointerEventHandler<HTMLButtonElement>
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOver?: PointerEventHandler<HTMLButtonElement>
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerUp?: PointerEventHandler<HTMLButtonElement>
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
    onProgress?: ReactEventHandler<HTMLButtonElement>
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>
    onRateChange?: ReactEventHandler<HTMLButtonElement>
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onReset?: FormEventHandler<HTMLButtonElement>
    onResetCapture?: FormEventHandler<HTMLButtonElement>
    onResize?: ReactEventHandler<HTMLButtonElement>
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>
    onScroll?: UIEventHandler<HTMLButtonElement>
    onScrollCapture?: UIEventHandler<HTMLButtonElement>
    onSeeked?: ReactEventHandler<HTMLButtonElement>
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
    onSeeking?: ReactEventHandler<HTMLButtonElement>
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
    onSelect?: ReactEventHandler<HTMLButtonElement>
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>
    onStalled?: ReactEventHandler<HTMLButtonElement>
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>
    onSubmit?: FormEventHandler<HTMLButtonElement>
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>
    onSuspend?: ReactEventHandler<HTMLButtonElement>
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchMove?: TouchEventHandler<HTMLButtonElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchStart?: TouchEventHandler<HTMLButtonElement>
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onWaiting?: ReactEventHandler<HTMLButtonElement>
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
    onWheel?: WheelEventHandler<HTMLButtonElement>
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    type?: "button" | "reset" | "submit"
    typeof?: string
    unselectable?: "off" | "on"
    value?: string | number | readonly string[]
    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...
    vocab?: string
    +
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
    onLoad?: ReactEventHandler<HTMLButtonElement>
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedData?: ReactEventHandler<HTMLButtonElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadStart?: ReactEventHandler<HTMLButtonElement>
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onMouseDown?: MouseEventHandler<HTMLButtonElement>
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>
    onMouseMove?: MouseEventHandler<HTMLButtonElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOut?: MouseEventHandler<HTMLButtonElement>
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOver?: MouseEventHandler<HTMLButtonElement>
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseUp?: MouseEventHandler<HTMLButtonElement>
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
    onPaste?: ClipboardEventHandler<HTMLButtonElement>
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
    onPause?: ReactEventHandler<HTMLButtonElement>
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>
    onPlay?: ReactEventHandler<HTMLButtonElement>
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onPlaying?: ReactEventHandler<HTMLButtonElement>
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerDown?: PointerEventHandler<HTMLButtonElement>
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>
    onPointerMove?: PointerEventHandler<HTMLButtonElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOut?: PointerEventHandler<HTMLButtonElement>
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOver?: PointerEventHandler<HTMLButtonElement>
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerUp?: PointerEventHandler<HTMLButtonElement>
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
    onProgress?: ReactEventHandler<HTMLButtonElement>
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>
    onRateChange?: ReactEventHandler<HTMLButtonElement>
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onReset?: FormEventHandler<HTMLButtonElement>
    onResetCapture?: FormEventHandler<HTMLButtonElement>
    onResize?: ReactEventHandler<HTMLButtonElement>
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>
    onScroll?: UIEventHandler<HTMLButtonElement>
    onScrollCapture?: UIEventHandler<HTMLButtonElement>
    onSeeked?: ReactEventHandler<HTMLButtonElement>
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
    onSeeking?: ReactEventHandler<HTMLButtonElement>
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
    onSelect?: ReactEventHandler<HTMLButtonElement>
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>
    onStalled?: ReactEventHandler<HTMLButtonElement>
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>
    onSubmit?: FormEventHandler<HTMLButtonElement>
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>
    onSuspend?: ReactEventHandler<HTMLButtonElement>
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchMove?: TouchEventHandler<HTMLButtonElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchStart?: TouchEventHandler<HTMLButtonElement>
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onWaiting?: ReactEventHandler<HTMLButtonElement>
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
    onWheel?: WheelEventHandler<HTMLButtonElement>
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    type?: "button" | "reset" | "submit"
    typeof?: string
    unselectable?: "off" | "on"
    value?: string | number | readonly string[]
    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...
    vocab?: string
    diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index c60ebe5fea..01bd80d6df 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

    InterfaceCommandHandler

    +CommandHandler | platform-bible-react

    InterfaceCommandHandler

    diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 1f302fb1f2..9671769d74 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    +MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    diff --git a/platform-bible-react/types/BookSelectorLocalizedStrings.html b/platform-bible-react/types/BookSelectorLocalizedStrings.html index 0996ed98e0..d08c5fe244 100644 --- a/platform-bible-react/types/BookSelectorLocalizedStrings.html +++ b/platform-bible-react/types/BookSelectorLocalizedStrings.html @@ -1 +1 @@ -BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }
    +BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }
    diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index b3e1884d4f..96f140969d 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

    ChapterRangeSelectorProps: {
        chapterCount: number;
        endChapter: number;
        handleSelectEndChapter: ((chapter: number) => void);
        handleSelectStartChapter: ((chapter: number) => void);
        isDisabled?: boolean;
        startChapter: number;
    }
    +ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

    ChapterRangeSelectorProps: {
        chapterCount: number;
        endChapter: number;
        handleSelectEndChapter: ((chapter: number) => void);
        handleSelectStartChapter: ((chapter: number) => void);
        isDisabled?: boolean;
        startChapter: number;
    }
    diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index bcb5cc3bb7..1ddc952386 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -8,4 +8,4 @@

    Returns void

  • Optionalid?: string

    Optional string representing the id attribute of the Checklist

  • listItems: string[]

    Array of strings representing the checkable items

  • selectedListItems: string[]

    Array of strings representing the checked items

    -
  • +
    diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index 5e996e76bb..57e92f2659 100644 --- a/platform-bible-react/types/ColumnDef.html +++ b/platform-bible-react/types/ColumnDef.html @@ -1 +1 @@ -ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown
    +ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown
    diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index ab96f44067..4fc6b8577f 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }
    +ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }
    diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index dad90ca907..badd011658 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react
    +ComboBoxOption | platform-bible-react
    diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index 771e551c29..6e9c062715 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -11,4 +11,4 @@
  • OptionaltextPlaceholder?: string

    Placeholder text for text field

  • Optionalvalue?: T

    The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

    -
  • +
    diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index 8f54ee9870..e410c14751 100644 --- a/platform-bible-react/types/DropdownGroup.html +++ b/platform-bible-react/types/DropdownGroup.html @@ -1,4 +1,4 @@ DropdownGroup | platform-bible-react

    Type AliasDropdownGroup

    DropdownGroup: {
        items: DropdownItem[];
        label: string;
    }

    Type declaration

    • items: DropdownItem[]

      The items array contains the items that will be displayed in the dropdown group

    • label: string

      The label is the text that will be displayed on the dropdown group. It is used to categorize the items in the group.

      -
    +
    diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index 2007dc3137..ed89130419 100644 --- a/platform-bible-react/types/DropdownItem.html +++ b/platform-bible-react/types/DropdownItem.html @@ -1,4 +1,4 @@ DropdownItem | platform-bible-react

    Type AliasDropdownItem

    DropdownItem: {
        itemType: DropdownMenuItemType;
        label: string;
        onClick: (() => void);
    }

    Type declaration

    • itemType: DropdownMenuItemType

      The itemType determines the DropdownMenuItemType type as either Check or Radio.

    • label: string

      The label is the text that will be displayed on the dropdown item.

    • onClick: (() => void)

      The onClick function is called when the item is clicked.

      -
        • (): void
        • Returns void

    +
      • (): void
      • Returns void

    diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index 08ff3d1946..9be3ef2ed1 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }
    +DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index 9b688b80a9..501b58905e 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }
    +DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }
    diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index 0a58dc181b..be6289be75 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index e3ebd550f7..1bd789676e 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index 5e9b6d9b00..971eccb270 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }
    +DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index 8409221b45..faac80bebc 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }
    +DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 470d07d887..83e53851b6 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }
    +DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index 1488c9d031..03963904f7 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }
    +DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index 1a309786df..9c952c4bf6 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index c973af0841..4af6bff7e7 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

    Type AliasGridMenuInfo

    GridMenuInfo: {
        multiColumnMenu: Localized<MultiColumnMenu>;
    }

    Type declaration

    • multiColumnMenu: Localized<MultiColumnMenu>

      The menu object containing information about the columns, groups, and items to display.

      -
    +
    diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index d20f00b4b4..ca48d9a58a 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

    Type AliasGridMenuProps

    GridMenuProps: GridMenuInfo & {
        className?: string;
        commandHandler: CommandHandler;
        id?: string;
    }

    Type declaration

    • OptionalclassName?: string

      Additional css classes to help with unique styling of the grid menu

    • commandHandler: CommandHandler
    • Optionalid?: string

      Optional unique identifier

      -
    +
    diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 68182a1b58..2c97be3380 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -19,4 +19,4 @@
  • Optionaltooltip?: string

    Optional tooltip to display if different from the aria-label.

    -
  • +
    diff --git a/platform-bible-react/types/InventoryItemOccurrence.html b/platform-bible-react/types/InventoryItemOccurrence.html index 2dd9b8b1a3..1096be1dd8 100644 --- a/platform-bible-react/types/InventoryItemOccurrence.html +++ b/platform-bible-react/types/InventoryItemOccurrence.html @@ -1,4 +1,4 @@ InventoryItemOccurrence | platform-bible-react

    Type AliasInventoryItemOccurrence

    InventoryItemOccurrence: {
        reference: ScriptureReference;
        text: string;
    }

    Occurrence of item in inventory. Primarily used by table that shows occurrences

    Type declaration

    • reference: ScriptureReference

      Reference to scripture where the item appears

    • text: string

      Snippet of scripture that contains the occurrence

      -
    +
    diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index a5ae64f53f..3c6ca201d2 100644 --- a/platform-bible-react/types/InventoryLocalizedStrings.html +++ b/platform-bible-react/types/InventoryLocalizedStrings.html @@ -1 +1 @@ -InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }
    +InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }
    diff --git a/platform-bible-react/types/InventoryTableData.html b/platform-bible-react/types/InventoryTableData.html index 0e54448c1b..be1f343730 100644 --- a/platform-bible-react/types/InventoryTableData.html +++ b/platform-bible-react/types/InventoryTableData.html @@ -7,4 +7,4 @@ prop for the Inventory component

  • occurrences: InventoryItemOccurrence[]

    Occurrences of this item in the scripture text for the selected scope

  • status: Status

    The status of this item (see documentation for Status type for more information)

    -
  • +
    diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 13d2bdc567..ea4edbf95f 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

    Type AliasMenuItemListProps

    MenuItemListProps: MenuPropsBase & {
        columnId?: ReferencedItem;
    }

    Type declaration

    • OptionalcolumnId?: ReferencedItem

      Optional unique (column) identifier

      -
    +
    diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index ff62b0b951..78b869021d 100644 --- a/platform-bible-react/types/ResultsSet.html +++ b/platform-bible-react/types/ResultsSet.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • data: ScriptureItemDetail[]

      Array of Scripture item details (messages keyed by Scripture reference).

    • source: ResultsSource

      The backing source associated with this set of results.

      -
    +
    diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index 98f4fbc005..724ac8eef0 100644 --- a/platform-bible-react/types/ResultsSource.html +++ b/platform-bible-react/types/ResultsSource.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • displayName: string

      Name (potentially localized) of the source, suitable for display in the UI.

    • id: string

      Uniquely identifies the source.

      -
    +
    diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index 8f7bad89b4..f66124de53 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react
    +RowContents | platform-bible-react
    diff --git a/platform-bible-react/types/Scope.html b/platform-bible-react/types/Scope.html index 8a56a96176..072304c543 100644 --- a/platform-bible-react/types/Scope.html +++ b/platform-bible-react/types/Scope.html @@ -1,2 +1,2 @@ Scope | platform-bible-react
    Scope: "book" | "chapter" | "verse"

    Scope of scripture that the inventory can operate on

    -
    +
    diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index c251696891..2904bde0f0 100644 --- a/platform-bible-react/types/ScriptureItemDetail.html +++ b/platform-bible-react/types/ScriptureItemDetail.html @@ -3,4 +3,4 @@

    Type declaration

    • detail: string

      Text of the error, note, etc. In the future, we might want to support something more than just text so that a JSX element could be provided with a link or some other controls related to the issue being reported.

      -
    +
    diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index fb84622992..1c99362f69 100644 --- a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html +++ b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html @@ -2,4 +2,4 @@
  • OptionalscriptureBookGroupName?: string

    Optional text to display to refer to the Scripture book group. Default value: 'Scripture Book'.

  • OptionalscriptureReferenceColumnName?: string

    Optional header to display for the Reference column. Default value: 'Scripture Reference'.

  • OptionaltypeColumnName?: string

    Optional header to display for the Type column. Default value: 'Type'.

    -
  • +
    diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index 0272332f0a..7bf93f93db 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -3,4 +3,4 @@
  • OptionalshowColumnHeaders?: boolean

    Flag indicating whether to display column headers. Default is false.

  • OptionalshowSourceColumn?: boolean

    Flag indicating whether to display source column. Default is false.

  • sources: ResultsSet[]

    Groups of ScriptureItemDetail objects from particular sources (e.g., Scripture checks)

    -
  • +
    diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index 99be513c02..b6e4dec2b7 100644 --- a/platform-bible-react/types/ScriptureSrcItemDetail.html +++ b/platform-bible-react/types/ScriptureSrcItemDetail.html @@ -1,2 +1,2 @@ ScriptureSrcItemDetail | platform-bible-react

    Type AliasScriptureSrcItemDetail

    ScriptureSrcItemDetail: ScriptureItemDetail & {
        source: ResultsSource;
    }

    Type declaration

    • source: ResultsSource

      Source/type of detail. Can be used for grouping.

      -
    +
    diff --git a/platform-bible-react/types/ScrollGroupSelectorProps.html b/platform-bible-react/types/ScrollGroupSelectorProps.html index 9ab4ec3475..ba475661c5 100644 --- a/platform-bible-react/types/ScrollGroupSelectorProps.html +++ b/platform-bible-react/types/ScrollGroupSelectorProps.html @@ -17,4 +17,4 @@
  • onChangeScrollGroupId: ((newScrollGroupId: ScrollGroupId | undefined) => void)

    Callback function run when the user tries to change the scroll group id

      • (newScrollGroupId): void
      • Parameters

        • newScrollGroupId: ScrollGroupId | undefined

        Returns void

  • scrollGroupId: ScrollGroupId | undefined

    Currently selected scroll group id. undefined for no scroll group

    -
  • +
    diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 19cf92a6ca..a277429bc1 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

    Type AliasSearchBarProps

    SearchBarProps: {
        isFullWidth?: boolean;
        onSearch: ((searchQuery: string) => void);
        placeholder?: string;
    }

    Type declaration

    • OptionalisFullWidth?: boolean

      Optional boolean to set the input base to full width

    • onSearch: ((searchQuery: string) => void)

      Callback fired to handle the search query when button pressed

        • (searchQuery): void
        • Parameters

          • searchQuery: string

          Returns void

    • Optionalplaceholder?: string

      Optional string that appears in the search bar without a search string

      -
    +
    diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 2f1774d4bf..8822937ed0 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react
    +SortDirection | platform-bible-react
    diff --git a/platform-bible-react/types/SpinnerProps.html b/platform-bible-react/types/SpinnerProps.html index f6529c1033..8b65210141 100644 --- a/platform-bible-react/types/SpinnerProps.html +++ b/platform-bible-react/types/SpinnerProps.html @@ -1 +1 @@ -SpinnerProps | platform-bible-react
    +SpinnerProps | platform-bible-react
    diff --git a/platform-bible-react/types/TabKeyValueContent.html b/platform-bible-react/types/TabKeyValueContent.html index c130a4cdb6..7c0eb8101b 100644 --- a/platform-bible-react/types/TabKeyValueContent.html +++ b/platform-bible-react/types/TabKeyValueContent.html @@ -1 +1 @@ -TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }
    +TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }
    diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index db59012d25..047fadcd4e 100644 --- a/platform-bible-react/types/TableContents.html +++ b/platform-bible-react/types/TableContents.html @@ -1 +1 @@ -TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData
    +TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData
    diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 2046cbe09d..0ae587047c 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -24,4 +24,4 @@
  • OptionalonFocus?: FocusEventHandler<HTMLInputElement>

    Triggers when textfield gets focus

  • Optionalplaceholder?: string

    The short hint displayed in the input before the user enters a value.

  • Optionalvalue?: string | number

    Value of the text field if controlled

    -
  • +
    diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 416c29054b..93202701ad 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
  • Optionalid?: string

    Optional unique identifier

  • OptionalmenuProvider?: MultiColumnMenuProvider

    The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

    -
  • +
    diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index 0d0c8c4f0c..ec3430a587 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

    Type AliasUsePromiseOptions

    UsePromiseOptions: {
        preserveValue?: boolean;
    }

    Type declaration

    • OptionalpreserveValue?: boolean

      Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

      -
    +
    diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index 2805e54a1e..203b2dd2c3 100644 --- a/platform-bible-react/types/VersionHistoryType.html +++ b/platform-bible-react/types/VersionHistoryType.html @@ -1,2 +1,2 @@ VersionHistoryType | platform-bible-react

    Type AliasVersionHistoryType

    VersionHistoryType: Record<string, VersionInformation>

    Type to store the version history information

    -
    +
    diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index e38b963c40..4af9165bff 100644 --- a/platform-bible-react/types/VersionInformation.html +++ b/platform-bible-react/types/VersionInformation.html @@ -1,3 +1,3 @@ VersionInformation | platform-bible-react

    Type AliasVersionInformation

    VersionInformation: {
        date: string;
        description: string;
    }

    Type declaration

    • date: string

      Date the version was published

    • description: string

      Description of the changes in the version

      -
    +
    diff --git a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html index 7a86391700..399076787f 100644 --- a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html +++ b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html @@ -1,4 +1,4 @@ BOOK_SELECTOR_STRING_KEYS | platform-bible-react

    VariableBOOK_SELECTOR_STRING_KEYSConst

    BOOK_SELECTOR_STRING_KEYS: readonly ["%webView_bookSelector_currentBook%", "%webView_bookSelector_choose%", "%webView_bookSelector_chooseBooks%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -
    +
    diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index f62f6b9dee..994a916409 100644 --- a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html +++ b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html @@ -1,4 +1,4 @@ INVENTORY_STRING_KEYS | platform-bible-react

    VariableINVENTORY_STRING_KEYSConst

    INVENTORY_STRING_KEYS: readonly ["%webView_inventory_all%", "%webView_inventory_approved%", "%webView_inventory_unapproved%", "%webView_inventory_unknown%", "%webView_inventory_scope_currentBook%", "%webView_inventory_scope_chapter%", "%webView_inventory_scope_verse%", "%webView_inventory_filter_text%", "%webView_inventory_show_additional_items%", "%webView_inventory_occurrences_table_header_reference%", "%webView_inventory_occurrences_table_header_occurrence%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -
    +
    diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index eb3f7fa775..8629b7cb22 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

    ClassAsyncVariable<T>

    This class provides a convenient way for one task to wait on a variable that another task sets.

    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Accessors

    Methods

    rejectWithReason @@ -9,17 +9,17 @@
  • rejectIfNotSettledWithinMS: number = 10000

    Milliseconds to wait before verifying if the promise was settled (resolved or rejected); will reject if it has not settled by that time. Use -1 if you do not want a timeout at all. Defaults to 10000 ms

    -
  • Returns AsyncVariable<T>

    Accessors

    • get hasSettled(): boolean
    • A simple way to see if this variable's promise was resolved or rejected already

      +

    Returns AsyncVariable<T>

    Accessors

    • get promise(): Promise<T>
    • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

      Returns Promise<T>

      The promise for the value to be set

      -

    Methods

    Methods

    • Reject this variable's promise for the value with the given reason

      Parameters

      • reason: string

        This variable's promise will be rejected with this reason

      • throwIfAlreadySettled: boolean = false

        Determines whether to throw if the variable was already resolved or rejected. Defaults to false

        -

      Returns void

    • Resolve this variable's promise to the given value

      +

    Returns void

    • Resolve this variable's promise to the given value

      Parameters

      • value: T

        This variable's promise will resolve to this value

      • throwIfAlreadySettled: boolean = false

        Determines whether to throw if the variable was already resolved or rejected. Defaults to false

        -

      Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index b555e258e8..0ce057dc5f 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,14 +1,14 @@ Collator | platform-bible-utils

    Enables language-sensitive string comparison. Wraps Intl.Collator

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Compares two strings according to the sort order of this Collator object

      +

    Constructors

    Methods

    • Compares two strings according to the sort order of this Collator object

      Parameters

      • string1: string

        String to compare

      • string2: string

        String to compare

      Returns number

      A number indicating how string1 and string2 compare to each other according to the sort order of this Collator object. Negative value if string1 comes before string2. Positive value if string1 comes after string2. 0 if they are considered equal.

      -
    • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

      Returns ResolvedCollatorOptions

      ResolvedCollatorOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index 1293c72594..ceededcc97 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,29 +1,29 @@ DateTimeFormat | platform-bible-utils

    Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

    -

    Constructors

    Constructors

    Methods

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      +

    Constructors

    Methods

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns string

      String representing the given date formatted according to the locale and formatting options of this DateTimeFormat object

      -
    • Formats a date range in the most concise way based on the locales and options provided when instantiating this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns string

      String representing the given date range formatted according to the locale and formatting options of this DateTimeFormat object

      -
    • Returns an array of locale-specific tokens representing each part of the formatted date range produced by this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns DateTimeRangeFormatPart[]

      Array of DateTimeRangeFormatPart objects

      -
    • Allows locale-aware formatting of strings produced by this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns DateTimeFormatPart[]

      Array of DateTimeFormatPart objects

      -
    • Returns a new object with properties reflecting the locale and date and time formatting options computed during initialization of this DateTimeFormat object

      Returns ResolvedDateTimeFormatOptions

      ResolvedDateTimeFormatOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index fa2db5c3a1..48f8b5ebd6 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Returns DocumentCombiner

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -32,22 +32,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

      Parameters

      • baseDocument: JsonDocumentLike

        Initial input document. Already validated via validateBaseDocument

      Returns JsonDocumentLike

      Transformed base document

      -
    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -55,19 +55,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -
    • Transform the document that is the composition of the base document and all contribution documents. This is the last step that will be run prior to validation via validateOutput before this.latestOutput is updated to the new output.

      Parameters

      • finalOutput: JsonDocumentLike

        Final output document that could potentially be returned to callers. "Final" means no further contribution documents will be merged.

        -

      Returns JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    • Throw an error if the provided document is not a valid contribution document.

      Parameters

      • documentName: string

        Name of the contributed document to combine

      • document: JsonDocumentLike

        Content of the contributed document to combine

        -

      Returns void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index ada6541d1c..4ffaa5ef83 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -4,7 +4,7 @@

    See async-mutex for more information.

    -

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    Methods

    acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 23b752d3e8..14698ba4b2 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,4 +1,4 @@ MutexMap | platform-bible-utils

    Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

    -

    Constructors

    Constructors

    Methods

    get -

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 999a809e3d..c54976acc9 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

    ClassNonValidatingDocumentCombiner

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Accessors

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Accessors

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -30,22 +30,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -53,19 +53,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -
    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index a7efec5f0e..719cf5667f 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,30 +1,30 @@ NumberFormat | platform-bible-utils

    Enables language-sensitive number formatting. Wraps Intl.NumberFormat

    -

    Constructors

    Constructors

    Methods

    • Formats a number according to the locale and formatting options of this NumberFormat object

      +

    Constructors

    Methods

    • Formats a number according to the locale and formatting options of this NumberFormat object

      Parameters

      • value: number | bigint

        Number or BigInt to format

      Returns string

      String representing the given number formatted according to the locale and formatting options of this NumberFormat object

      -
    • Formats a range of numbers according to the locale and formatting options of this NumberFormat object

      Parameters

      • startRange: number | bigint

        Number or bigint representing the start of the range

      • endRange: number | bigint

        Number or bigint representing the end of the range

      Returns string

      String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object

      -
    • Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.

      Parameters

      • startRange: number | bigint

        Number or bigint representing start of the range

      • endRange: number | bigint

        Number or bigint representing end of the range

      Returns NumberRangeFormatPart[]

      Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts

      -
    • Allows locale-aware formatting of strings produced by this NumberFormat object

      Parameters

      • value: number | bigint

        Number or bigint to format

      Returns NumberFormatPart[]

      Array of NumberFormatPart objects containing the formatted number in parts

      -
    • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

      Returns ResolvedNumberFormatOptions

      ResolvedNumberFormatOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index b0fc738ec6..38f1639ee2 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

    -

    Type Parameters

    • T

    Implements

    Constructors

    Type Parameters

    • T

    Implements

    Constructors

    Properties

    Accessors

    Methods

    assertNotDisposed @@ -16,16 +16,16 @@

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    event

    -

    Accessors

    • get event(): PlatformEvent<T>
    • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

    Accessors

    Methods

    Methods

    • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns void

    +

    Parameters

    • event: T

    Returns void

    diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index e2a8c1e749..bc6388e848 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,10 +1,10 @@ UnsubscriberAsyncList | platform-bible-utils

    Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    • Add unsubscribers to the list. Note that duplicates are not added twice.

      +

    Constructors

    Properties

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    • Run all unsubscribers added to this list and then clear the list.

      +

    Returns void

    +
    diff --git a/platform-bible-utils/classes/UsjReaderWriter.html b/platform-bible-utils/classes/UsjReaderWriter.html index f9f00fdd36..5d9a5c506c 100644 --- a/platform-bible-utils/classes/UsjReaderWriter.html +++ b/platform-bible-utils/classes/UsjReaderWriter.html @@ -1,5 +1,5 @@ UsjReaderWriter | platform-bible-utils

    Represents USJ formatted scripture with helpful utilities for working with it

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Return a copy of text following a given starting point

      +

    Constructors

    Methods

    • Return a copy of text between two points

      +

    Returns string

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • startingPoint: UsjContentLocation
      • text: string

        Text to find

      • maxTextLengthToSearch: number = 1000

        Maximum length of text to search before stopping (default is 1000)

      Returns undefined | UsjContentLocation

      Object containing the USJ node where text begins (it might be split across nodes), @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -
    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -
    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean
          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -
    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number = 0

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    +
    diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index cdbde8c550..98314d58ef 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

    FunctionaggregateUnsubscriberAsyncs

    Returns an UnsubscriberAsync function that combines all the unsubscribers passed in.

    +
    diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 53a9aa45f5..aba982419e 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

    FunctionaggregateUnsubscribers

    Returns an Unsubscriber function that combines all the unsubscribers passed in.

    +
    diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 73112e1999..dad851a003 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

    Returns string | undefined

    New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

    -
    +
    diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index d2c37a8c97..f71b30f5c3 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

    Returns string

    New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

    -
    +
    diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index e640cebed4..94edccf206 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

    Returns number | undefined

    Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

    -
    +
    diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index a0554c9604..40f04cf920 100644 --- a/platform-bible-utils/functions/compareScrRefs.html +++ b/platform-bible-utils/functions/compareScrRefs.html @@ -4,4 +4,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if scrRef1 precedes scrRef2 in sorting order. - Zero if scrRef1 and scrRef2 are equivalent in sorting order. - Positive value if scrRef1 follows scrRef2 in sorting order.

    -
    +
    diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index e51c554c6c..4d530f24fd 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

    Returns T

    A synchronous proxy for the asynchronous object.

    -
    +
    diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index 240d1e46f1..dbd7868adb 100644 --- a/platform-bible-utils/functions/debounce.html +++ b/platform-bible-utils/functions/debounce.html @@ -3,4 +3,4 @@
  • delay: number = 300

    How much delay in milliseconds after the most recent call to the debounced function to call the function

  • Returns T

    Function that, when called, only calls the function passed in at maximum every delay ms

    -
    +
    diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 75b99cbc89..62681dbae2 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

    Type Parameters

    • T

    Parameters

    • obj: T

      Object to clone

    Returns T

    Duplicate copy of obj without any references back to the original one

    -
    +
    diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 6f3b13e80c..4de64a12e3 100644 --- a/platform-bible-utils/functions/deepEqual.html +++ b/platform-bible-utils/functions/deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

    Returns boolean

    True if a and b are deeply equal; false otherwise

    -
    +
    diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 9c95ccfc99..3625476432 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

    -

    Returns any

    +

    Returns any

    diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index dc70a7d761..d8ff414e7b 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
  • endPosition: number = ...

    End position where searchString is expected to be found. Default is length(string)

  • Returns boolean

    True if it ends with searchString, false if it does not

    -
    +
    diff --git a/platform-bible-utils/functions/ensureArray.html b/platform-bible-utils/functions/ensureArray.html index ea82fb9437..80d4829710 100644 --- a/platform-bible-utils/functions/ensureArray.html +++ b/platform-bible-utils/functions/ensureArray.html @@ -10,4 +10,4 @@

    Parameters

    • maybeArray: undefined | T | T[]

      The value that may be a single item, an array, or undefined.

    Returns T[]

    An array containing the input value(s). If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index 8f8e593cc1..188196f4aa 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -6,4 +6,4 @@

    Parameters

    • string: string

    Returns string

    import escapeStringRegexp from 'platform-bible-utils';

    const escapedString = escapeStringRegexp('How much $ for a 🦄?');
    //=> 'How much \\$ for a 🦄\\?'

    new RegExp(escapedString);
    -
    +
    diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index c5de90a3cb..a5d3cb9568 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -9,4 +9,4 @@
    FormatBytes(1024, 0) => "1 KB"
     
    -
    +
    diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index 213c1b60cd..1bf7582fee 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -14,4 +14,4 @@
    formatReplacementString(
    'Hi, this is {name}! I like \{curly braces\}! I have a {carColor} car. My favorite food is {food}.',
    { name: 'Bill', carColor: 'blue' }
    );

    =>

    'Hi, this is Bill! I like {curly braces}! I have a blue car. My favorite food is food.'
    -
    +
    diff --git a/platform-bible-utils/functions/formatReplacementStringToArray.html b/platform-bible-utils/functions/formatReplacementStringToArray.html index cfcc82006b..927c86ac2c 100644 --- a/platform-bible-utils/functions/formatReplacementStringToArray.html +++ b/platform-bible-utils/functions/formatReplacementStringToArray.html @@ -19,4 +19,4 @@
    formatReplacementStringToArray(
    'Hi, this is {name}! I like \{curly braces\}! I have a {carInfo} car. My favorite food is {food}.',
    { name: ['Bill'], carInfo: { year: 2015, color: 'blue' } }
    );

    =>

    ['Hi, this is ', ['Bill'], '! I like {curly braces}! I have a ', { year: 2015, color: 'blue' }, ' car. My favorite food is food.']
    -
    +
    diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index 88f46282de..b3584622e0 100644 --- a/platform-bible-utils/functions/formatScrRef.html +++ b/platform-bible-utils/functions/formatScrRef.html @@ -9,4 +9,4 @@
  • OptionalbookChapterSeparator: string

    The character used to separate the book from the chapter number. Default is a single space. Note: More than one character is allowed.

  • Returns string

    The formatted reference.

    -
    +
    diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 04cc3195f9..3205f62581 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

    Parameters

    • obj: {
          [property: string]: unknown;
      }

      Object whose functions to get

      • [property: string]: unknown
    • _objId: string = 'obj'

      Optional ID of the object to use for debug logging

    Returns Set<string>

    Array of all function names on an object

    -
    +
    diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 2252ce111b..eaa370d48d 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    +getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index c0352575c5..c80da46acd 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

    FunctiongetCurrentLocale

    • Retrieves the current locale of the user's environment.

      Returns string

      A string representing the current locale. If the locale cannot be determined, the function returns an empty string.

      -
    +
    diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index f49e4a02b0..2cada5ac06 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -6,4 +6,4 @@
    `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
     
    -
    +
    diff --git a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html index a6fdb3713b..921acc527f 100644 --- a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html +++ b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html @@ -1,2 +1,2 @@ getLocalizeKeyForScrollGroupId | platform-bible-utils

    FunctiongetLocalizeKeyForScrollGroupId

    +

    Parameters

    • scrollGroupId: undefined | number | "undefined"

    Returns LocalizeKey

    diff --git a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html index a4acbd1f4a..ca02b22f2a 100644 --- a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html +++ b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html @@ -5,4 +5,4 @@
    getLocalizeKeysForScrollGroupIds([undefined, 0, 1, 2, 3, 4]);
    // Gives localized string keys for the provided scroll group ids in an array
    -
    +
    diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index 94d82d5aa8..7c4a1802ad 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

    Parameters

    • bookNumber: number
    • localizationLanguage: string

      In BCP 47 format

    • getLocalizedString: ((item: {
          languagesToSearch?: string[];
          localizeKey: string;
      }) => Promise<string>)

      Function that provides the localized versions of the book ids and names asynchronously.

      -
        • (item): Promise<string>
        • Parameters

          • item: {
                languagesToSearch?: string[];
                localizeKey: string;
            }
            • OptionallanguagesToSearch?: string[]
            • localizeKey: string

          Returns Promise<string>

    Returns Promise<string>

    +

    Returns Promise<string>

    diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 33b51e8c71..ab70f2bcf3 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

    Type Parameters

    • T
    • K

    Parameters

    • items: T[]

      Array of items to group by

    • keySelector: ((item: T) => K)

      Function to run on each item to get the key for the group to which it belongs

        • (item): K
        • Parameters

          • item: T

          Returns K

    Returns Map<K, T[]>

    Map of keys to groups of values corresponding to each item

    -
  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K
        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V
        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

  • +
  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K
        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V
        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

  • diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 475cd66116..001dc0b8d3 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

    HTML Encodes the provided string. Thanks to ChatGPT

    +
    diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index d5f674fea5..7ff66e701d 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
  • searchString: string

    String to search for

  • position: number = 0

    Position within the string to start searching for searchString. Default is 0

  • Returns boolean

    True if search string is found, false if it is not

    -
    +
    diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 6f51c1051b..de7b1d12b0 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
  • searchString: string

    The string to search for

  • position: undefined | number = 0

    Start of searching. Default is 0

  • Returns number

    Index of the first occurrence of a given string

    -
    +
    diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index 9a23d85bce..e31bf81997 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

    FunctionisLocalizeKey

    • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

      -

      Parameters

      • str: string

      Returns str is `%${string}%`

    +

    Parameters

    • str: string

    Returns str is `%${string}%`

    diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 696229d0b7..b83f2334f4 100644 --- a/platform-bible-utils/functions/isSerializable.html +++ b/platform-bible-utils/functions/isSerializable.html @@ -13,4 +13,4 @@

    We intend to improve this in the future if it becomes important to do so. See JSON.stringify documentation for more information.

    -
    +
    diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 5685c811eb..2e1ad45589 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils
    • Determine whether the object is a string

      Parameters

      • o: unknown

        Object to determine if it is a string

      Returns o is string

      True if the object is a string; false otherwise

      -
    +
    diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 12d529f05e..c537ec413e 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -14,4 +14,4 @@

    It is important to note that only arrays of primitives (i.e., booleans, numbers, strings) are supported. In particular, objects in arrays will not be checked for deep equality. Also, presence in an array is all this checks, not the number of times that an item appears in an array. [1, 1] is a subset of [1].

    -
    +
    diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 06d627631e..0dbf914ba8 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
  • Optionalposition: number

    The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

  • Returns number

    Index of the last occurrence of searchString found, or -1 if not found.

    -
    +
    diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index dc754c1196..6c4aca4058 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils
    +

    Returns string

    diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index bef295ee35..29261a9632 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

    Parameters

    • string: string

      The starting string

    • form:
          | "none"
          | "NFC"
          | "NFD"
          | "NFKC"
          | "NFKD"

      Form specifying the Unicode Normalization Form. Default is 'NFC'

    Returns string

    A string containing the Unicode Normalization Form of the given string.

    -
    +
    diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index b9e621f715..06d0e1b97a 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils
    +offsetBook | platform-bible-utils
    diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index d3fcec9106..647091a1bd 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    +offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 4d44c08d87..d616ef3650 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils
    +offsetVerse | platform-bible-utils
    diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 72d9e37721..c3a29cfbc8 100644 --- a/platform-bible-utils/functions/ordinalCompare.html +++ b/platform-bible-utils/functions/ordinalCompare.html @@ -7,4 +7,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if string1 precedes string2 in sorting order. - Zero if string1 and string2 are equivalent in sorting order. - Positive value if string1 follows string2 in sorting order.

    -
    +
    diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index 9bca76e0a6..f412ad6cd3 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

  • Returns string

    String with appropriate padding at the end

    -
    +
    diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index 86f486a852..45cad67862 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

  • Returns string

    String with of specified targetLength with padString applied from the start

    -
    +
    diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index 97b3200bca..56eb0a6c71 100644 --- a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html +++ b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    An integer where the first three digits represent the book, the next three represent the chapter and the last three represent the verse.

    -
    +
    diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 9f0de44d98..405b9578b8 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
  • Optionalspace: string | number

    Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

    -
  • Returns string

    +

    Returns string

    diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index fe1b9b0930..1477bd0b28 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
  • indexStart: number

    The index of the first character to include in the returned substring.

  • OptionalindexEnd: number

    The index of the first character to exclude from the returned substring.

  • Returns string

    A new string containing the extracted section of the string.

    -
    +
    diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 40b5190944..481b9e77d7 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

    Returns string[]

    An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

    -
    +
    diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index e99d3f7b94..ebbd4c8376 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

    Returns boolean

    True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

    -
    +
    diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 5ce520c539..137c945352 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

    Returns the length of a string.

    Parameters

    • string: string

      String to return the length for

    Returns number

    Number that is length of the starting string

    -
    +
    diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 0935174404..501a9168ce 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
  • begin: number

    Start position

  • end: number = ...

    End position. Default is End of string

  • Returns string

    Substring from starting string

    -
    +
    diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 1d710bb4e4..ee58baa442 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

    Converts a string to an array of string characters.

    Parameters

    • string: string

      String to convert to array

    Returns string[]

    An array of characters from the starting string

    -
    +
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html index ba605b9193..cfa8826d76 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html @@ -8,4 +8,4 @@

    Parameters

    • stringMaybeArray: undefined | string | string[]

      The value to be transformed, which can be a single string, an array of strings, or undefined.

    Returns RegExp[]

    An array of RegExp objects. If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html index 7509dea35b..a799adc6c7 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html @@ -12,4 +12,4 @@ array of strings or arrays of strings, or undefined.

    Returns (RegExp | RegExp[])[]

    An array of RegExp objects or arrays of RegExp objects. If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 9df961a9de..4dc0b24c99 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils
    • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

      -

      Parameters

      • ms: number

      Returns Promise<void>

    +

    Parameters

    • ms: number

    Returns Promise<void>

    diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index b6c4c1997f..27758677e9 100644 --- a/platform-bible-utils/functions/waitForDuration.html +++ b/platform-bible-utils/functions/waitForDuration.html @@ -3,4 +3,4 @@
  • maxWaitTimeInMS: number

    The maximum amount of time to wait for the function to resolve

  • Returns Promise<undefined | Awaited<TResult>>

    Promise that resolves to the resolved value of the function or undefined if it ran longer than the specified wait time

    -
    +
    diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 597a05d68e..5280f24089 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils
    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters +BookInfo | platform-bible-utils
    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters: number
    fullNames: string[]
    shortName: string
    +

    Properties

    chapters: number
    fullNames: string[]
    shortName: string
    diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index d0f382bf05..3b9509bb0e 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

    InterfaceCannotHaveOnDidDispose

    Indicates than an object cannot have an onDidDispose event. Also allows an object to include a dispose function.

    -
    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -
    +
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +
    diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index dce9e07291..a76b9eb83d 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

    Require a dispose function

    -
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    +
    diff --git a/platform-bible-utils/interfaces/IUsjReaderWriter.html b/platform-bible-utils/interfaces/IUsjReaderWriter.html index d6f34dbcd7..786265ce32 100644 --- a/platform-bible-utils/interfaces/IUsjReaderWriter.html +++ b/platform-bible-utils/interfaces/IUsjReaderWriter.html @@ -1,5 +1,5 @@ IUsjReaderWriter | platform-bible-utils

    InterfaceIUsjReaderWriter

    Utilities for reading from and writing to Usj objects

    -
    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    • Return a copy of text between two points

      +

    Returns string

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • start: UsjContentLocation

        Point where the search for text will start

      • text: string

        Text to find

      • maxTextLengthToSearch: number

        Maximum length of text to search before stopping (default is 1000)

        @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

        -
    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -
    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -
    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean
          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -
    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    +
    diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index dda4867814..4fc32f28d6 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

    InterfaceLanguageStrings

    Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index 58e09b82fe..f9c594e20f 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

    InterfaceLocalizedStringDataContribution

    The data an extension provides to inform Platform.Bible of the localized strings it provides.

    -
    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }
    metadata?: StringsMetadata
    +

    Properties

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }
    metadata?: StringsMetadata
    diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index 5ec68cfd99..a50f5b5ac6 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

    InterfaceModifierExtensionControlled

    Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

    -
    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    Properties

    platformType?: undefined
    type?: undefined
    +

    Properties

    platformType?: undefined
    type?: undefined
    diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index 4a549edc37..14fbb540a7 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? +ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? excludeProjectInterfaces? includePdpFactoryIds? includeProjectInterfaces? @@ -8,7 +8,7 @@ function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

    Defaults to none, so all projects that match includePdpFactoryIds will be included

    -
    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with @@ -36,13 +36,13 @@

  • Include one
  • Include both two and three.
  • -
    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

    Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

    -
    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

    @@ -69,4 +69,4 @@
  • Include one
  • Include both two and three.
  • -
    +
    diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 0a76979063..4a554bdcd6 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

    InterfaceOnDidDispose

    Require an onDidDispose event

    -
    interface OnDidDispose {
        onDidDispose: PlatformEvent<void>;
    }

    Properties

    interface OnDidDispose {
        onDidDispose: PlatformEvent<void>;
    }

    Properties

    Properties

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -
    +
    diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 702962f870..712c8e3416 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

    InterfaceProjectSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index 6210eb10c2..2ddd6d8aba 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

    InterfaceProjectSettingsGroup

    Group of related settings definitions

    -
    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description?: `%${string}%`

    LocalizeKey that displays in the project settings dialog to describe the group

    -
    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    -
    +
    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    +
    diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 5602acabe6..76caec8a30 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

    InterfaceProjectStateContribution

    The data an extension provides to inform Platform.Bible of the project state it provides

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index d2bc398dd3..099cd8a64f 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    interface ScriptureReference {
        bookNum: number;
        chapterNum: number;
        verseNum: number;
    }

    Properties

    bookNum +ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    interface ScriptureReference {
        bookNum: number;
        chapterNum: number;
        verseNum: number;
    }

    Properties

    bookNum: number
    chapterNum: number
    verseNum: number
    +

    Properties

    bookNum: number
    chapterNum: number
    verseNum: number
    diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index 842c4671f5..ebd8f18c90 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

    InterfaceSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index dd0621e513..1906048339 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

    InterfaceSettingsGroup

    Group of related settings definitions

    -
    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description?: `%${string}%`

    LocalizeKey that displays in the settings dialog to describe the group

    -
    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    -
    properties: SettingProperties
    +
    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    +
    properties: SettingProperties
    diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index c692c6c010..ad26f5e7fd 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

    Base information needed to describe a state entry

    -
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default: unknown

    Default value for the state/setting

    -
    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time +

    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

    -
    +
    diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index 2552170755..ab1f0dff5b 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,11 +1,11 @@ StringMetadata | platform-bible-utils

    InterfaceStringMetadata

    Additional non-locale-specific information about a localized string key

    -
    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    Properties

    fallbackKey?: `%${string}%`

    Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

    You can use Paratext 9 Localized String Keys here. Be sure to escape any % signs with a backslash ``.

    -
    notes?: string

    Additional information provided by developers in English to help the translator to know how to +

    notes?: string

    Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

    -
    +
    diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index 4628bd3dcd..cf3d4cb8a2 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

    InterfaceStringsMetadata

    Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index ddd0ee8181..197f836763 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

    InterfaceUserStateContribution

    The data an extension provides to inform Platform.Bible of the user state it provides

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 081b9a58f5..338251fc1c 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

    Type AliasCanHaveOnDidDispose<T>

    CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

    Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index df62c97a08..db14484f49 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

    Type AliasColumnsWithHeaders

    ColumnsWithHeaders: {
        isExtensible?: boolean;
        [property: ReferencedItem]: MenuColumnWithHeader;
    }

    Group of columns that can be combined with other columns to form a multi-column menu

    Type declaration

    +
    diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 1a062f36d0..439cffea3c 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

    Type AliasDeepPartial<T>

    DeepPartial<T>: T extends object
        ? {
            [P in keyof T]?: DeepPartial<T[P]>
        }
        : T

    Within type T, recursively change all properties to be optional

    -

    Type Parameters

    • T
    +

    Type Parameters

    • T
    diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 7354724df7..3738162f80 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index 055052fe61..0b5c48f25d 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

    Type AliasExtensionControlledProjectSetting

    ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index e23417e0f1..1a60bb331c 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

    Type AliasExtensionControlledSetting

    ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 01a95b1829..c21e1d08b5 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

    Type AliasExtensionControlledState

    ExtensionControlledState: StateBase & ModifierExtensionControlled

    State definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 0733c4d4eb..4b5583a1f7 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

    Type AliasGroupsInMultiColumnMenu

    GroupsInMultiColumnMenu: {
        [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

    Type declaration

    +
    diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index b8b6422e47..8395a82793 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

    Type AliasGroupsInSingleColumnMenu

    GroupsInSingleColumnMenu: {
        [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

    Type declaration

    +
    diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index bf1eaebdeb..478ab15c11 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike
    +JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike
    diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 6a56341182..d235d73923 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

    Type AliasLocalizeKey

    LocalizeKey: `%${string}%`

    Identifier for a string that will be localized in a menu based on the user's UI language

    -
    +
    diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index be1cca2157..bb5e6fce49 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

    Type AliasLocalized<T>

    Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

    Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

    -

    Type Parameters

    • T
    +

    Type Parameters

    • T
    diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 13bde2a1b7..750c84a723 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

    Type AliasLocalizedStringValue

    LocalizedStringValue: string

    Localized string value associated with this key

    -
    +
    diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index ed403c6384..97450afd74 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

    Type AliasMenuColumnWithHeader

    MenuColumnWithHeader: OrderedExtensibleContainer & {
        label: LocalizeKey;
    }

    Column that includes header text in a menu

    Type declaration

    • label: LocalizeKey

      Key that represents the text of the header text of the column

      -
    +
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 3b75e6c132..f7509bdb88 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

    Type AliasMenuGroupDetailsInColumn

    MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
        column: ReferencedItem;
    }

    Group of menu items that belongs in a column

    Type declaration

    +
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index 36ab27ed7a..f8eadf34a1 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

    Type AliasMenuGroupDetailsInSubMenu

    MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
        menuItem: ReferencedItem;
    }

    Group of menu items that belongs in a submenu

    Type declaration

    • menuItem: ReferencedItem

      ID of menu item hosting the submenu in which this group resides

      -
    +
    diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index c028f2332d..3ee90ac3f8 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
  • localizeNotes: string

    Additional information provided by developers to help people who perform localization

  • OptionalsearchTerms?: LocalizeKey

    Key that represents words the platform should reference when users are searching for menu items

  • Optionaltooltip?: LocalizeKey

    Key that represents the text to display if a mouse pointer hovers over the menu item

    -
  • +
    diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index 925baa95cd..7c154c4cd3 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -4,4 +4,4 @@ papi-extension://helloWorld/assets/icon.png

  • OptionaliconPathBefore?: string

    Uri path to the icon to display before the menu text. Ex: papi-extension://helloWorld/assets/icon.png

    -
  • +
    diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 3d5d60791f..ac849ed074 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

    Type AliasMenuItemContainingSubmenu

    MenuItemContainingSubmenu: MenuItemBase & {
        id: ReferencedItem;
    }

    Menu item that hosts a submenu

    Type declaration

    +
    diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index f4897b8078..60dcb26ba2 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 41b3875e1f..2f664834fe 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

    Type AliasOrderedExtensibleContainer

    OrderedExtensibleContainer: OrderedItem & {
        isExtensible?: boolean;
    }

    Type declaration

    • OptionalisExtensible?: boolean

      Determines whether other items can be added to this after it has been defined

      -
    +
    diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 92f6b9d6e8..da5d2d3789 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

    Type AliasOrderedItem

    OrderedItem: {
        order: number;
    }

    Type declaration

    • order: number

      Relative order of this item compared to other items in the same parent/scope (sorted ascending)

      -
    +
    diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 5225e84fbc..70fc5b01e7 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

    Type Parameters

    • T

    Type declaration

      • (callback): Unsubscriber
      • Parameters

        Returns Unsubscriber

        Unsubscriber function to run to stop calling the passed-in function when the event is emitted

        -
    +
    diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 003a6d34d5..a72c9c47fa 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

    Type AliasPlatformEventAsync<T>

    PlatformEventAsync<T>: ((callback: PlatformEventHandler<T>) => Promise<UnsubscriberAsync>)

    A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

    Note: The callback itself is not asynchronous.

    -

    Type Parameters

    • T
    +

    Type Parameters

    • T
    diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 9391d8089a..820b796d97 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

    Type AliasPlatformEventHandler<T>

    PlatformEventHandler<T>: ((event: T) => void)

    Callback function that accepts an event and should run when an event is emitted

    -

    Type Parameters

    • T
    +

    Type Parameters

    • T
    diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 17a1fc4d4e..961049c4b0 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
  • defaultWebViewTopMenu: MultiColumnMenu

    Default top menu for web views that don't specify their own

  • mainMenu: MultiColumnMenu

    Top level menu for the application

  • webViewMenus: WebViewMenus

    Menus that apply per web view in the application

    -
  • +
    diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 0e4f8497d7..4a68db05f9 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

    Type AliasProjectSetting

    A description of an extension's setting entry

    -
    +
    diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index c727274d35..825cd0be21 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

    Type AliasProjectSettingBase

    ProjectSettingBase: SettingBase & ModifierProject

    Base information needed to describe a project setting entry

    -
    +
    diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index cab4089cd7..35a4ad27dd 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

    Type AliasProjectSettingsContribution

    ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

    The data an extension provides to inform Platform.Bible of the project settings it provides

    -
    +
    diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 3eac8abde3..c9ff6bcda4 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

    Type AliasReferencedItem

    ReferencedItem: `${string}.${string}`

    Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

    -
    +
    diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index 7de1af80cb..a2df684933 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

    Type AliasReplaceType<T, A, B>

    ReplaceType<T, A, B>: T extends A
        ? B
        : T extends object
            ? {
                [K in keyof T]: ReplaceType<T[K], A, B>
            }
            : T

    Within type T, recursively change properties that were of type A to be of type B

    -

    Type Parameters

    • T
    • A
    • B
    +

    Type Parameters

    • T
    • A
    • B
    diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index f249992f98..a6b819b77e 100644 --- a/platform-bible-utils/types/ScriptureNode.html +++ b/platform-bible-utils/types/ScriptureNode.html @@ -1,3 +1,3 @@ ScriptureNode | platform-bible-utils

    Type AliasScriptureNode

    ScriptureNode: ScriptureReference & {
        jsonPath: string;
    }

    Represents a "node" in the JSON used to present Scripture in the editor, with a path that is relative to the start of a verse.

    -
    +
    diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index 2ebd1051d7..31125a26b8 100644 --- a/platform-bible-utils/types/ScriptureSelection.html +++ b/platform-bible-utils/types/ScriptureSelection.html @@ -1,3 +1,3 @@ ScriptureSelection | platform-bible-utils

    Type AliasScriptureSelection

    ScriptureSelection: {
        end?: ScriptureNode | ScriptureTextAnchor;
        start: ScriptureNode | ScriptureTextAnchor;
    }

    Represents a range of text in the Scripture editor. The start and end node are expected to be in the same book.

    -
    +
    diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index d7b4b6da8a..8296ad2358 100644 --- a/platform-bible-utils/types/ScriptureTextAnchor.html +++ b/platform-bible-utils/types/ScriptureTextAnchor.html @@ -1,2 +1,2 @@ ScriptureTextAnchor | platform-bible-utils

    Type AliasScriptureTextAnchor

    ScriptureTextAnchor: ScriptureNode & {
        offset: number;
    }

    Represents a specific character offset in the text of a textual Scripture node (in the editor.)

    -
    +
    diff --git a/platform-bible-utils/types/ScrollGroupId.html b/platform-bible-utils/types/ScrollGroupId.html index e4d1f2fd04..5b59f0d9a2 100644 --- a/platform-bible-utils/types/ScrollGroupId.html +++ b/platform-bible-utils/types/ScrollGroupId.html @@ -3,4 +3,4 @@

    For example, a few web views that share a Scroll Group Id would all change Scripture Reference together.

    These are generally expected to be non-negative numbers (starting at 0).

    -
    +
    diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 55fb4c30ae..ba40df06d3 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

    Type AliasSetting

    A description of an extension's setting entry

    -
    +
    diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 702e5c254b..76dbc3cedd 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

    Type AliasSettingBase

    SettingBase: StateBase & {
        description?: LocalizeKey;
        label: LocalizeKey;
        [k: string]: unknown;
    }

    Base information needed to describe a setting entry

    Type declaration

    • [k: string]: unknown
    • Optionaldescription?: LocalizeKey

      LocalizeKey that displays in the settings dialog to describe the setting

    • label: LocalizeKey

      LocalizeKey that displays in the settings dialog as the setting name

      -
    +
    diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index 87c6d2f691..1a06757b6b 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

    Type AliasSettingsContribution

    SettingsContribution: SettingsGroup | SettingsGroup[]

    The data an extension provides to inform Platform.Bible of the settings it provides

    -
    +
    diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index ca65791155..e44627f6c9 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

    Type AliasSingleColumnMenu

    SingleColumnMenu: {
        groups: GroupsInSingleColumnMenu;
        items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
    }

    Menu that contains a column without a header

    Type declaration

    +
    diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index 9f6e31f604..fe9c596251 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -3,4 +3,4 @@

    Type Parameters

    • U
    type TypeOne = { one: string };
    type TypeTwo = { two: number };
    type TypeThree = { three: string };

    type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
    const numNames = ['one', 'two'] as const;
    type TypeNumNames = typeof numNames;

    // Same as `TypeOne | TypeTwo`
    // `{ one: string } | { two: number }`
    type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

    // Same as `TypeOne & TypeTwo`
    // `{ one: string; two: number }`
    type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
    -
    +
    diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 3e79accfa5..d709719606 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

    Type AliasUnsubscriber

    Unsubscriber: (() => boolean)

    Function to run to dispose of something. Returns true if successfully unsubscribed

    -
    +
    diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 6daceefaa1..024693c0e8 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

    Type AliasUnsubscriberAsync

    UnsubscriberAsync: (() => Promise<boolean>)

    Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

    -
    +
    diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 1a43dba3de..4ffff969a1 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

    Type AliasUserState

    A description of an extension's user state entry

    -
    +
    diff --git a/platform-bible-utils/types/UsjContentLocation.html b/platform-bible-utils/types/UsjContentLocation.html index e3fe4abd5e..8a3c9fdbf6 100644 --- a/platform-bible-utils/types/UsjContentLocation.html +++ b/platform-bible-utils/types/UsjContentLocation.html @@ -1,2 +1,2 @@ UsjContentLocation | platform-bible-utils

    Type AliasUsjContentLocation

    UsjContentLocation: {
        jsonPath: ContentJsonPath;
        node: MarkerContent;
        offset: number;
    }

    Node within a USJ object, an offset within that node, and a JSONPath query to the node

    -
    +
    diff --git a/platform-bible-utils/types/VerseRefOffset.html b/platform-bible-utils/types/VerseRefOffset.html index 052732dc5f..495c641824 100644 --- a/platform-bible-utils/types/VerseRefOffset.html +++ b/platform-bible-utils/types/VerseRefOffset.html @@ -1,2 +1,2 @@ VerseRefOffset | platform-bible-utils

    Type AliasVerseRefOffset

    VerseRefOffset: {
        offset: number;
        verseRef: VerseRef;
    }

    Represents a book, chapter, verse, and offset

    -
    +
    diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index 4669499e48..b3b0092f17 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

    Type declaration

    • contextMenu: SingleColumnMenu | undefined

      Menu that opens when you right click on the main body/area of a tab

    • includeDefaults: boolean | undefined

      Indicates whether the platform default menus should be included for this webview

    • topMenu: MultiColumnMenu | undefined

      Menu that opens when you click on the top left corner of a tab

      -
    +
    diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index a35ac1058e..b883fec713 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

    Type AliasWebViewMenus

    WebViewMenus: {
        [property: ReferencedItem]: WebViewMenu;
    }

    Menus for all web views

    Type declaration

    +
    diff --git a/platform-bible-utils/variables/CHAPTER_TYPE.html b/platform-bible-utils/variables/CHAPTER_TYPE.html index 8cbfab5ad7..a829524305 100644 --- a/platform-bible-utils/variables/CHAPTER_TYPE.html +++ b/platform-bible-utils/variables/CHAPTER_TYPE.html @@ -1,2 +1,2 @@ CHAPTER_TYPE | platform-bible-utils

    VariableCHAPTER_TYPEConst

    CHAPTER_TYPE: "chapter" = 'chapter'

    USJ content node type for a chapter

    -
    +
    diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index b9226ad6de..f118f4b947 100644 --- a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html @@ -1 +1 @@ -FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1
    +FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1
    diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index 9e630b4f5e..db4fd6a901 100644 --- a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html @@ -1 +1 @@ -FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1
    +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1
    diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index 205835b132..b43cdc492f 100644 --- a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html @@ -1 +1 @@ -FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1
    +FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1
    diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index 8a68e2c026..a29207703c 100644 --- a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html @@ -1 +1 @@ -LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...
    +LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...
    diff --git a/platform-bible-utils/variables/VERSE_TYPE.html b/platform-bible-utils/variables/VERSE_TYPE.html index 73e32bade8..1731e9ba1d 100644 --- a/platform-bible-utils/variables/VERSE_TYPE.html +++ b/platform-bible-utils/variables/VERSE_TYPE.html @@ -1,2 +1,2 @@ VERSE_TYPE | platform-bible-utils

    VariableVERSE_TYPEConst

    VERSE_TYPE: "verse" = 'verse'

    USJ content node type for a verse

    -
    +
    diff --git a/platform-bible-utils/variables/defaultScrRef.html b/platform-bible-utils/variables/defaultScrRef.html index c9e86d4cba..d097a02e19 100644 --- a/platform-bible-utils/variables/defaultScrRef.html +++ b/platform-bible-utils/variables/defaultScrRef.html @@ -1 +1 @@ -defaultScrRef | platform-bible-utils
    +defaultScrRef | platform-bible-utils
    diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index 6f6e1591cd..d41c222383 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

    VariablelocalizedStringsDocumentSchemaConst

    localizedStringsDocumentSchema: {
        $defs: {
            languageStrings: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            localizedStringValue: {
                description: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            stringMetadata: {
                description: string;
                properties: {
                    fallbackKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    };
                    notes: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            stringsMetadata: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        description: string;
        properties: {
            localizedStrings: {
                additionalProperties: {
                    $ref: string;
                };
                type: string;
            };
            metadata: {
                $ref: string;
            };
        };
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the LocalizedStringDataContribution type

    -
    +
    diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index 69300ac522..c654e4a208 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

    VariablemenuDocumentSchemaConst

    menuDocumentSchema: {
        $defs: {
            columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                type: string;
            };
            menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            };
            menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            };
            menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            };
            multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
            referencedItem: {
                description: string;
                pattern: string;
                type: string;
            };
            singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
        };
        additionalProperties: boolean;
        properties: {
            defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            };
            defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            };
            mainMenu: {
                $ref: string;
                description: string;
            };
            webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        required: string[];
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the PlatformMenus type

    -
    +
    diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 00544469bf..b015961281 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

    VariableprojectSettingsDocumentSchemaConst

    projectSettingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the ProjectSettingsContribution type

    -
    +
    diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 00354f08f5..54e455fff2 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

    VariablesettingsDocumentSchemaConst

    settingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the SettingsContribution type

    -
    +