From f9a64487cdd91f10984e960c4ccf9a496ce37688 Mon Sep 17 00:00:00 2001 From: irahopkinson Date: Tue, 3 Sep 2024 22:40:08 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@f6f2c1ff4e8230aedba2fb1c0eadd6c4e8fe5dd3=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...nt_network_connector_service_.default.html | 52 +++++++------- ...er_network_connector_service_.default.html | 70 +++++++++---------- ...execution_token_model_.ExecutionToken.html | 4 +- ..._renderer_web_socket_service_.default.html | 4 +- ...rer_xml_http_request_service_.default.html | 4 +- .../_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 +- ...t_settings_document_combiner_.default.html | 28 ++++---- ...tings_document_combiner_base_.default.html | 26 +++---- ...s_node_file_system_service_.EntryType.html | 4 +- ...al_connection_model_.ConnectionStatus.html | 8 +-- ..._network_connector_model_.MessageType.html | 4 +- ...shared_global_this_model_.ProcessType.html | 4 +- ...vileges_model_.ElevatedPrivilegeNames.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 +-- ...shared_utils_util_.RequestHandlerType.html | 4 +- papi-dts/functions/__papi_backend_.fetch.html | 4 +- .../functions/__papi_frontend_.fetch.html | 4 +- ...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 +- ...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 +- ...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 +- ..._services_command_service_.initialize.html | 2 +- ...ices_command_service_.registerCommand.html | 2 +- ...services_command_service_.sendCommand.html | 2 +- ..._services_connection_service_.connect.html | 2 +- ...rvices_connection_service_.disconnect.html | 2 +- ...onnection_service_.emitEventOnNetwork.html | 2 +- ...vices_connection_service_.getClientId.html | 2 +- ..._services_connection_service_.request.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ector_factory_.createNetworkConnector.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 +- ...s_network_service_.onDidClientConnect.html | 2 +- ...etwork_service_.onDidClientDisconnect.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 +- ...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 +- ...ared_utils_util_.createSafeRegisterFn.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 | 4 +- .../_papi_shared_types_.DataProviders.html | 4 +- ..._types_.ProjectDataProviderInterfaces.html | 4 +- ...api_shared_types_.ProjectSettingTypes.html | 10 +-- .../_papi_shared_types_.SettingTypes.html | 10 +-- ..._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 +-- ...ider_model_.DisposableWebViewProvider.html | 8 +-- ...view_provider_model_.IWebViewProvider.html | 8 +-- ..._view_provider_model_.WebViewProvider.html | 8 +-- ...provider_service_.DataProviderService.html | 12 ++-- ...s_dialog_service_model_.DialogService.html | 6 +- ...ces_internet_service_.InternetService.html | 4 +- ..._network_connector_interface_.default.html | 16 ++--- ..._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 | 4 +- ...vider_service_.WebViewProviderService.html | 10 +-- ...iew_service_model_.WebViewServiceType.html | 10 +-- 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 +- ...ces_client_network_connector_service_.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 +- ...ces_server_network_connector_service_.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 +- ...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 +- ...hared_data_internal_connection_model_.html | 2 +- ..._shared_data_network_connector_model_.html | 2 +- .../modules/_shared_data_platform_data_.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_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- .../_shared_services_connection_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 +- ...d_services_network_connector_factory_.html | 2 +- ...services_network_connector_interface_.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_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 +- ...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 +- ...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 +- ..._connection_model_.ClientConnectEvent.html | 2 +- ...nnection_model_.ClientDisconnectEvent.html | 2 +- ...ernal_connection_model_.InternalEvent.html | 2 +- ...on_model_.InternalNetworkEventHandler.html | 2 +- ...nal_connection_model_.InternalRequest.html | 2 +- ...nection_model_.InternalRequestHandler.html | 2 +- ...al_connection_model_.InternalResponse.html | 2 +- ..._model_.NetworkConnectorEventHandlers.html | 2 +- ...onnection_model_.NetworkConnectorInfo.html | 2 +- ...connection_model_.NetworkEventHandler.html | 2 +- ...rnal_connection_model_.RequestHandler.html | 2 +- ...ernal_connection_model_.RequestRouter.html | 2 +- ...etwork_connector_model_.ClientConnect.html | 2 +- ...a_network_connector_model_.InitClient.html | 2 +- ...data_network_connector_model_.Message.html | 2 +- ...twork_connector_model_.WebSocketEvent.html | 2 +- ...ork_connector_model_.WebSocketRequest.html | 2 +- ...rk_connector_model_.WebSocketResponse.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 +- ...s_network_service_.ArgsRequestHandler.html | 2 +- ...etwork_service_.ComplexRequestHandler.html | 2 +- ...twork_service_.ContentsRequestHandler.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 +- ...b_view_service_model_.AddWebViewEvent.html | 2 +- ...iew_service_model_.UpdateWebViewEvent.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_.ComplexRequest.html | 2 +- .../_shared_utils_util_.ComplexResponse.html | 2 +- ...ed_utils_util_.ComplexResponseFailure.html | 2 +- ...ed_utils_util_.ComplexResponseSuccess.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 +- .../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 +- ...al_connection_model_.CATEGORY_COMMAND.html | 2 +- ...al_connection_model_.CLIENT_ID_SERVER.html | 2 +- ...onnection_model_.CLIENT_ID_UNASSIGNED.html | 2 +- ...l_connection_model_.CLIENT_ID_UNKNOWN.html | 2 +- ...on_model_.CONNECTOR_INFO_DISCONNECTED.html | 2 +- ...nnector_model_.WEBSOCKET_ATTEMPTS_MAX.html | 2 +- ...nector_model_.WEBSOCKET_ATTEMPTS_WAIT.html | 2 +- ...twork_connector_model_.WEBSOCKET_PORT.html | 2 +- ...orm_data_.DEV_MODE_RENDERER_INDICATOR.html | 2 +- ...ata_platform_data_.PLATFORM_NAMESPACE.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 +- ...el_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html | 2 +- ....NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.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 +- .../enums/DropdownMenuItemType.html | 4 +- platform-bible-react/enums/LabelPosition.html | 4 +- platform-bible-react/functions/Alert.html | 2 +- .../functions/AlertDescription.html | 2 +- .../functions/AlertTitle.html | 2 +- .../functions/BookChapterControl.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 +- .../functions/ContextMenu.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/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 +- .../functions/ShadCnSlider.html | 2 +- .../functions/ShadCnSwitch.html | 2 +- platform-bible-react/functions/Slider.html | 2 +- platform-bible-react/functions/Snackbar.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 +- 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 +- .../functions/getSortingIcon.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 +- platform-bible-react/types/AnchorOrigin.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- platform-bible-react/types/CheckboxProps.html | 2 +- .../types/ChecklistProps.html | 2 +- platform-bible-react/types/CloseReason.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/InventoryLocalizedStrings.html | 2 +- platform-bible-react/types/ItemData.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/SliderProps.html | 2 +- .../types/SnackbarContentProps.html | 2 +- platform-bible-react/types/SnackbarProps.html | 2 +- platform-bible-react/types/SortDirection.html | 2 +- platform-bible-react/types/SpinnerProps.html | 2 +- platform-bible-react/types/Status.html | 2 +- platform-bible-react/types/SwitchProps.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/INVENTORY_STRING_KEYS.html | 2 +- .../classes/AsyncVariable.html | 14 ++-- 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 | 22 +++--- .../classes/UnsubscriberAsyncList.html | 8 +-- .../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 +- .../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/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 +- platform-bible-utils/types/WebViewMenu.html | 2 +- platform-bible-utils/types/WebViewMenus.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 +- .../localizedStringsDocumentSchema.html | 2 +- .../variables/menuDocumentSchema.html | 2 +- .../projectSettingsDocumentSchema.html | 2 +- .../variables/settingsDocumentSchema.html | 2 +- 811 files changed, 1124 insertions(+), 1124 deletions(-) diff --git a/papi-dts/classes/_client_services_client_network_connector_service_.default.html b/papi-dts/classes/_client_services_client_network_connector_service_.default.html index 01cbeb6c79..2bd7ded6d0 100644 --- a/papi-dts/classes/_client_services_client_network_connector_service_.default.html +++ b/papi-dts/classes/_client_services_client_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Handles the connection from the client to the server

-

Implements

Constructors

Implements

Constructors

Properties

clientGuid: any

Unique Guid associated with this connection. Used to verify certain things with server

-
connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
    clientId: number;
}>>)

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

  • On Client: connecting to the server.
  • @@ -34,59 +34,59 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-
connectPromise?: any

Promise that resolves when the connection is finished or rejects if disconnected before the +

connectPromise?: any

Promise that resolves when the connection is finished or rejects if disconnected before the connection finishes

-
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

-
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

+
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

  • On Client: disconnects from the server
  • On Server: disconnects from clients and closes its connection endpoint
-

Type declaration

    • (): void
    • Returns void

emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

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

Type declaration

    • (): void
    • Returns void

emitEventOnNetwork: (<T>(eventType, event) => 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 declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

Type declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect()

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. +

handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. Runs the requestHandler provided in connect() and sends a message with the response

Param: requestMessage

Request message to handle

Param: isIncoming

Whether this message is coming from the server and we should definitely handle it locally or if it is a locally sent request and we should send to the server if we don't have a local handler

-
handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with +

handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with the received response message

Param: response

Response message to resolve

-
localEventHandler?: any

Function to call when we receive an event. Handles events from the connection by emitting the +

localEventHandler?: any

Function to call when we receive an event. Handles events from the connection by emitting the event locally

-
localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles +

localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles requests from the connection and returns a response to send back

-
messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific +

messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

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

Notify the server that this client has received its connectorInfo and is ready to go.

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

Notify the server that this client has received its connectorInfo and is ready to go.

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onMessage: any

Receives and appropriately publishes server webSocket messages

+

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onMessage: any

Receives and appropriately publishes server webSocket messages

Param: event

WebSocket message information

Param: fromSelf

Whether this message is from this connector instead of from someone else

-
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

+
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request +

requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

Send a message to the server via webSocket. Throws if not connected

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

Send a message to the server via webSocket. Throws if not connected

Param: message

Message to send

-
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

+
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

Unsubscriber function to run to stop calling the passed-in function on webSocket messages

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

-
webSocket?: any

The webSocket connected to the server

-
\ No newline at end of file +
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

+
webSocket?: any

The webSocket connected to the server

+
\ No newline at end of file diff --git a/papi-dts/classes/_main_services_server_network_connector_service_.default.html b/papi-dts/classes/_main_services_server_network_connector_service_.default.html index a6f5ea02a6..6e53408a49 100644 --- a/papi-dts/classes/_main_services_server_network_connector_service_.default.html +++ b/papi-dts/classes/_main_services_server_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Handles the endpoint and connections from the server to the clients

-

Implements

Constructors

Implements

Constructors

Properties

clientSockets: any

The webSocket clients that are connected and information about them

-
connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
    clientId: number;
}>>)

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

  • On Client: connecting to the server.
  • @@ -43,77 +43,77 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-
connectPromise?: any

Promise that resolves when finished starting the server or rejects if disconnected before the +

connectPromise?: any

Promise that resolves when finished starting the server or rejects if disconnected before the server finishes

-
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

-
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

+
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

  • On Client: disconnects from the server
  • On Server: disconnects from clients and closes its connection endpoint
-

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

-
emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

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

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

+
emitEventOnNetwork: (<T>(eventType, event) => 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 declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

getClientIdFromSocket: any

Get the clientId for a certain webSocket. Throws if not found

-
getClientSocket: any

Get the client socket for a certain clientId. Throws if not found

-
getClientSocketFromGuid: any

Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. +

Type declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

getClientIdFromSocket: any

Get the clientId for a certain webSocket. Throws if not found

+
getClientSocket: any

Get the client socket for a certain clientId. Throws if not found

+
getClientSocketFromGuid: any

Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. This does not throw because it will likely be very common that we do not have a clientId for a certain clientGuid as connecting clients will often supply old clientGuids.

-
handleClientConnectMessage: any

Function that handles webSocket messages of type ClientConnect. Mark the connection fully +

handleClientConnectMessage: any

Function that handles webSocket messages of type ClientConnect. Mark the connection fully connected and notify that a client connected or reconnected

Param: clientConnect

Message from the client about the connection

Param: connectorId

ClientId of the client who is sending this ClientConnect message

-
handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect() and forwards the event to other clients

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. +

handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. Handles the request and sends a response if we have a handler or forwards to the appropriate client

Param: requestMessage

Request to handle

Param: requesterId

Who sent this message

-
handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with +

handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with the received response message or forwards to appropriate client

Param: response

Response message to resolve

Param: responderId

Responding client

-
localEventHandler?: any

Function to call when we receive an event. Handles events from connections and emits the event +

localEventHandler?: any

Function to call when we receive an event. Handles events from connections and emits the event locally

-
localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles +

localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles requests from connections and returns a response to send back

-
messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific +

messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

-
networkConnectorEventHandlers?: any

Functions to run when network connector events occur like when clients are disconnected

-
nextClientId: any

The next client id to use for a new connection. Starts at 1 because the server is 0

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

Notify the server that this client has received its connectorInfo and is ready to go.

+
networkConnectorEventHandlers?: any

Functions to run when network connector events occur like when clients are disconnected

+
nextClientId: any

The next client id to use for a new connection. Starts at 1 because the server is 0

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

Notify the server that this client has received its connectorInfo and is ready to go.

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onClientConnect: any

Registers an incoming webSocket connection and sends connection info with InitClient. Does not +

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onClientConnect: any

Registers an incoming webSocket connection and sends connection info with InitClient. Does not consider the client fully connected yet until they respond and tell us they connected with ClientConnect

-
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

-
onMessage: any

Receives and appropriately publishes webSocket messages

+
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

+
onMessage: any

Receives and appropriately publishes webSocket messages

Param: event

WebSocket message information

Param: fromSelf

Whether this message is from this connector instead of from someone else

-
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

+
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request +

requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

Send a message to a client via webSocket. Throws if not connected

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

Send a message to a client via webSocket. Throws if not connected

Param: message

Message to send

Param: recipientId

The client to which to send the message. TODO: determine if we can intuit this instead

-
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

+
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

Unsubscriber function to run to stop calling the passed-in function on webSocket messages

-
unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

-
webSocketServer?: any

The webSocket connected to the server

-
\ No newline at end of file +
unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

+
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

+
webSocketServer?: any

The webSocket connected to the server

+
\ No newline at end of file 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 8d43295285..6161fff5ee 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,7 +1,7 @@ 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
nonce: string
type: "extension"

Methods

\ No newline at end of file +

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

\ No newline at end of file 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 f30a69912f..d871b56ccc 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

Constructors

Properties

CLOSED: 3
CLOSING: 2
CONNECTING: 0
OPEN: 1
addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

binaryType: BinaryType
bufferedAmount: number
close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void
    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

extensions: string
onclose: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol: string
readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string
\ No newline at end of file +

Constructors

Properties

CLOSED: 3
CLOSING: 2
CONNECTING: 0
OPEN: 1
addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

binaryType: BinaryType
bufferedAmount: number
close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void
    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

extensions: string
onclose: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol: string
readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string
\ No newline at end of file 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 9d3d0440ab..5c71b1d4da 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

DONE: 4
HEADERS_RECEIVED: 2
LOADING: 3
OPENED: 1
UNSENT: 0
abort: (() => void)

Type declaration

    • (): void
    • Returns void

addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

getResponseHeader: ((name) => null | string)

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

onabort: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open: ((method, url, async?, username?, password?) => void)

Type declaration

    • (method, url, async?, username?, password?): void
    • Parameters

      • method: string
      • url: string
      • Optional async: boolean
      • Optional username: null | string
      • Optional password: null | string

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

response: any
responseText: string
responseType: XMLHttpRequestResponseType
responseURL: string
responseXML: null | Document
send: ((body?) => void)

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

status: number
statusText: string
timeout: number
upload: XMLHttpRequestUpload
withCredentials: boolean
\ No newline at end of file +

Constructors

Properties

DONE: 4
HEADERS_RECEIVED: 2
LOADING: 3
OPENED: 1
UNSENT: 0
abort: (() => void)

Type declaration

    • (): void
    • Returns void

addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

getResponseHeader: ((name) => null | string)

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

onabort: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open: ((method, url, async?, username?, password?) => void)

Type declaration

    • (method, url, async?, username?, password?): void
    • Parameters

      • method: string
      • url: string
      • Optional async: boolean
      • Optional username: null | string
      • Optional password: null | string

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

response: any
responseText: string
responseType: XMLHttpRequestResponseType
responseURL: string
responseXML: null | Document
send: ((body?) => void)

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

status: number
statusText: string
timeout: number
upload: XMLHttpRequestUpload
withCredentials: boolean
\ No newline at end of file diff --git a/papi-dts/classes/_shared_log_error_model_.default.html b/papi-dts/classes/_shared_log_error_model_.default.html index 8d6101af64..66e71da276 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, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

Properties

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stack?: string
stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file 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 8386b6e696..dfe0cbe2be 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 @@ -6,6 +6,6 @@
this.notifyUpdate('Setting');
 

See

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

Type Parameters

Hierarchy (view full)

Constructors

Methods

Constructors

Methods

\ No newline at end of file +

Constructors

Methods

\ No newline at end of file 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 f154b9aa30..6d3e39fce7 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,6 +2,6 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

See

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

\ No newline at end of file +

Constructors

Methods

\ No newline at end of file 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 767dc9aead..914adeacec 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 networkDisposer @@ -21,22 +21,22 @@

Constructors

Properties

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

Type declaration

    • (): Promise<boolean>
    • Returns Promise<boolean>

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

Callback that runs when the emitter is disposed - should handle unlinking from the network

-
networkSubscriber: any

Callback that sends the event to other processes on the network when it is emitted

-
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+
    • (): void
    • Returns void

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

Properties

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

Type declaration

    • (): Promise<boolean>
    • Returns Promise<boolean>

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

Callback that runs when the emitter is disposed - should handle unlinking from the network

+
networkSubscriber: any

Callback that sends the event to other processes on the network when it is emitted

+
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Param: callback

Function to run with the event when it is emitted

Returns

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

Alias

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

\ No newline at end of file +

Returns void

\ No newline at end of file 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 6111d86cdf..c0828126b1 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 @@ -32,13 +32,13 @@

  • 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.

    Example

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

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

    -

    Methods

    Methods

    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    \ No newline at end of file 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 59c1277abd..c0563c0f18 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 @@ -6,6 +6,6 @@
    this.notifyUpdate('Setting');
     

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    Type Parameters

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file 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 2788220d55..7678613f80 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.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.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,16 +66,16 @@ 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 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

    \ No newline at end of file +
    \ No newline at end of file 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 e6fc082fcd..6f5e58bdbe 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
    localizedOutputPromise: any

    Cached promise for getting the localized output

    -
    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
    localizedOutputPromise: any

    Cached promise for getting the localized output

    +
    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 @@ -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 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.

      @@ -49,16 +49,16 @@ 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.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.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

      -
    • Parameters

      • baseDocument: JsonDocumentLike

      Returns JsonDocumentLike

    • Parameters

      • documentName: string
      • document: JsonDocumentLike

      Returns JsonDocumentLike

    • Transform the document that is the composition of the base document and all contribution +

    • Parameters

      • baseDocument: JsonDocumentLike

      Returns JsonDocumentLike

    • Parameters

      • documentName: string
      • document: JsonDocumentLike

      Returns JsonDocumentLike

    • 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

    \ No newline at end of file +
    \ No newline at end of file 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 e73af36cab..7179b15580 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: "directory"
    File: "file"
    Unknown: "unknown"
    \ No newline at end of file +

    Enumeration Members

    Directory: "directory"
    File: "file"
    Unknown: "unknown"
    \ No newline at end of file diff --git a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html index 369f8caf42..99000e6cc1 100644 --- a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

    Whether this connector 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: 2

    This connector has finished setting up its connection - has connectorInfo and such

    -
    Connecting: 1

    This connector is attempting to connect to the network and retrieve connectorInfo

    -
    Disconnected: 0

    This connector is not connected to the network

    -
    \ No newline at end of file +
    Connecting: 1

    This connector is attempting to connect to the network and retrieve connectorInfo

    +
    Disconnected: 0

    This connector is not connected to the network

    +
    \ No newline at end of file diff --git a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html index 4be168190d..168add43a2 100644 --- a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html +++ b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html @@ -1,7 +1,7 @@ MessageType | papi-dts

    WebSocket message type that indicates how to handle it

    -

    Enumeration Members

    Enumeration Members

    ClientConnect: "client-connect"
    Event: "event"
    InitClient: "init-client"
    Request: "request"
    Response: "response"
    \ No newline at end of file +

    Enumeration Members

    ClientConnect: "client-connect"
    Event: "event"
    InitClient: "init-client"
    Request: "request"
    Response: "response"
    \ No newline at end of file diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index 07841801de..762a6b15df 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: "extension-host"
    Main: "main"
    Renderer: "renderer"
    \ No newline at end of file +

    Enumeration Members

    ExtensionHost: "extension-host"
    Main: "main"
    Renderer: "renderer"
    \ No newline at end of file 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 1ac0fdf9ac..d1deeaa9f4 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: "createProcess"
    manageExtensions: "manageExtensions"
    \ No newline at end of file +

    Enumeration Members

    createProcess: "createProcess"
    manageExtensions: "manageExtensions"
    \ No newline at end of file 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 41a583abab..62014c72df 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: "html"

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

    -
    React: "react"

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

    React: "react"

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

    -
    URL: "url"

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

    URL: "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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html index 2f498c3f70..0cfe637d3c 100644 --- a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html +++ b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html @@ -1,5 +1,5 @@ RequestHandlerType | papi-dts

    Enumeration RequestHandlerType

    Type of request handler - indicates what type of parameters and what return type the handler has

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Args: "args"
    Complex: "complex"
    Contents: "contents"
    \ No newline at end of file +

    Enumeration Members

    Args: "args"
    Complex: "complex"
    Contents: "contents"
    \ No newline at end of file diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index 10f56054e0..fa201c718b 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
      • Optional init: RequestInit

      Returns Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: string | Request | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • \ No newline at end of file diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index 8edb641471..3ae0dc78ed 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
      • Optional init: RequestInit

      Returns Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: string | Request | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • \ No newline at end of file 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 d3727aeacc..6e2a1faaab 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 427bfa138a..2eaddde854 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

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file 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 2f4e497684..5125c34cad 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

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file 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 55cc8ac706..fccfe5bc1a 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 @@
  • Optional mode: number

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

    -
  • Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file 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 adbfd49ee5..2d8b2ad7f6 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 25b0b42ef5..d443539e87 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 5d97386f40..a5a7f537e1 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 6557ad8b39..e8d7f7b89a 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 d46089b6b8..0f146f42fa 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>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file 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 91d5fa2a1b..4b18e1d928 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 40a59b7272..f16c47f99b 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

      -
    \ No newline at end of file +
    \ No newline at end of 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 f9eeeb9c94..0db1065700 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

      -
    \ No newline at end of file +
    \ No newline at end of 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 0577f97c76..036508d607 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 644039976a..29ff385c83 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index c453a008d1..3e97139a47 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
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index 629dc5189c..e0cdb56dda 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
    \ No newline at end of file +createUuid | papi-dts
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index c81e361f8d..9c0fc8309e 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)

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index 4d66f0e6df..c4de6b1e12 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

      -

      Parameters

      • this: unknown
      • Rest ...args: []

      Returns string

    Properties

    Parameters

    • this: unknown
    • Rest ...args: []

    Returns string

    Properties

    Properties

    clear: (() => void)

    Type declaration

      • (): void
      • Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 2093625072..1f1e2b8702 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index 1e4a13fd5f..c9d92ae4e6 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

    Function isNoisyDevModeEnvVariableSet

    • Determines if running in noisy dev mode

      Returns boolean

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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index ab1932bd45..0511c5c885 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index 80bf4a67bd..f5a8eb870b 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts
    \ No newline at end of file +resolveHtmlPath | papi-dts
    \ No newline at end of file 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 749269e2aa..593b6499f7 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

    \ No newline at end of file +

    Returns void

    \ No newline at end of file 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 d9ee47531a..dc7f9a9244 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 e151ca07b6..973dad56b4 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) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -
    \ No newline at end of file +
    \ No newline at end of file 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 cabf8455c8..5f94176e65 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 @@ -29,4 +29,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    \ No newline at end of file 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 1404511532..3c40a5b014 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 4e84c76e26..2f2c8efe57 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 de12886936..7ac8cdda36 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
  • -
    \ No newline at end of file +
    \ No newline at end of file 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 15bc86ae11..5be1e9ec8b 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
  • -
    \ No newline at end of file +
    \ No newline at end of file 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 fb46d3c3fe..3b7726728d 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 @@ -37,4 +37,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectInterfaceDataTypes[ProjectInterface][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectInterfaceDataTypes[ProjectInterface]>>), boolean])
    }

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectInterfaceDataTypes[ProjectInterface][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectInterfaceDataTypes[ProjectInterface]>>), boolean])
    }

    \ No newline at end of file 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 9eaf20f834..bf0f128ec8 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 db2aa95fbe..9794285d76 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 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -
    \ No newline at end of file +
    \ No newline at end of file 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 8e8cc3242a..ede4187a8e 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
  • -
    \ No newline at end of file +
    \ No newline at end of file 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 c582894ec5..617ec3ccec 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 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -
    \ No newline at end of file +
    \ No newline at end of file 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 38edce5123..6155662953 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

      -

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file 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 147bb0cc9b..8188886d51 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

      • Optional scrollGroupId: number

      Returns ScriptureReference

    \ No newline at end of file +

    Parameters

    Returns ScriptureReference

    \ No newline at end of file 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 c4b7bd8666..d675dec3ae 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

      -

      Parameters

      Returns Unsubscriber

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ No newline at end of file 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 34aa089e8e..1bf8540001 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

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file 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 da9febddc7..8d72ab4793 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>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file 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 b511fef54e..d1503e8315 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
    \ No newline at end of file +
    \ No newline at end of file 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 16ff81b038..91b69346db 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 1edcff57b5..bc7b72b70c 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 b59c57c777..464ea13605 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 368a684aee..11bb852058 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 9b1f77a4fb..6222405a1f 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[]>

    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadata[]>

    \ No newline at end of file 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 af2bfd3f6d..575d3a6301 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

      • Optional projectId: string
      • Optional projectInterface: keyof ProjectDataProviderInterfaces
      • Optional pdpFactoryId: string

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

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    \ No newline at end of file +transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

      • Optional projectId: string
      • Optional projectInterface: keyof ProjectDataProviderInterfaces
      • Optional pdpFactoryId: string

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

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index 4efbd07b8d..68cfc85929 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 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>)

    Function to call with arguments of command that sends the command and resolves with the result of the command

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.initialize.html b/papi-dts/functions/_shared_services_command_service_.initialize.html index 856369fa03..05e23d21d5 100644 --- a/papi-dts/functions/_shared_services_command_service_.initialize.html +++ b/papi-dts/functions/_shared_services_command_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts
    • Sets up the CommandService. Only runs once and always returns the same promise after that

      -

      Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index a0d4144e42..68c9bafa05 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -6,4 +6,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

  • Returns Promise<UnsubscriberAsync>

    True if successfully registered, throws with error message if not

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index 292f2381ff..9b2c09b245 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
    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.connect.html b/papi-dts/functions/_shared_services_connection_service_.connect.html index 92ecb2123f..29dcdbe99a 100644 --- a/papi-dts/functions/_shared_services_connection_service_.connect.html +++ b/papi-dts/functions/_shared_services_connection_service_.connect.html @@ -8,4 +8,4 @@
  • connectorEventHandlers: NetworkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

  • Returns Promise<void>

    Promise that resolves when finished connecting

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.disconnect.html b/papi-dts/functions/_shared_services_connection_service_.disconnect.html index 61eed25656..3c2c171b0b 100644 --- a/papi-dts/functions/_shared_services_connection_service_.disconnect.html +++ b/papi-dts/functions/_shared_services_connection_service_.disconnect.html @@ -1,2 +1,2 @@ disconnect | papi-dts
    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html index 0329e33fda..eac8b68cbd 100644 --- a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html +++ b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html @@ -2,4 +2,4 @@ run by NetworkEventEmitter after sending on network.

    Type Parameters

    Parameters

    Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.getClientId.html b/papi-dts/functions/_shared_services_connection_service_.getClientId.html index 9c0b17254d..3298721244 100644 --- a/papi-dts/functions/_shared_services_connection_service_.getClientId.html +++ b/papi-dts/functions/_shared_services_connection_service_.getClientId.html @@ -1,2 +1,2 @@ getClientId | papi-dts
    \ No newline at end of file +

    Returns number

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.request.html b/papi-dts/functions/_shared_services_connection_service_.request.html index 3700d48365..472e9288bd 100644 --- a/papi-dts/functions/_shared_services_connection_service_.request.html +++ b/papi-dts/functions/_shared_services_connection_service_.request.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Promise that resolves with the response message

    -
    \ No newline at end of file +
    \ No newline at end of file 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 aab39bb972..440950d08f 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 53565de7f4..4da80fe6ce 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 60eff4389e..167b20b4b9 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

  • Optional tag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html index eb1b6635e6..7e0e784561 100644 --- a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html +++ b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html @@ -1,3 +1,3 @@ createNetworkConnector | papi-dts
    \ No newline at end of file +
    \ No newline at end of file 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 7c93515ff2..5065b01c3f 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.

      -

      Parameters

      Returns Unsubscriber

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ No newline at end of file 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 78d90a7998..5307d209db 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

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ No newline at end of file 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 1eb7524199..c5c5d0648e 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

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index e871212e7a..0b85a70e4a 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -5,4 +5,4 @@

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

    Type Parameters

    Parameters

    Returns PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 256fd7e83a..463ea33ef2 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 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<TReturn>)

    Function to call with arguments of request that performs the request and resolves with the response contents

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index 8252a982e3..51c9c46506 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index 43f118b89b..c967002a15 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts
    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html index fdbb5ca892..e191997800 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html @@ -1,2 +1,2 @@ onDidClientConnect | papi-dts
    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html index 2fbe8581ad..ca1986b6c0 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html @@ -1,2 +1,2 @@ onDidClientDisconnect | papi-dts
    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index c03e8db4ad..fe2f1f3f70 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -5,4 +5,4 @@ type the handler has

    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

    -
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • \ No newline at end of file +
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 9f09d61378..2349ced0d5 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 @@

    Type Parameters

    Parameters

    Returns Promise<TReturn>

    Promise that resolves with the response message

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 89c680ed8d..8c74910f37 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
    \ No newline at end of file +

    Returns void

    \ No newline at end of file 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 542d16e54f..9db5336a92 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 @@ -12,4 +12,4 @@

    Throws

    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)

    -
    \ No newline at end of file +
    \ No newline at end of file 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 3d3c57563d..40896b6a5e 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 ae7afb2ae0..a99e21afa8 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index a5c9ba962b..75acdb4404 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
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index f328824e4b..305004396e 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.

      Returns boolean

      Returns true if running on a client, false otherwise

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index 7f49e4eeda..7c4a7339b4 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index 08c27835e5..b99085e8b7 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index 55590f6c3f..c9bbe32aa1 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)

      Returns boolean

      Returns true if running on the server, false otherwise

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html b/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html index 5f0c7ded1e..48f427148e 100644 --- a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html +++ b/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html @@ -6,4 +6,4 @@
  • initialize: (() => Promise<void>)

    Promise that resolves when the service is finished initializing

  • Returns ((...args) => Promise<UnsubscriberAsync>)

    Safe version of an unsafe function that returns a promise to an UnsubscriberAsync (meaning it will wait to register until the service is initialized)

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index 5d95070275..1365b86959 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
    \ No newline at end of file +

    Parameters

    Returns RequestType

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index 0dbea7518e..3e244b106f 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index b8a6e62a5a..5f463aa456 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

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 0077883e55..873ee93062 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index 666290c33d..7c7c2c9991 100644 --- a/papi-dts/functions/getSavedWebViewDefinition.html +++ b/papi-dts/functions/getSavedWebViewDefinition.html @@ -1,4 +1,4 @@ getSavedWebViewDefinition | papi-dts

    Function getSavedWebViewDefinition

    \ No newline at end of file +

    Returns undefined | SavedWebViewDefinition

    \ No newline at end of file diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index 719dc73202..c542fac70b 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    Function getSavedWebViewDefinitionById

    \ No newline at end of file +getSavedWebViewDefinitionById | papi-dts

    Function getSavedWebViewDefinitionById

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index 9bf6701ad2..b261793c12 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    Function getWebViewState

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • defaultValue: T

      Returns T

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index c66ff42cc8..b67495a9e9 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    Function resetWebViewState

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

      -

      Parameters

      • stateKey: string

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 1672c4277d..e95269c126 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 0ff40ce58d..c2259f0b20 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -6,4 +6,4 @@

    @example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Parameters

    Returns boolean

    \ No newline at end of file +

    Parameters

    Returns boolean

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 748856d4b6..42af43e8db 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    \ No newline at end of file +updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewScrollGroupScrRef.html b/papi-dts/functions/useWebViewScrollGroupScrRef.html index c8041d78aa..3c5902d575 100644 --- a/papi-dts/functions/useWebViewScrollGroupScrRef.html +++ b/papi-dts/functions/useWebViewScrollGroupScrRef.html @@ -15,4 +15,4 @@

    @example

    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -

    Returns [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: number, setScrollGroupId: ((newScrollGroupId) => void)]

    \ No newline at end of file +

    Returns [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: number, setScrollGroupId: ((newScrollGroupId) => void)]

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 21c1c8c3c9..f7c0f56ea6 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -24,4 +24,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    \ No newline at end of file diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index e0a66879f4..9a77df8078 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Function webViewComponent

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

      -

      Parameters

      Returns ReactNode

    Properties

    Parameters

    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 54a5fc9e24..9ba5faf399 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) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

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

    Properties

    activate: ((context) => 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().

    Returns

    Promise that resolves to true if successfully deactivated

    -
    \ No newline at end of file +
    \ No newline at end of file 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 b363bce790..1d3dc36060 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, key) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>);
        readUserData: ((token, key) => Promise<string>);
        writeUserData: ((token, key, data) => Promise<void>);
    }

    Properties

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

    Type declaration

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

        +
    readBinaryFileFromInstallDirectory: ((token, fileName) => 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, fileName) => Promise<string>)

    Type declaration

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

        +
    readTextFileFromInstallDirectory: ((token, fileName) => 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, key) => 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, key) => 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, key, data) => 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, key, data) => 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

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 356a21b38e..db0cb71e05 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -6,7 +6,7 @@ following to its .d.ts file:

    Example

    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) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

    interface CommandHandlers {
        platform.openProjectSettings: ((webViewId) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

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

    Type declaration

      • (webViewId): Promise<void>
      • Parameters

        • webViewId: string

        Returns Promise<void>

    platform.openUserSettings: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    \ No newline at end of file +

    Properties

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

    Type declaration

      • (webViewId): Promise<void>
      • Parameters

        • webViewId: string

        Returns Promise<void>

    platform.openUserSettings: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index 25d2021865..e012927216 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -10,6 +10,6 @@ 'helloSomeone.people' data provider types):

    Example

    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>;
    }
    \ No newline at end of file +

    Properties

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index 6be4a0f9a4..84a87a0d28 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -33,10 +33,10 @@ MyExtensionLayeringProjectInterface projectInterface):

    Example

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index 402ce68a5d..36b5285e0c 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,22 +9,22 @@ myExtension.highlightColor project setting):

    Example

    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

    platform.fullName: string

    Localized full name of the project. This will be displayed directly in the UI.

    Example

    '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.

    Example

    '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.

    Example

    'WEB'
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 3e0e8e06db..1b7a0514d5 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -8,17 +8,17 @@ myExtension.highlightColor setting):

    Example

    declare module 'papi-shared-types' {
    export interface SettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    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.

    -

    Type declaration

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

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

    Type declaration

    • [key: string]: string
    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.

    -

    Type declaration

    • [key: string]: string
    platform.verseRef: ScriptureReference

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

    Type declaration

    • [key: string]: string
    platform.verseRef: ScriptureReference

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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 e87386f198..08c2416633 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>
    \ No newline at end of file +

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    \ No newline at end of file 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 ce65918110..0d8ac39972 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: "float"
    \ No newline at end of file +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type: "float"
    \ No newline at end of file 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 1fe020196c..b4e1a0124a 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: "panel"
    \ No newline at end of file +

    Properties

    direction?: PanelDirection
    targetTabId?: string

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

    +
    type: "panel"
    \ No newline at end of file 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 d59e587610..34b5459691 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: "tab"
    \ No newline at end of file +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"
    \ No newline at end of file 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 13b34fef60..ac2cc93aef 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

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

    -
    \ No newline at end of file +
    \ No newline at end of file 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 5538bb2b2c..f79d1f17de 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, timeoutInMS?) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    Get details about all available network objects

    Type declaration

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

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

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

    +
    waitForNetworkObject: ((objectDetailsToMatch, timeoutInMS?) => 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

        • Optional timeoutInMS: number

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

        Returns Promise<NetworkObjectDetails>

    Returns

    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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 c8ccd0c30a..27bf961fb3 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): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?): 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[]>

    \ No newline at end of file +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    \ No newline at end of file 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 9520f6d5d9..fff31817d4 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?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId): Promise<string>;
    }

    Hierarchy

    Properties

    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId): 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).

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index 3b32c1013d..6bffaa27e6 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html @@ -1,10 +1,10 @@ DisposableWebViewProvider | papi-dts

    An object of this type is returned from networkObjectService.set.

    See

    networkObjectService

    -
    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): 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

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    \ No newline at end of file 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 9862ea7d9f..e680f92016 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 @@ -1,10 +1,10 @@ IWebViewProvider | papi-dts

    An object of this type is passed into networkObjectService.set.

    See

    networkObjectService

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    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

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html index aa1d5aa237..ad3c081473 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html @@ -5,11 +5,11 @@ 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.

    See

    networkObjectService

    -
    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): 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

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    \ No newline at end of file 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 f7c43ed2be..44b9e314c2 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): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => 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.

    See

    IDataProviderEngine for more information on extending this class.

    -
    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

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

    +
    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

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

    Type declaration

    • doNotNotify: {
          (method): void;
          (target, member): 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.

      @@ -36,13 +36,13 @@

      Example: Call this function signature on an object's method:

      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) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

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

    Get a data provider that has previously been set up

    Type declaration

    Returns

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

    -
    hasKnown: ((providerName) => boolean)

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

    hasKnown: ((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.

    -

    Type declaration

      • (providerName): boolean
      • Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>)

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

    Type declaration

      • (providerName): boolean
      • Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<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.

    Type declaration

    Returns

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 1bc2c700be..68d3b0936f 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?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    interface DialogService {
        selectProject(options?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index 1751430b00..d7ffd3853b 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, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
    }

    Properties

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

    Properties

    Properties

    fetch: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

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

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

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

        • input: string | Request | URL
        • Optional init: RequestInit

        Returns Promise<Response>

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

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

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html index ed306a571c..6fe3750f60 100644 --- a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html +++ b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html @@ -1,7 +1,7 @@ default | papi-dts

    Interface that defines the network connection functionality the server and the client must implement. Used by NetworkConnectorFactory to supply the right kind of NetworkConnector to ConnectionService

    -
    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

  • networkConnectorEventHandlers: NetworkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

  • Returns Promise<Readonly<{
        clientId: number;
    }>>

    Returns

    Promise that resolves with connector info 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

    -
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Disconnects from the connection:

    +
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Disconnects from the connection:

    • On Client: disconnects from the server
    • On Server: disconnects from clients and closes its connection endpoint
    -

    Type declaration

      • (): void
      • Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

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

    Type declaration

      • (): void
      • Returns void

    emitEventOnNetwork: (<T>(eventType, event) => 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 declaration

      • <T>(eventType, event): Promise<void>
      • Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

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

    Notify the server that this client has received its connectorInfo and is ready to go.

    +

    Returns Promise<void>

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

    Notify the server that this client has received its connectorInfo and is ready to go.

    MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

    TODO: Is this necessary?

    -

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    Send a request to the server/a client and resolve after receiving a response

    +

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    Send a request to the server/a client and resolve after receiving a response

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -
    \ No newline at end of file +
    \ No newline at end of file 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 f7805671c8..d636f20584 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, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    get: (<T>(id, createLocalObjectToProxy?) => 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, objectToShare, objectType?, objectAttributes?) => 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, objectToShare, objectType?, objectAttributes?) => 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.

        • Optional objectType: string
        • Optional objectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    \ No newline at end of file +
    \ No newline at end of file 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 dc0c1ce1d8..28ed349a6e 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, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts
    interface NetworkObjectService {
        get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => 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) => boolean)

    Type declaration

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

    hasKnown: ((id) => 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, objectToShare, objectType?, objectAttributes?) => 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, objectToShare, objectType?, objectAttributes?) => 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.

        • Optional objectType: string
        • Optional objectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 66ad620db2..b0c27c4dcc 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) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType) => PlatformEvent<T>);
        onDidClientConnect: PlatformEvent<ClientConnectEvent>;
        onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>;
    }

    Properties

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

    Properties

    createNetworkEventEmitter getNetworkEvent onDidClientConnect onDidClientDisconnect @@ -9,7 +9,7 @@

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

    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) => 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) => 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

        -
    onDidClientConnect: PlatformEvent<ClientConnectEvent>
    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>
    \ No newline at end of file +
    onDidClientConnect: PlatformEvent<ClientConnectEvent>
    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>
    \ No newline at end of file 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 bd3da8a506..97c749dd1f 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, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

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

    Properties

    get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => 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 @@ -14,11 +14,11 @@

          Throws

          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, projectInterfaces, pdpEngineFactory) => 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, projectInterfaces, pdpEngineFactory) => 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

        -
    \ No newline at end of file +
    \ No newline at end of file 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 7b04a98363..e9e7dcd3fa 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, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

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

    Properties

    Properties

    get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => 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 @@ -13,4 +13,4 @@

          Throws

          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)

          -
    \ No newline at end of file +
    \ No newline at end of file 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 a6956ad2cf..0f6caa099c 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): 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, newValue, currentValue, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key): 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, newValue, currentValue, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    Type Parameters

    Parameters

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

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

    Throws

    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

    • Optional allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -
    \ No newline at end of file +
    \ No newline at end of file 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 caf0ecfb50..0ba4164282 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?): Promise<ScriptureReference>;
        setScrRef(scrollGroupId, scrRef): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

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

    Hierarchy (view full)

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • Optional scrollGroupId: 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 f8a89e7de3..baf4ff6fed 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?): Promise<ScriptureReference>;
        setScrRef(scrollGroupId, scrRef): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?): Promise<ScriptureReference>;
        setScrRef(scrollGroupId, scrRef): 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

      • Optional scrollGroupId: 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 8783ff9e67..7ebdedfd86 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,8 +1,8 @@ -PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register +PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    Properties

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • 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<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -
    \ No newline at end of file +
    \ No newline at end of file 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 184166564b..1f7dbfbf5b 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,19 +1,19 @@ -WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get +WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get: ((webViewType) => Promise<WebViewProvider | undefined>)

    Type declaration

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

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<WebViewProvider | undefined>

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

        -
    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view +

    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view provider with the given type 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

        • webViewType: string

          Type of webView to check for

          -

        Returns boolean

    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>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

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

        +

    Returns boolean

    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>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • 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<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -
    \ No newline at end of file +
    \ No newline at end of file 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 7d0e9b2e54..50dc09207e 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, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<AddWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        getSavedWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>;
    }

    Properties

    interface WebViewServiceType {
        getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<AddWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        getSavedWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>;
    }

    Returns Promise<undefined | string>

    Returns

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

    Throws

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

    -
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    -

    Methods

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    +

    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 @@ -25,4 +25,4 @@

      Throws

      If something went wrong like the provider for the webViewType

      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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index c3cdb5b076..7e349d5162 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 DataProviderEngine LayeringProjectDataProviderEngineFactory ProjectDataProviderEngine diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index c69ec56547..368791f948 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 86f78ff8f6..ef8b4f8b51 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

    WebSocket XMLHttpRequest commands diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index bba27137de..31088386eb 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_client_network_connector_service_.html b/papi-dts/modules/_client_services_client_network_connector_service_.html index 9eebf1a64e..337374c0de 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

    Namespace "client/services/client-network-connector.service"

    Index

    Classes

    default +"client/services/client-network-connector.service" | papi-dts

    Namespace "client/services/client-network-connector.service"

    Index

    Classes

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index 33a9e8b99f..2817f6bfa6 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

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 5c92743c85..6f23541d00 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

    \ No newline at end of file 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 c1334653f7..cb3d2129a3 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

    \ No newline at end of file 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 9d02bba7cf..317583aeb3 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

    \ No newline at end of file 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 9182232849..0350cf53ea 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

    \ No newline at end of file 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 aa4bc93666..946c63652c 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

    \ No newline at end of file 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 3bcb4c49b9..cf31e405e4 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_server_network_connector_service_.html b/papi-dts/modules/_main_services_server_network_connector_service_.html index 09675447ef..932a2ddd76 100644 --- a/papi-dts/modules/_main_services_server_network_connector_service_.html +++ b/papi-dts/modules/_main_services_server_network_connector_service_.html @@ -1,2 +1,2 @@ -"main/services/server-network-connector.service" | papi-dts

    Namespace "main/services/server-network-connector.service"

    Index

    Classes

    default +"main/services/server-network-connector.service" | papi-dts

    Namespace "main/services/server-network-connector.service"

    Index

    Classes

    \ No newline at end of file diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 0fe50281d8..f89a74479d 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

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index caae2c7682..414ea70487 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

    \ No newline at end of file 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 96e3bba6eb..6148c93a6a 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 65548b7c4c..2f1cb29505 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
    \ No newline at end of file diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 1ff4c47f2f..e1daad6a86 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 69f60937d6..413db152c2 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 4541b54689..95627cb3a3 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 9bd056a820..a02c5d0150 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 2d5c2c53ef..b57abdbd52 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

    \ No newline at end of file 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 816c966a43..e6c1020722 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

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index d86380bf54..9d2fb3dcc0 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 c3e5b16264..d8844f65e5 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

    \ No newline at end of file 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 0ccf64b0a5..047698599e 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

    \ No newline at end of file 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 6538749b8b..9f1ebdef0a 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

    \ No newline at end of file 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 0d120ac9d7..bf3f7f878c 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

    \ No newline at end of file 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 76ebc188f7..be6b627e38 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

    \ No newline at end of file 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 d1daf83d1e..73eae1ed20 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

    \ No newline at end of file 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 919301d8b3..11fa9c6a88 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

    \ No newline at end of file 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 41c2ee2c22..354da0a571 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

    \ No newline at end of file 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 805841aa64..c7cc7d4f82 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

    \ No newline at end of file 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 f1a7d7efce..b3daf4b7d7 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

    \ No newline at end of file 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 72ff5db038..d3e8ce60ab 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

    \ No newline at end of file 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 4029c5ac6b..35309adbd1 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

    \ No newline at end of file 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 13d3c82fc7..fa47753210 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 e4d20e49eb..b1477882c1 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_internal_connection_model_.html b/papi-dts/modules/_shared_data_internal_connection_model_.html index b717b18ad2..66a1d1742d 100644 --- a/papi-dts/modules/_shared_data_internal_connection_model_.html +++ b/papi-dts/modules/_shared_data_internal_connection_model_.html @@ -1,4 +1,4 @@ -"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    Type Aliases

    ClientConnectEvent ClientDisconnectEvent InternalEvent diff --git a/papi-dts/modules/_shared_data_network_connector_model_.html b/papi-dts/modules/_shared_data_network_connector_model_.html index 9e1b4c6ca4..70b6082552 100644 --- a/papi-dts/modules/_shared_data_network_connector_model_.html +++ b/papi-dts/modules/_shared_data_network_connector_model_.html @@ -1,4 +1,4 @@ -"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    MessageType +"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    Type Aliases

    ClientConnect InitClient Message diff --git a/papi-dts/modules/_shared_data_platform_data_.html b/papi-dts/modules/_shared_data_platform_data_.html index 5c0e7b58c3..e8b24d6983 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
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index d6d9f96a47..6cf33413b7 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_log_error_model_.html b/papi-dts/modules/_shared_log_error_model_.html index 24a944476c..e73ac503fa 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

    \ No newline at end of file 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 a3ee63e060..0d906e3e47 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

    \ No newline at end of file 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 9bf942c20e..b2add57bf0 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 266bdd035a..214670ba70 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 WithNotifyUpdate default diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index f1e1eb5261..67f3e5c49b 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

    IDisposableDataProvider +"shared/models/data-provider.interface" | papi-dts

    Namespace "shared/models/data-provider.interface"

    Index

    Type Aliases

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index fe3b05b18c..99fb6646ae 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 207926e344..e6904ead4e 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
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 8edf738d5d..5eb4026977 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 053dbced28..878335f623 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

    \ No newline at end of file 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 b0e71f5280..56b8cd7dd0 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

    \ No newline at end of file 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 528804cdc9..ba4f7aea0a 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

    \ No newline at end of file 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 2b5fefdca4..ade3592388 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 e0f8508b8e..aa6317c0ae 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 NetworkObject NetworkObjectDetails 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 fac8b5a35d..e1320b6738 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
    \ No newline at end of file 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 4d1d3f7948..66c34cd683 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

    \ No newline at end of file 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 deb4e500f3..50aa769320 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
    \ No newline at end of file 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 877faad42d..0a87110b57 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

    \ No newline at end of file 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 f5c112805d..e9b2e8bba1 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

    \ No newline at end of file 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 bbe650260c..9b507119bd 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 d0623374f7..8ba1a91055 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 38bcb7f4d0..ee51cdcb66 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
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index a14d78f50b..fa59991b32 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 553c5c4bda..ce8a0d3c09 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

    DisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index 8b8f817676..6c5b8c919b 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 initialize registerCommand diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index 89084e041a..1113b119a0 100644 --- a/papi-dts/modules/_shared_services_connection_service_.html +++ b/papi-dts/modules/_shared_services_connection_service_.html @@ -1,4 +1,4 @@ -"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect +"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect disconnect emitEventOnNetwork getClientId diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index 06ddd9680c..9e41d8a77d 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 795a211ff4..89c58104cc 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 1b4172d7f8..2a610dce42 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index dc8df81325..b25df8c123 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 779c079e99..648bd72527 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index 8a1ef81291..460abf1587 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 0b6eea3803..954ff2c470 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

    WARN_TAG +"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    Functions

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index fb659ce529..6b8378d283 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

    \ No newline at end of file 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 fb0a3c5919..6a4f310e95 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_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index ee99767374..4f3dbf9a40 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    createNetworkConnector +"shared/services/network-connector.factory" | papi-dts

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index 6dadcb41ca..1975dc28e8 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    default +"shared/services/network-connector.interface" | papi-dts

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 6edcb19c49..ff3ae6b435 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 dc3ce42a55..1c3c7bcb0b 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 1b6d44c5da..895de8eaf2 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

    Type Aliases

    ArgsRequestHandler ComplexRequestHandler ContentsRequestHandler 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 5a380b3d2f..3b2a0a886f 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 ce39d03e43..d3a1f862af 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index 657bdb44b6..8e80fd51d0 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
    \ No newline at end of file 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 92476cd397..95167bb402 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_scroll_group_service_.html b/papi-dts/modules/_shared_services_scroll_group_service_.html index f83c44a385..c2551c6ade 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

    \ No newline at end of file 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 763f9a9801..ffc3ba6d44 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 39fb17fd0e..3f1fb25f66 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

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index f5f00012c4..51626e2188 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 aecc9e9496..f4af4c6a2f 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 009915e37a..b057f5b132 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

    \ No newline at end of file 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 24857a06b5..c5af3c5013 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

    Variables

    EVENT_NAME_ON_DID_ADD_WEB_VIEW diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 03db20d085..e924146b0f 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 c76402721f..8f08b80aa8 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 8f7ee97ac2..e8926256af 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 b2770561bd..852a3f1d38 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

    Enumerations

    RequestHandlerType +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index a3e53ffee8..32fd003f92 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts
    \ No newline at end of file +Papi | papi-dts
    \ No newline at end of file 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 677ec9d5ca..115fd29358 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 8e47c70094..2e3bdba0c0 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 2fa2f4fb7a..b3b3f9a177 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 51112ef2b0..a0a5139034 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: "extension"

    For now this is just for extensions, but maybe we will want to expand this in the future

    -
    \ No newline at end of file +
    \ No newline at end of file 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 4e938e1914..a5886f1b0d 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 5aa3bdab0a..33f9960c5b 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' commands that are added to CommandHandlers.

    Example

    'platform.quit';
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index fbd6025324..8031e523ce 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    'platform.placeholder'
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 28a0a15cdb..f2875312f1 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -3,4 +3,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index c0ba87886a..97cad9b027 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index 1b11396d2c..e93f24df56 100644 --- a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html @@ -19,4 +19,4 @@
    \ No newline at end of file +

    Returns Promise<UnsubscriberAsync>

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index 69a09e89af..d8310673fb 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

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index e02e0e0260..beeca81036 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 alias NotesOnlyProjectDataTypes

    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.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index b497d905b8..19126c3fc7 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>;
    }

    Type declaration

    \ No newline at end of file +PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index f063ea3b47..ca8b42f0d7 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -7,4 +7,4 @@ PDP.

    Example

    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index 8bcc89d133..3fbf914b9e 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -6,4 +6,4 @@ ProjectDataProviderInterfaces.

    Example

    'platform.notesOnly'
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 3ca0b74a53..61981ea9fd 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -3,4 +3,4 @@ ProjectSettingTypes.

    Example

    'platform.fullName'
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 262e1abe21..75908dee46 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' user settings that are added to SettingTypes.

    Example

    'platform.verseRef'
     
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index f5a1c95e45..9f69bbfdd8 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>;
    }

    Type declaration

    \ No newline at end of file +StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index fbb4258f1f..1d213de09a 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@

    Throws

    If the setting validator failed.

    See

    DataProviderUpdateInstructions for more info on what to return

    \ No newline at end of file +

    Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    \ No newline at end of file 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 8991b72c70..44475b1136 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

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 2aff65bfed..54c194cd74 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): void;
        submitDialog(data): 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

  • \ No newline at end of file +

    Returns void

    \ No newline at end of file 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 9899925d58..d93e0a81e9 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 64261edce8..84caf4fc37 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) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    \ No newline at end of file +DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    \ No newline at end of file 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 bf3adcba2a..ed328991f1 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 82d5e856eb..73f07d9e4b 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
    \ No newline at end of file +ProjectDialogOptionsBase | papi-dts
    \ No newline at end of file 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 7e3dd00f43..957d35ca1b 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

    • Optional selectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -
    \ No newline at end of file +
    \ No newline at end of file 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 d3a310d557..217e62c8d7 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

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -
    \ No newline at end of file +
    \ No newline at end of file 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 365e893251..e13d76b945 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 8a562d8c3c..5c5fa1b3c9 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

    • Optional maximumOpenDialogs?: 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.

      -
    \ No newline at end of file +
    \ No newline at end of file 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 7b7e1f6932..f59bd27799 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -24,4 +24,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index 819620e07d..fb45419848 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html @@ -1,2 +1,2 @@ ClientConnectEvent | papi-dts
    ClientConnectEvent: {
        clientId: number;
        didReconnect: boolean;
    }

    Event emitted when client connections are established

    -

    Type declaration

    • clientId: number
    • didReconnect: boolean
    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index 8ff201e130..807a9abc51 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html @@ -1,2 +1,2 @@ ClientDisconnectEvent | papi-dts
    ClientDisconnectEvent: {
        clientId: number;
    }

    Event emitted when client connections are lost

    -

    Type declaration

    • clientId: number
    \ No newline at end of file +

    Type declaration

    • clientId: number
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index 8c493cc257..3033f61955 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html @@ -1,4 +1,4 @@ InternalEvent | papi-dts
    InternalEvent<T>: {
        event: T;
        senderId: number;
    }

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • event: T

      Contents of the event

    • senderId: number

      The process that emitted this Event

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index da9250add6..f2291013d4 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html @@ -1,3 +1,3 @@ InternalNetworkEventHandler | papi-dts
    InternalNetworkEventHandler: (<T>(eventType, incomingEvent) => void)

    Handler for events from on the network. Used internally between network connector and Connection Service

    -

    Type declaration

      • <T>(eventType, incomingEvent): void
      • Type Parameters

        • T

        Parameters

        Returns void

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, incomingEvent): void
      • Type Parameters

        • T

        Parameters

        Returns void

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index 8acfa3c967..595568d0eb 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html @@ -1,2 +1,2 @@ InternalRequest | papi-dts
    InternalRequest<TParam>: {
        requestId: number;
    } & ComplexRequest<TParam>

    Request to do something and to respond

    -

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number
    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index b9a999a358..cd60841491 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html @@ -1,3 +1,3 @@ InternalRequestHandler | papi-dts
    InternalRequestHandler: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Handler for requests from the server. Used internally between network connector and Connection Service

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index 4fdeca6a0b..4c4f49ccdd 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html @@ -1,4 +1,4 @@ InternalResponse | papi-dts
    InternalResponse<TReturn>: {
        requestId: number;
        requesterId: number;
        senderId: number;
    } & ComplexResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestId: number
    • requesterId: number

      The process that originally sent the Request that matches to this response

    • senderId: number

      The process that sent this Response

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index 8b378a146f..38fdae39e6 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

    • Optional didClientConnectHandler?: ((event) => void)

      Handles when a new connection is established

    • Optional didClientDisconnectHandler?: ((event) => void)

      Handles when a client disconnects

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index 383c239abe..a6f5693af0 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html @@ -1,2 +1,2 @@ NetworkConnectorInfo | papi-dts
    NetworkConnectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the network connector

    -

    Type declaration

    • clientId: number
    \ No newline at end of file +

    Type declaration

    • clientId: number
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index a1ffb28e62..f4a808b826 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html @@ -1,2 +1,2 @@ NetworkEventHandler | papi-dts
    NetworkEventHandler: (<T>(eventType, event) => void)

    Handler for events from on the network

    -

    Type declaration

      • <T>(eventType, event): void
      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, event): void
      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index e451bbc31e..ea1675f702 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html @@ -1,2 +1,2 @@ RequestHandler | papi-dts
    RequestHandler: (<TParam, TReturn>(requestType, request) => Promise<ComplexResponse<TReturn>>)

    Handler for requests from the server

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index df60b624ec..8ee6079813 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html @@ -1,2 +1,2 @@ RequestRouter | papi-dts
    RequestRouter: ((requestType) => number)

    Function that returns a clientId to which to send the request based on the requestType

    -

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    \ No newline at end of file +

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index 1d59462476..bdb3e0525d 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html +++ b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html @@ -3,4 +3,4 @@ (like if the browser refreshes): if the server has a connection with this clientGuid, it will unregister all requests on that client so the reconnecting client can register its request handlers again.

    -
  • senderId: number
  • type: ClientConnect
  • \ No newline at end of file +
  • senderId: number
  • type: ClientConnect
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 704ed21014..cd20705dfb 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html +++ b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html @@ -1,3 +1,3 @@ InitClient | papi-dts
    InitClient: {
        clientGuid: string;
        connectorInfo: NetworkConnectorInfo;
        senderId: number;
        type: InitClient;
    }

    Message sent to the client to give it NetworkConnectorInfo

    Type declaration

    • clientGuid: string

      Guid unique to this connection. Used to verify important messages like reconnecting

      -
    • connectorInfo: NetworkConnectorInfo
    • senderId: number
    • type: InitClient
    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index c2fbbef284..c924b31806 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.Message.html +++ b/papi-dts/types/_shared_data_network_connector_model_.Message.html @@ -1,2 +1,2 @@ Message | papi-dts
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index aad785a9a4..b34ec49e95 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html @@ -1,3 +1,3 @@ WebSocketEvent | papi-dts
    WebSocketEvent<T>: {
        eventType: string;
        type: Event;
    } & InternalEvent<T>

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • eventType: string

      What kind of event this is

      -
    • type: Event
    \ No newline at end of file +
  • type: Event
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index 666942305c..539516d3ee 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html @@ -1,3 +1,3 @@ WebSocketRequest | papi-dts
    WebSocketRequest<TParam>: {
        requestType: string;
        type: Request;
    } & InternalRequest<TParam>

    Request to do something and to respond

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Request
    \ No newline at end of file +
  • type: Request
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index 172b21472d..23bbaccbc5 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html @@ -1,3 +1,3 @@ WebSocketResponse | papi-dts
    WebSocketResponse<TReturn>: {
        requestType: string;
        type: Response;
    } & InternalResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Response
    \ No newline at end of file +
  • type: Response
  • \ No newline at end of file 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 ad326f9fa3..0257a669d8 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 @@ -27,4 +27,4 @@

    OR

    class MyPDPE implements IBaseProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 4635ceb482..731ab73821 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;
    }

    Type declaration

    \ No newline at end of file +CreateProcess | papi-dts
    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }

    Type declaration

    \ No newline at end of file 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 8fc1ef48ad..db7da27688 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 d6e5173038..6de396f398 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 @@ -15,4 +15,4 @@ createProcess.fork(executionToken, 'assets/childProcess.js');

    Returns

    A ChildProcess object representing the process running the module

    -
    \ No newline at end of file +
    \ No newline at end of file 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 7b526aa6e1..2a077d9d7b 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 @@ -27,4 +27,4 @@ }

    Returns

    A ChildProcessByStdio object representing the command

    -
    \ No newline at end of file +
    \ No newline at end of file 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 aa06cb1c87..e5ca9c82f5 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 @@ -20,4 +20,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 declaration

    \ No newline at end of file +

    Type Parameters

    Type declaration

    \ No newline at end of file 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 c384641e58..801686bed4 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 @@ -27,4 +27,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -
    \ No newline at end of file +
    \ No newline at end of file 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 7c513d5874..74b492ac74 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 @@ -23,4 +23,4 @@

    OR

    class MyDPE implements IDataProviderEngine<MyDataTypes> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
    ...
    }
    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 be7348767d..53630c50af 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

    \ No newline at end of file +
    \ No newline at end of file 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 0e5f64854f..1ca9ad9711 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

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 8fe84ff15a..027fc59309 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 00dfa3a219..b3d6bf92a3 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -7,4 +7,4 @@ following:

    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file 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 3d35164a7a..22ff743486 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"]>

    Returns

    The subset of data represented by the selector

    -
    \ No newline at end of file +
    \ No newline at end of file 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 4da33a5ee2..44082352e9 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 alias DataProviderGetters<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

    See

    DataProviderGetter for more information

    -
    \ No newline at end of file +
    \ No newline at end of file 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 eac1cd4818..b17f46ab3e 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>>

    Returns

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -
    \ No newline at end of file +
    \ No newline at end of file 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 3598430ba8..87b07053e2 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 alias DataProviderSetters<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

    See

    DataProviderSetter for more information

    -
    \ No newline at end of file +
    \ No newline at end of file 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 3e018fe2a9..f2b2fbc020 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

  • Optional options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Returns

    Unsubscriber to stop listening for updates

    -
    \ No newline at end of file +
    \ No newline at end of file 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 c38c318ca5..6621f762ec 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -21,4 +21,4 @@

    Default

    'deeply-equal'
     
    -
    \ No newline at end of file +
    \ No newline at end of file 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 d88a3d5edb..5c85d182e4 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 alias DataProviderSubscribers<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

    See

    DataProviderSubscriber for more information

    -
    \ No newline at end of file +
    \ No newline at end of file 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 f91774bda8..8b776ad067 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -16,4 +16,4 @@
  • false (or falsy) do not update subscriptions

  • -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 951eb38f5c..d276e9cc9a 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

    See

    DataProviderDataTypes for more information

    -
    \ No newline at end of file +
    \ No newline at end of file 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 cda071645a..0c5b5849da 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

    See

    IDataProvider

    -
    \ No newline at end of file +
    \ No newline at end of file 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 e20c5f7cee..edb987a00b 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

    -

    Type declaration

    • isDialog: true
    \ No newline at end of file +

    Type declaration

    • isDialog: true
    \ No newline at end of file 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 0f3fd86cc1..b6189f7b76 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 @@
  • Optional title?: 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 9315131a64..d5d56d8605 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
  • -
    \ No newline at end of file +
    \ No newline at end of file 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 c15ab2fc97..779a9696ff 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

    -

    Type declaration

    • height: number
    • width: number
    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number
    \ No newline at end of file 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 ccdd40280b..6ad560295d 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 ec7cf3d9da..fc24bef587 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -1,2 +1,2 @@ OnLayoutChangeRCDock | papi-dts
    OnLayoutChangeRCDock: ((newLayout, currentTabId?, direction?) => Promise<void>)

    Rc-dock's onLayoutChange prop made asynchronous - resolves

    -

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>
      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    \ No newline at end of file +

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>
      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    \ No newline at end of file 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 7927be23e9..710ed3a31c 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"
    \ No newline at end of file +PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"
    \ No newline at end of file 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 d9ac249ad4..fbcf955e46 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 @@
      • (webViewId, updateInfo): boolean
      • Parameters

        • webViewId: string

          The ID of the WebView to update

        • updateInfo: WebViewDefinitionUpdateInfo

          Properties to update on the WebView. Any unspecified properties will stay the same

          -

        Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file 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 b2810f6309..7d26d10acc 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 13a1303f0e..29414c0f72 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -10,4 +10,4 @@

    Defaults to Platform.Bible logo

  • tabTitle: string

    Text to show on the title bar of the tab

  • Optional tabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 97b741cc5c..0bd668f514 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) => 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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 26ca7462d7..00b0d6c70d 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

    Returns

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -
    \ No newline at end of file +
    \ No newline at end of file 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 13b5664d6f..3f484ee0ca 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 f1e70b03cd..9c8ae6e38f 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 5898167211..b1ca911ccd 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 c8c66f267d..91e9bfeb90 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
    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 f68dfc9d9d..94e52cb92b 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) => Promise<void>)

    Stop running an extension that had been previously downloaded and enabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

    Returns

    Promise that resolves when the extension has been enabled, throws if enabling fails

    -
    \ No newline at end of file +
    \ No newline at end of file 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 72de8046c5..cb79d21c62 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) => Promise<void>)

    Start running an extension that had been previously downloaded and disabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

    Returns

    Promise that resolves when the extension has been enabled, throws if enabling fails

    -
    \ No newline at end of file +
    \ No newline at end of file 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 519c110c5b..8dbd1d0af2 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

    -

    Type declaration

    • extensionName: string
    • extensionVersion: string
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 d6606b4464..564b178380 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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 164052c67d..8b56f6b7a7 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

    -

    Type declaration

    • sha256: string
    • sha512: string
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 37de4eed63..3c285cbcda 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>

    Returns

    Promise that resolves when the extension has been installed

    -
    \ No newline at end of file +
    \ No newline at end of file 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 8f2fd59ed9..3f3c100fd4 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 1e0589965c..bfcf3eb066 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 f2d1dcbf65..d57fed214c 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

    See

    networkObjectService

    -
    \ No newline at end of file +
    \ No newline at end of file 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 a756b2e211..f0b5ab0263 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

    See

    networkObjectService

    -
    \ No newline at end of file +
    \ No newline at end of file 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 af96a7386d..cf10a79f28 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

    See

    networkObjectService

    -
    \ No newline at end of file +
    \ No newline at end of file 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 fce1383f81..6fde4d3864 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 6f415de6d5..4dfb496aef 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

    See

    networkObjectService

    -
    \ No newline at end of file +
    \ No newline at end of file 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 981ee0700a..a15e2454c7 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 @@ -26,4 +26,4 @@

    OR

    class MyPDPE implements IProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file 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 505df2cee5..6bdad82e9d 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

    • Optional excludeProjectIds?: string | string[]

      Project IDs to exclude

    • Optional includeProjectIds?: string | string[]

      Project IDs to include

      -
    \ No newline at end of file +
    \ No newline at end of file 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 31083bfc2a..8218976c55 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 04bb6fb47d..a140d3f123 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 @@ -49,4 +49,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 c530545620..e514c7b223 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
  • \ No newline at end of file +
    \ No newline at end of file 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 c1528d6db2..9424a6bff1 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 @@

    • Optional pdpFactoryId: 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
  • \ No newline at end of file +
  • mergeMetadataFilters:function
  • \ No newline at end of file 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 25e51e01f6..ad58a3eae1 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.

      -
    \ No newline at end of file +
    \ No newline at end of file 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 cac5e210ed..8673e1e7e5 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)

    -
    \ No newline at end of file +
    \ No newline at end of file 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 63d075e2ab..0d52a7cba6 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 fe51070cb1..3dbecde600 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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 f763a1a0c4..ebb7a93c4a 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 4d6f37a58e..16d56f1837 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.

    -
    \ No newline at end of file +
    \ No newline at end of file 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 35933df398..1187bf20d3 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 3923d9a640..c7b3e115c1 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -6,4 +6,4 @@

    @example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file 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 29a08943f6..652b5b51bc 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html @@ -15,4 +15,4 @@

    @example

    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -

    Type declaration

      • (): [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: ScrollGroupId | undefined, setScrollGroupId: ((newScrollGroupId) => void)]
      • Returns [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: ScrollGroupId | undefined, setScrollGroupId: ((newScrollGroupId) => void)]

    \ No newline at end of file +

    Type declaration

      • (): [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: ScrollGroupId | undefined, setScrollGroupId: ((newScrollGroupId) => void)]
      • Returns [scrRef: ScriptureReference, setScrRef: ((newScrRef) => void), scrollGroupId: ScrollGroupId | undefined, setScrollGroupId: ((newScrollGroupId) => void)]

    \ No newline at end of file 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 9145e5e6f8..7fde901df2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -24,4 +24,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type declaration

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

        Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    \ No newline at end of file +

    Type declaration

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

        Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    \ No newline at end of file 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 041febac07..8729f67ffb 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 a708c0465a..7c6e54d81d 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -76,4 +76,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: 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

    -
  • \ No newline at end of file +
    \ No newline at end of file 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 be52815520..f4adb1b8a5 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 a03c7f1ba8..1d17eb74c8 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

    • Optional contentType?: React

      Indicates this WebView uses React

    • Optional styles?: string

      String of styles to be loaded into the iframe for this WebView

      -
    \ No newline at end of file +
    \ No newline at end of file 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 85b3e8fdf9..d750bba0f3 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

      -
    \ No newline at end of file +
    \ No newline at end of file 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 8eb92596a3..031292a399 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 873f028e6f..9bdf77d0dd 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 9bb3fa1d0f..1acb58059f 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

    -
    \ No newline at end of file +
    \ No newline at end of file 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 585f880736..c4d90199f4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -50,4 +50,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    \ No newline at end of file +
    \ No newline at end of file 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 642e046cc4..8681b3c1a1 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 753bedc823..96cc6476f1 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.

    -

    Type declaration

      \ No newline at end of file +

      Type declaration

        \ No newline at end of file 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 1e9e5e4b52..9677609d35 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 @@ string key that corresponds to a localized value and an array of BCP 47 language codes

        Returns Promise<LocalizationData>

      • 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>

        \ No newline at end of file +

        Parameters

        • bookNum: number
        • localizationLanguage: string

        Returns Promise<string>

        \ No newline at end of file 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 5f7f76f668..c8d10623a5 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
        \ No newline at end of file +LocalizationData | papi-dts
        LocalizationData: LanguageStrings
        \ No newline at end of file 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 6fa3e61f54..128eb6eff1 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>;
        }

        Type declaration

        \ No newline at end of file +LocalizationDataDataTypes | papi-dts
        LocalizationDataDataTypes: {
            LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
            LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
        }

        Type declaration

        \ No newline at end of file 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 9cbd415933..0dd46e025e 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;
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKey: LocalizeKey
        \ No newline at end of file +LocalizationSelector | papi-dts
        LocalizationSelector: {
            locales?: string[];
            localizeKey: LocalizeKey;
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKey: LocalizeKey
        \ No newline at end of file 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 1b14913167..5d38470db3 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[];
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKeys: LocalizeKey[]
        \ No newline at end of file +LocalizationSelectors | papi-dts
        LocalizationSelectors: {
            locales?: string[];
            localizeKeys: LocalizeKey[];
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKeys: LocalizeKey[]
        \ No newline at end of file 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 523459a8fb..deb1b326b6 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) => 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

            • Optional options: 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) => 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

            • Optional options: DataProviderSubscriberOptions

              Various options to adjust how the subscriber emits updates

            Returns Promise<UnsubscriberAsync>

            Unsubscriber function (run to unsubscribe from listening for updates)

            -
        \ No newline at end of file +
        \ No newline at end of file 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 40957a42a9..c350e43b64 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>;
        }

        Type declaration

        \ No newline at end of file +MenuDataDataTypes | papi-dts
        MenuDataDataTypes: {
            MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
            WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
        }

        Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index daed2aa162..7a12ef13f7 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

        -

        Type Parameters

        • TParam extends unknown[] = any[]
        • TReturn = any

        Type declaration

        \ No newline at end of file +

        Type Parameters

        • TParam extends unknown[] = any[]
        • TReturn = any

        Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index 369229284b..6b206f1858 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

        -

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file +

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index fd537e7182..593c4a85c0 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

        Type alias ContentsRequestHandler<TParam, TReturn>

        ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

        Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

        -

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file +

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file 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 78b8fd251f..685854c0a1 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

        -
        \ No newline at end of file +
        \ No newline at end of file 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 571e269365..fb103ac2a6 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

        \ No newline at end of file +

        Returns Promise<boolean>

        \ No newline at end of file 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 c039f71421..93da4a617e 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

        -
        \ No newline at end of file +
        \ No newline at end of file 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 7ad9f68a85..7f67c7d5bb 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.

        -
        \ No newline at end of file +
        \ No newline at end of file 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 54cfeacfcc..8c29b96a4d 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: {
            scrRef: ScriptureReference;
            scrollGroupId: ScrollGroupId;
        }

        Information about an update to a scroll group. Informs about the new ScriptureReference at a ScrollGroupId

        -

        Type declaration

        • scrRef: ScriptureReference
        • scrollGroupId: ScrollGroupId
        \ No newline at end of file +

        Type declaration

        • scrRef: ScriptureReference
        • scrollGroupId: ScrollGroupId
        \ No newline at end of file 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 b932d4a2be..b902f46d94 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]
        }
        \ No newline at end of file +AllSettingsData | papi-dts
        AllSettingsData: {
            [SettingName in SettingNames]: SettingTypes[SettingName]
        }
        \ No newline at end of file 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 9131c53328..920592a51b 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

        -
        \ No newline at end of file +
        \ No newline at end of file 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 20e7d72b03..e00ecf39b4 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

        Throws

        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

          • key: SettingName

            The string id of the setting for which the value is being subscribed to

          • callback: ((newSetting) => void)

            The function that will be called whenever the specified setting is updated

          • Optional options: DataProviderSubscriberOptions

            Various options to adjust how the subscriber emits updates

          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
      • \ No newline at end of file +
      • Optional allChanges: Partial<SettingTypes>
      • Returns Promise<boolean>

        \ No newline at end of file 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 1ba4a0da4b..f25609f13b 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -9,4 +9,4 @@

        The closest possible representation of the unnamed (````) data type follows:

        '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
         
        -

        Type declaration

          \ No newline at end of file +

          Type declaration

            \ No newline at end of file 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 294566e66f..b59adcd5a5 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, currentValue, allChanges) => Promise<boolean>)

            Function that validates whether a new setting value should be allowed to be set

            -

            Type Parameters

            Type declaration

            \ No newline at end of file +

            Type Parameters

            Type declaration

            \ No newline at end of file diff --git a/papi-dts/types/_shared_services_web_view_service_model_.AddWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.AddWebViewEvent.html index abf0f76d07..99953b3ae3 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.AddWebViewEvent.html @@ -1,2 +1,2 @@ AddWebViewEvent | papi-dts
            AddWebViewEvent: {
                layout: Layout;
                webView: SavedWebViewDefinition;
            }

            Event emitted when webViews are created

            -

            Type declaration

            \ No newline at end of file +

            Type declaration

            \ No newline at end of file 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 95e501f437..1e3c5f954e 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

            -

            Type declaration

            \ No newline at end of file +

            Type declaration

            \ No newline at end of file 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 72edf9c53e..9a4c3b10c2 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

            -
            \ No newline at end of file +
            \ No newline at end of file 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 62d490e9b2..1a30434b5f 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>
            \ No newline at end of file +LocalizedProjectSettingsContributionInfo | papi-dts
            LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>
            \ No newline at end of file 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 d21e7c2b1a..ae73f50b3d 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 declaration

            \ No newline at end of file +

            Type Parameters

            Type declaration

            \ No newline at end of file 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 fcda5442f9..0e4420fb1e 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

              -
            \ No newline at end of file +
            \ No newline at end of file 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 c208884f06..2089c288e0 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

            -
            \ No newline at end of file +
            \ No newline at end of file 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 e5a784d5c6..07d9071d73 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>
            \ No newline at end of file +LocalizedSettingsContributionInfo | papi-dts
            LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>
            \ No newline at end of file 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 880bb7de53..51d4620f1d 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 declaration

            \ No newline at end of file +

            Type Parameters

            Type declaration

            \ No newline at end of file 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 dca53ab2d1..f0e8216d01 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

              -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index 001ef77cb2..91e886afdc 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_util_.ComplexRequest.html @@ -1,4 +1,4 @@ ComplexRequest | papi-dts

            Type alias ComplexRequest<TParam>

            ComplexRequest<TParam>: {
                contents: TParam;
                senderId: number;
            }

            Type of object passed to a complex request handler that provides information about the request. This type is used as the public-facing interface for requests

            Type Parameters

            • TParam = unknown

            Type declaration

            • contents: TParam
            • senderId: number

              The one who sent the request

              -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_util_.ComplexResponse.html index c92008350d..7713be5500 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

            Type alias ComplexResponse<TReturn>

            Type of object to create when handling a complex request where you desire to provide additional information beyond the contents of the response This type is used as the public-facing interface for responses

            -

            Type Parameters

            • TReturn = unknown
            \ No newline at end of file +

            Type Parameters

            • TReturn = unknown
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html index 0cfe588c1a..91d91acf62 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

            Type alias ComplexResponseFailure

            ComplexResponseFailure: {
                errorMessage: string;
                success: false;
            }

            Type declaration

            • errorMessage: string

              Error explaining the problem that is only populated if success is false

            • success: false

              Whether the handler that created this response was successful in handling the request

              -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html index 6df411e92b..02fca49509 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

            Type alias ComplexResponseSuccess<TReturn>

            ComplexResponseSuccess<TReturn>: {
                contents: TReturn;
                success: true;
            }

            Type Parameters

            • TReturn = unknown

            Type declaration

            • contents: TReturn

              Content with which to respond to the request. Must be provided unless the response failed or TReturn is undefined

            • success: true

              Whether the handler that created this response was successful in handling the request

              -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 99c0c13030..61f45226a3 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

              -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 6d2a59949d..49143878ba 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 alias SerializedRequestType

            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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index edf03937eb..ad57cfcadc 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -6,4 +6,4 @@
            this.notifyUpdate('Setting');
             

            See

            IBaseProjectDataProviderEngine for more information on extending this class.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index 18801b85ae..ae983023eb 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.

            See

            IDataProviderEngine for more information on extending this class.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 4e62a98263..2964b3d3ec 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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index bdf8f10619..785cd8a346 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -6,4 +6,4 @@
            this.notifyUpdate('Setting');
             

            See

            IProjectDataProviderEngine for more information on extending this class.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index e30b129e88..a2e13925f8 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

            Variable commandsConst

            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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index 641cd452db..5eced9c352 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

            Variable dataProvidersConst

            dataProviders: DataProviderService

            Service that allows extensions to send and receive data to/from other extensions

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 3b1b45f43a..f323d1d827 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -71,4 +71,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.

            -
          • \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 994e4edca4..3df147802a 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

            Variable dialogsConst

            dialogs: DialogService

            Prompt the user for responses with dialogs

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index dd71c96171..b9a279fc0a 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

            Variable internetConst

            internet: InternetService

            Service that provides a way to call fetch since the original function is not available

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index a25b29e986..1680ae8475 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

            Variable localizationConst

            localization: ILocalizationService

            Service that allows to get and store localizations

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 1a08173d76..8cf50b9261 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

            Variable loggerConst

            logger: MainLogger & {
                default: MainLogger;
            }

            All extensions and services should use this logger to provide a unified output of logs

            -

            Type declaration

            • default: MainLogger
            \ No newline at end of file +

            Type declaration

            • default: MainLogger
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 7888c828ca..f8b9869e46 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

            Variable menuDataConst

            Service that allows to get and store menu data

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 2b970ab550..6fb1249721 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

            Variable networkConst

            Service that provides a way to send and receive network events

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index 17ca154742..efa8408517 100644 --- a/papi-dts/variables/__papi_backend_.networkObjectStatus.html +++ b/papi-dts/variables/__papi_backend_.networkObjectStatus.html @@ -1,2 +1,2 @@ networkObjectStatus | papi-dts

            Variable networkObjectStatusConst

            networkObjectStatus: NetworkObjectStatusServiceType

            Provides functions related to the set of available network objects

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index e04e7668f7..2da76c8098 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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 277d8bf575..47871c6c89 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

            Variable projectDataProvidersConst

            Service that registers and gets project data providers

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index fe5f3703fa..4be2c00acd 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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index 4141583f54..e61a584e0c 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

            Variable projectSettingsConst

            projectSettings: IProjectSettingsService

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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.scrollGroups.html b/papi-dts/variables/__papi_backend_.scrollGroups.html index b3c08c415f..c0690d038f 100644 --- a/papi-dts/variables/__papi_backend_.scrollGroups.html +++ b/papi-dts/variables/__papi_backend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

            Variable scrollGroupsConst

            scrollGroups: IScrollGroupService

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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index cafc82da4a..12ca1f91c9 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts
            \ No newline at end of file +settings | papi-dts
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 9d7b73b852..d60fceed11 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

            Variable storageConst

            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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index d7875bfe24..5a1716346c 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

            Variable webViewProvidersConst

            webViewProviders: PapiWebViewProviderService

            Interface for registering webView providers

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 12bf679be8..5649b9dd44 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

            Variable webViewsConst

            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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 1d54b54ffb..67308b458a 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

            Variable defaultConst

            default: {}

            Exporting empty object so people don't have to put 'type' in their import statements

            -

            Type declaration

              \ No newline at end of file +

              Type declaration

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index fe77beba7d..290471ca49 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index c1893ed11c..76a9f84cba 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 5c13d0f3fe..41ff4ba3d1 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

                Variable commandsConst

                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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index 06e145ba58..9151eb4508 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

                Variable dataProvidersConst

                dataProviders: DataProviderService

                Service that allows extensions to send and receive data to/from other extensions

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 6a349e0544..e4b0e18a51 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -27,4 +27,4 @@
              • settings: ISettingsService
              • 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.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 6c814511c4..f1fd6038da 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

                Variable dialogsConst

                dialogs: DialogService

                Prompt the user for responses with dialogs

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index d2c9d850aa..5de64aa570 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

                Variable internetConst

                internet: InternetService

                Service that provides a way to call fetch since the original function is not available

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index 2dc74d769b..b8dd0d2088 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

                Variable localizationConst

                localization: ILocalizationService

                Service that allows to get and store localizations

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 0c466414a8..965f3b4b3d 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

                Variable loggerConst

                logger: MainLogger & {
                    default: MainLogger;
                }

                All extensions and services should use this logger to provide a unified output of logs

                -

                Type declaration

                • default: MainLogger
                \ No newline at end of file +

                Type declaration

                • default: MainLogger
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index b7257e0979..93ca6cc562 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

                Variable menuDataConst

                Service that allows to get and store menu data

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index bbb96119d0..ccc5f8e66a 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

                Variable networkConst

                Service that provides a way to send and receive network events

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index fe9a324376..22c1b6ca16 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

                Variable projectDataProvidersConst

                Service that registers and gets project data providers

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 4fa70647b0..5bda565aa9 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 5fa847817f..3fb38e8c02 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

                Variable reactConst

                React hooks that enable interacting with the papi in React components more easily.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.scrollGroups.html b/papi-dts/variables/__papi_frontend_.scrollGroups.html index ff1bec2426..39bdf11584 100644 --- a/papi-dts/variables/__papi_frontend_.scrollGroups.html +++ b/papi-dts/variables/__papi_frontend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

                Variable scrollGroupsConst

                scrollGroups: IScrollGroupService

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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index d210ef9e0a..8a527f5f1f 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts
                \ No newline at end of file +settings | papi-dts
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index e1cdab6a44..27d1ab9a97 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

                Variable webViewsConst

                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.

                -
                \ No newline at end of file +
                \ No newline at end of file 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 4ce2cc6bf2..7495a417ee 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.

                -
                \ No newline at end of file +
                \ No newline at end of file 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 d744db9d2e..2b64bf4044 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;
                }

                Type declaration

                • registerExtension: typeof registerExtension
                • tokenIsValid: typeof tokenIsValid
                • unregisterExtension: typeof unregisterExtension
                \ No newline at end of file +default | papi-dts
                default: {
                    registerExtension: typeof registerExtension;
                    tokenIsValid: typeof tokenIsValid;
                    unregisterExtension: typeof unregisterExtension;
                }

                Type declaration

                • registerExtension: typeof registerExtension
                • tokenIsValid: typeof tokenIsValid
                • unregisterExtension: typeof unregisterExtension
                \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index e51adcf564..863d7c1502 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

                Variable FILE_PROTOCOLConst

                FILE_PROTOCOL: "file://" = 'file://'
                \ No newline at end of file +FILE_PROTOCOL | papi-dts

                Variable FILE_PROTOCOLConst

                FILE_PROTOCOL: "file://" = 'file://'
                \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 1bca0e69e5..bf12ae2954 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

                Variable RESOURCES_PROTOCOLConst

                RESOURCES_PROTOCOL: "resources://" = 'resources://'
                \ No newline at end of file +RESOURCES_PROTOCOL | papi-dts

                Variable RESOURCES_PROTOCOLConst

                RESOURCES_PROTOCOL: "resources://" = 'resources://'
                \ No newline at end of file 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 3571fd3b0d..4781cfc364 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 }

                -
                \ No newline at end of file +
                \ No newline at end of file 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 ba27834940..4316a0b83b 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 179c279ae4..4527ceb315 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 4ef53e58b0..abe587ec42 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 71de5b4a2d..e05309a447 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 9d676e7371..5f227dd04a 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_internal_connection_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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index cd1c9e3d58..d2aeef65ca 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html @@ -1,2 +1,2 @@ CLIENT_ID_SERVER | papi-dts
                CLIENT_ID_SERVER: 0 = 0

                "Client id" for the server

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index bf47340daa..f8cd6520d6 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html @@ -1,2 +1,2 @@ CLIENT_ID_UNASSIGNED | papi-dts
                CLIENT_ID_UNASSIGNED: -1 = -1

                Represents when the client id has not been assigned by the server

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html index 34c47de328..34a0960631 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html @@ -1,4 +1,4 @@ CLIENT_ID_UNKNOWN | papi-dts
                CLIENT_ID_UNKNOWN: -2 = -2

                Represents when the request router does not know to which client id the request belongs. Server should try to determine the correct client id through other means, and client should just send to server

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 0baaaf2e9a..4c99621cac 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html @@ -1,2 +1,2 @@ CONNECTOR_INFO_DISCONNECTED | papi-dts
                CONNECTOR_INFO_DISCONNECTED: Readonly<{
                    clientId: -1;
                }>

                Represents when the connector info has not been populated by the server

                -

                Type declaration

                • clientId: -1
                \ No newline at end of file +

                Type declaration

                • clientId: -1
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index 13f586bba3..e654dd95bd 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html @@ -1,2 +1,2 @@ WEBSOCKET_ATTEMPTS_MAX | papi-dts
                WEBSOCKET_ATTEMPTS_MAX: 5 = 5

                Number of attempts a client will make to connect to the WebSocket server before failing

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 3fd7d30a75..1d06d11f44 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html @@ -1,3 +1,3 @@ WEBSOCKET_ATTEMPTS_WAIT | papi-dts
                WEBSOCKET_ATTEMPTS_WAIT: 1000 = 1000

                Time in ms for the client to wait before attempting to connect to the WebSocket server again after a failure

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index af22c65c69..e84af66847 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts
                WEBSOCKET_PORT: 8876 = 8876

                Port to use for the webSocket

                -
                \ No newline at end of file +
                \ No newline at end of file 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 6357ac085a..a81d4e1b0a 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

                Variable DEV_MODE_RENDERER_INDICATORConst

                DEV_MODE_RENDERER_INDICATOR: "?noisyDevMode" = '?noisyDevMode'

                Query string passed to the renderer when starting if it should enable noisy dev mode

                -
                \ No newline at end of file +
                \ No newline at end of file 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 1de3848e68..8993e0d264 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 653ced9f51..4be87f4684 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 2b0fc6b0b9..ce25cbb5dc 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'
                \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts
                networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
                \ No newline at end of file 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 bcfd5163a3..1b027ab41c 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
                \ No newline at end of file +PDP_FACTORY_OBJECT_TYPE | papi-dts
                PDP_FACTORY_OBJECT_TYPE: string
                \ No newline at end of file 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 5297d0772c..56a68006cc 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 ab601fa194..346d884f10 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'
                \ No newline at end of file +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
                \ No newline at end of file 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 4e9753f43e..f01a8373a1 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 cd800f442a..2c83cd6a0f 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

                -

                Type declaration

                \ No newline at end of file +

                Type declaration

                \ No newline at end of file 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 046d607cbf..87c7edf34a 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

                Variable SAVED_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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 493c2ee9ce..759da6094a 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

                Variable WEBVIEW_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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 9cedb31f3c..23313b28ac 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 16595a6fa5..d334b518e2 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 4f4cb246f8..c9cce7393e 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 581081d0b1..8f0ed6debb 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index 92947d71ec..5bb816b858 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 752d8c5ed3..cb8d00e7be 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

                  -
                \ No newline at end of file +
                \ No newline at end of file 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 98d72fdd56..dd76e6edd6 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 c5c844a959..b8c0835594 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>'
                \ No newline at end of file +WARN_TAG | papi-dts
                WARN_TAG: "<WARN>" = '<WARN>'
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index ba9a26ad95..a273b62383 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

                -

                Type declaration

                • default: log.MainLogger
                \ No newline at end of file +

                Type declaration

                • default: log.MainLogger
                \ No newline at end of file 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 ce3dc25139..f5e3c94774 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 95c7e72dd3..fb7174e3e0 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

                  -
                \ No newline at end of file +
                \ No newline at end of file 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 e5c45f29c4..c7d82993a2 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 3be9f0998e..cc861a6eb8 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.

                -
                \ No newline at end of file +
                \ No newline at end of file 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 d8140387aa..1e4e7e50fe 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.

                -
                \ No newline at end of file +
                \ No newline at end of file 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 b5311ad9d0..c577a14591 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 a60d8adba5..0519681e35 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 5609e87940..8db24b98a9 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 b8c349777c..4eb07515ea 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

                -

                Type declaration

                • get: typeof get
                \ No newline at end of file +

                Type declaration

                • get: typeof get
                \ No newline at end of file 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 ca720d4014..1d5e92a01f 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 abe4f9acb6..62e3f96836 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 fdac654ae0..22aaa40911 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 ae46079a46..9dae134f28 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'
                \ No newline at end of file +projectSettingsServiceNetworkObjectName | papi-dts
                projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
                \ No newline at end of file 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 121e38977f..812897199b 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 @@

                Returns

                Unsubscriber that should be called whenever the providing extension is deactivated

                \ No newline at end of file +

                Returns Promise<UnsubscriberAsync>

                \ No newline at end of file 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 9d670883b7..533c2f7c7d 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 7d3e517192..85dd00066f 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 5b368f58b5..4281ddb8d3 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'
                \ No newline at end of file +NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 9f682906b3..347a2638b1 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 b68932c14c..473522fbc9 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 701b16d7bf..fc1b611621 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 a28467658b..a4d94fb91f 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 @@

                Returns

                Unsubscriber that should be called whenever the providing extension is deactivated

                \ No newline at end of file +

                Returns Promise<UnsubscriberAsync>

                \ No newline at end of file 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 f9d58c6713..8ac8b00d8f 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 bad0b6fd08..d987a783df 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,2 +1,2 @@ papiWebViewProviderService | papi-dts
                papiWebViewProviderService: PapiWebViewProviderService

                Interface for registering webView providers

                -
                \ No newline at end of file +
                \ No newline at end of file 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 e5336fe425..1f3e283c10 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file 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 baed01d26e..59b0d6bc46 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}`

                Name to use when creating a network event that is fired when webViews are created

                -
                \ No newline at end of file +
                \ No newline at end of file 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 86a3b84dde..bdeb04c26a 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

                -
                \ No newline at end of file +
                \ No newline at end of file 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 ddf0bd9a07..b87e8d9f32 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'
                \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
                \ No newline at end of file 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 01e44bb055..99ad263cba 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

                Variable MODULE_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.

                -

                Type declaration

                • [moduleName: string]: string | {
                      [process in ProcessType | "default"]?: string
                  } | undefined
                \ No newline at end of file +

                Type declaration

                • [moduleName: string]: string | {
                      [process in ProcessType | "default"]?: string
                  } | undefined
                \ No newline at end of file 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 46abf4c6dc..a466a05444 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

                Variable REQUEST_TYPE_SEPARATORConst

                REQUEST_TYPE_SEPARATOR: ":" = ':'

                Separator between parts of a serialized request

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index 5e34e2c0b3..9957b9fe50 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

                Variable isNoisyDevModeEnabled

                isNoisyDevModeEnabled: boolean

                Indicates whether test code meant just for developers to see should be run

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 8f276a73ea..32d96d02d4 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

                Variable isPackaged

                isPackaged: boolean

                Whether this process is packaged or running from sources

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 355fd9772a..5c87f3ccb5 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

                Variable logLevel

                logLevel: LogLevel

                How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index be26cdbaa7..09b24976cd 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

                Variable processType

                processType: ProcessType

                Type of process this is. Helps with running specific code based on which process you're in

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index c0f9439a0b..fb4b38c702 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

                Variable resourcesPath

                resourcesPath: string

                Path to the app's resources directory. This is a string representation of the resources uri on frontend

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index e3aa8f2b0a..e6e4894160 100644 --- a/platform-bible-react/enums/DropdownMenuItemType.html +++ b/platform-bible-react/enums/DropdownMenuItemType.html @@ -1,3 +1,3 @@ -DropdownMenuItemType | platform-bible-react

                Enumeration DropdownMenuItemType

                Enumeration Members

                Check +DropdownMenuItemType | platform-bible-react
                \ No newline at end of file +

                Enumeration Members

                Check: 0
                Radio: 1
                \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index fd417e9bd6..9ba40c7a5e 100644 --- a/platform-bible-react/enums/LabelPosition.html +++ b/platform-bible-react/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | platform-bible-react

                Enumeration LabelPosition

                Enumeration Members

                Above +LabelPosition | platform-bible-react
                \ No newline at end of file +

                Enumeration Members

                Above: "above"
                After: "after"
                Before: "before"
                Below: "below"
                \ No newline at end of file diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index 2b31b13211..8bd9502722 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react

                Properties

                $$typeof +Alert | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertDescription.html b/platform-bible-react/functions/AlertDescription.html index a662832b4c..5fce548a04 100644 --- a/platform-bible-react/functions/AlertDescription.html +++ b/platform-bible-react/functions/AlertDescription.html @@ -1,4 +1,4 @@ -AlertDescription | platform-bible-react

                Function AlertDescription

                Properties

                $$typeof +AlertDescription | platform-bible-react

                Function AlertDescription

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertTitle.html b/platform-bible-react/functions/AlertTitle.html index ae79a88ac6..683fb54a77 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 edfc801f02..f49de3fc40 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

                Function BookChapterControl

                \ No newline at end of file +BookChapterControl | platform-bible-react

                Function BookChapterControl

                \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index f32ef55d55..127af94a6f 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 54a1708883..f30839cb97 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 3ea10e22b6..27ea187bd0 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 67b5e40ac4..8da983fa09 100644 --- a/platform-bible-react/functions/CardDescription.html +++ b/platform-bible-react/functions/CardDescription.html @@ -1,4 +1,4 @@ -CardDescription | platform-bible-react

                Function CardDescription

                Properties

                $$typeof +CardDescription | platform-bible-react

                Function CardDescription

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardFooter.html b/platform-bible-react/functions/CardFooter.html index ec85c0151f..14bab91417 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 13e6409cf6..2a7506d645 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 56ed6187a4..a08a709af1 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 10fef41e39..33b4bd7ca5 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

                Function ChapterRangeSelector

                \ No newline at end of file +ChapterRangeSelector | platform-bible-react

                Function ChapterRangeSelector

                \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index c1ad96d3e6..cf27eaa683 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index ae998f56ab..c1dbc4e43c 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,3 +1,3 @@ Checklist | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 3e7416f326..70780445c1 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react
                \ No newline at end of file +

                Type Parameters

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/ContextMenu.html b/platform-bible-react/functions/ContextMenu.html index 7d15e3d3f0..55cc51f843 100644 --- a/platform-bible-react/functions/ContextMenu.html +++ b/platform-bible-react/functions/ContextMenu.html @@ -4,4 +4,4 @@ component which define what menu items to display and supply a command handler for when a menu item is clicked.

                Returns undefined | null | string | number | boolean | Iterable<ReactNode> | Element

                The ContextMenu component (including the wrapped children)

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index 41e50aa80f..32232fb352 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1,3 +1,3 @@ DataTable | platform-bible-react
                \ No newline at end of file +

                Type Parameters

                • TData
                • TValue

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index ccd00d6ae4..434fabd65d 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

                Function DisableButton

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 69021db70e..2befe0c22f 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,4 +1,4 @@ -DropdownMenu | platform-bible-react

                Properties

                contextTypes? +DropdownMenu | platform-bible-react

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index aef4494743..76f918d4b0 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

                Function DropdownMenuCheckboxItem

                Properties

                $$typeof +DropdownMenuCheckboxItem | platform-bible-react

                Function DropdownMenuCheckboxItem

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index ec5959d2fe..9b1c0e0cdf 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

                Function DropdownMenuContent

                Properties

                $$typeof +DropdownMenuContent | platform-bible-react

                Function DropdownMenuContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index 4d09bddde0..3442d7beff 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

                Function DropdownMenuGroup

                Properties

                $$typeof +DropdownMenuGroup | platform-bible-react

                Function DropdownMenuGroup

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index 9529b118d5..f523e11e70 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,6 @@ DropdownMenuItem | platform-bible-react

                Function DropdownMenuItem

                • TODO: fix: direction is not automatically handled by this component, so that shortcuts are display always to the right

                  -

                  Parameters

                  • props: Omit<DropdownMenuItemProps & RefAttributes<HTMLDivElement>, "ref"> & {
                        className?: string;
                        inset?: boolean;
                    } & RefAttributes<HTMLDivElement>

                  Returns ReactNode

                Properties

                Parameters

                • props: Omit<DropdownMenuItemProps & RefAttributes<HTMLDivElement>, "ref"> & {
                      className?: string;
                      inset?: boolean;
                  } & RefAttributes<HTMLDivElement>

                Returns ReactNode

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index 0dd9d9d625..6d9ade372f 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

                Function DropdownMenuLabel

                Properties

                $$typeof +DropdownMenuLabel | platform-bible-react

                Function DropdownMenuLabel

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index 76fbe8eb5a..57e6077a25 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,4 +1,4 @@ -DropdownMenuPortal | platform-bible-react

                Function DropdownMenuPortal

                Properties

                contextTypes? +DropdownMenuPortal | platform-bible-react

                Function DropdownMenuPortal

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index 93613754dc..b3fbb209ee 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

                Function DropdownMenuRadioGroup

                Properties

                $$typeof +DropdownMenuRadioGroup | platform-bible-react

                Function DropdownMenuRadioGroup

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index 47778a8e78..1d393f9876 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

                Function DropdownMenuRadioItem

                Properties

                $$typeof +DropdownMenuRadioItem | platform-bible-react

                Function DropdownMenuRadioItem

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index d968eda9da..cda3a9d8ed 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

                Function DropdownMenuSeparator

                Properties

                $$typeof +DropdownMenuSeparator | platform-bible-react

                Function DropdownMenuSeparator

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index e1df80b175..bafe53c8dd 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

                Function DropdownMenuShortcut

                Properties

                Properties

                displayName: string
                \ No newline at end of file +DropdownMenuShortcut | platform-bible-react

                Function DropdownMenuShortcut

                Properties

                Properties

                displayName: string
                \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index df691420e9..a51fd07bfd 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,4 +1,4 @@ -DropdownMenuSub | platform-bible-react

                Function DropdownMenuSub

                Properties

                contextTypes? +DropdownMenuSub | platform-bible-react

                Function DropdownMenuSub

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index f9d62be43f..92b54b9e3a 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

                Function DropdownMenuSubContent

                Properties

                $$typeof +DropdownMenuSubContent | platform-bible-react

                Function DropdownMenuSubContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index e45c3c37ea..870dd01c03 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

                Function DropdownMenuSubTrigger

                Properties

                $$typeof +DropdownMenuSubTrigger | platform-bible-react

                Function DropdownMenuSubTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index 365820991e..8072880829 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

                Function DropdownMenuTrigger

                Properties

                $$typeof +DropdownMenuTrigger | platform-bible-react

                Function DropdownMenuTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/EnableButton.html b/platform-bible-react/functions/EnableButton.html index 55af613f70..e9e3408af7 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index 7ed8eb7f12..43568caf23 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.

                Parameters

                • props: RefAttributes<HTMLButtonElement>

                Returns ReactNode

                A button that can be used to filter.

                -

                Properties

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index d7a875bac3..a67d6452fb 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

                Function FilterDropdown

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index 4966520c64..b7fdb5e1dc 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index cbf9d63fdf..239ac84bb4 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react
                \ No newline at end of file +GridMenu | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index d023fa00e7..eddff526b7 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

                Function HamburgerMenuButton

                \ No newline at end of file +HamburgerMenuButton | platform-bible-react

                Function HamburgerMenuButton

                \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 676af771aa..3c5ce245c5 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 30c648ad43..f62e7701a5 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 62982d85d6..6ba3bd540c 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

                Function InstallButton

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index 29d8c12ff3..2e51e9fc4f 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1,2 +1,2 @@ Inventory | platform-bible-react
                \ No newline at end of file +

                Parameters

                • __namedParameters: InventoryProps

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index 410c5c9b96..39b74e8708 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 b489cd07bc..4743e46fba 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

                Function MarkdownRenderer

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 30e4cbd736..6d351b3e8e 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react
                \ No newline at end of file +MenuItem | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index ee57841239..d5d7363c60 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
              • -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/NavigationContentSearch.html b/platform-bible-react/functions/NavigationContentSearch.html index e34079508c..af7ce801c2 100644 --- a/platform-bible-react/functions/NavigationContentSearch.html +++ b/platform-bible-react/functions/NavigationContentSearch.html @@ -1 +1 @@ -NavigationContentSearch | platform-bible-react

                Function NavigationContentSearch

                \ No newline at end of file +NavigationContentSearch | platform-bible-react

                Function NavigationContentSearch

                \ No newline at end of file diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index c796a19301..77cda2484a 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.
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/ScriptureResultsViewer.html b/platform-bible-react/functions/ScriptureResultsViewer.html index 25c7accb79..66b12bae43 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

                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/ScrollGroupSelector.html b/platform-bible-react/functions/ScrollGroupSelector.html index 61661f9be5..d126c3d653 100644 --- a/platform-bible-react/functions/ScrollGroupSelector.html +++ b/platform-bible-react/functions/ScrollGroupSelector.html @@ -1,2 +1,2 @@ ScrollGroupSelector | platform-bible-react

                Function ScrollGroupSelector

                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 21a50e6baa..aa690b6205 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react
                \ No newline at end of file +SearchBar | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index 8a8f47f804..1376fb5a56 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,4 +1,4 @@ -Select | platform-bible-react

                Properties

                contextTypes? +Select | platform-bible-react

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index 087d77279a..36dc4469fe 100644 --- a/platform-bible-react/functions/SelectContent.html +++ b/platform-bible-react/functions/SelectContent.html @@ -1,4 +1,4 @@ -SelectContent | platform-bible-react

                Function SelectContent

                Properties

                $$typeof +SelectContent | platform-bible-react

                Function SelectContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectGroup.html b/platform-bible-react/functions/SelectGroup.html index da22608739..25a4be3f1d 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 c2b9832312..5d31922a38 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 38cf85650d..343215a277 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 0326332832..1633e8cf8d 100644 --- a/platform-bible-react/functions/SelectScrollDownButton.html +++ b/platform-bible-react/functions/SelectScrollDownButton.html @@ -1,4 +1,4 @@ -SelectScrollDownButton | platform-bible-react

                Function SelectScrollDownButton

                Properties

                $$typeof +SelectScrollDownButton | platform-bible-react

                Function SelectScrollDownButton

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollUpButton.html b/platform-bible-react/functions/SelectScrollUpButton.html index e7470a5090..29a432350a 100644 --- a/platform-bible-react/functions/SelectScrollUpButton.html +++ b/platform-bible-react/functions/SelectScrollUpButton.html @@ -1,4 +1,4 @@ -SelectScrollUpButton | platform-bible-react

                Function SelectScrollUpButton

                Properties

                $$typeof +SelectScrollUpButton | platform-bible-react

                Function SelectScrollUpButton

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectSeparator.html b/platform-bible-react/functions/SelectSeparator.html index fe47887d99..9e4f6818d7 100644 --- a/platform-bible-react/functions/SelectSeparator.html +++ b/platform-bible-react/functions/SelectSeparator.html @@ -1,4 +1,4 @@ -SelectSeparator | platform-bible-react

                Function SelectSeparator

                Properties

                $$typeof +SelectSeparator | platform-bible-react

                Function SelectSeparator

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectTrigger.html b/platform-bible-react/functions/SelectTrigger.html index b23a05c248..de9abebfd3 100644 --- a/platform-bible-react/functions/SelectTrigger.html +++ b/platform-bible-react/functions/SelectTrigger.html @@ -1,4 +1,4 @@ -SelectTrigger | platform-bible-react

                Function SelectTrigger

                Properties

                $$typeof +SelectTrigger | platform-bible-react

                Function SelectTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectValue.html b/platform-bible-react/functions/SelectValue.html index 0ac2816201..6d5ea4b732 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 9d9a67578d..3a7f84bdd4 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 b2f172119b..2782c4eb9c 100644 --- a/platform-bible-react/functions/SettingsList.html +++ b/platform-bible-react/functions/SettingsList.html @@ -1,4 +1,4 @@ SettingsList | platform-bible-react
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/SettingsListHeader.html b/platform-bible-react/functions/SettingsListHeader.html index 4803de87c7..0968a9b9cf 100644 --- a/platform-bible-react/functions/SettingsListHeader.html +++ b/platform-bible-react/functions/SettingsListHeader.html @@ -1,3 +1,3 @@ SettingsListHeader | platform-bible-react

                Function SettingsListHeader

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/SettingsListItem.html b/platform-bible-react/functions/SettingsListItem.html index 4f8b442122..f17b0bedf0 100644 --- a/platform-bible-react/functions/SettingsListItem.html +++ b/platform-bible-react/functions/SettingsListItem.html @@ -1,3 +1,3 @@ SettingsListItem | platform-bible-react

                Function SettingsListItem

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/ShadCnSlider.html b/platform-bible-react/functions/ShadCnSlider.html index aa5189868b..f8b66c6a9e 100644 --- a/platform-bible-react/functions/ShadCnSlider.html +++ b/platform-bible-react/functions/ShadCnSlider.html @@ -1,4 +1,4 @@ -ShadCnSlider | platform-bible-react

                Properties

                $$typeof +ShadCnSlider | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ShadCnSwitch.html b/platform-bible-react/functions/ShadCnSwitch.html index 0bed4834ca..ef1a11f974 100644 --- a/platform-bible-react/functions/ShadCnSwitch.html +++ b/platform-bible-react/functions/ShadCnSwitch.html @@ -1,4 +1,4 @@ -ShadCnSwitch | platform-bible-react

                Properties

                $$typeof +ShadCnSwitch | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index c0cde1ce47..1d80074e58 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index 3d194887f7..030ed93e29 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Spinner.html b/platform-bible-react/functions/Spinner.html index 6ebf3dcd5d..fc3045a34e 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 fb9e08fa46..6f44130a4b 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index c4b4580b9c..3fbe7a0de8 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 68b86ba357..26ad6fc2c4 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 a815f0a70f..9eb59f0d24 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 beb3e6873c..15adc4f8dd 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 51377275d4..3924e93611 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 f6320d0621..b3d0203613 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 17fb0dcec1..2ea4bbb7f7 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 253a8a2e1c..5f10964d74 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 27eb2ba0a4..30df5b926c 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 a225caf4f0..facee1db68 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 16d69286d1..a64334241f 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 f4ae84322d..d623c0ceac 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 a9e204907a..8a4252c32d 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index fdfadcafeb..3af8915ecb 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react
                \ No newline at end of file +Toolbar | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index 4aef648caa..68209330f7 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index cdbf7f2296..68d9998c12 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

                Function VersionHistory

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 56220a19eb..1dab29f3c2 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 767d2d8b26..6ce170279a 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

                Function VerticalTabsContent

                Properties

                $$typeof +VerticalTabsContent | platform-bible-react

                Function VerticalTabsContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 3fb9255735..7b186347e3 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

                Function VerticalTabsList

                Properties

                $$typeof +VerticalTabsList | platform-bible-react

                Function VerticalTabsList

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index e028ce63b6..f3dc666469 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

                Function VerticalTabsTrigger

                Properties

                $$typeof +VerticalTabsTrigger | platform-bible-react

                Function VerticalTabsTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index cabe9a7e59..62ef025459 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

                Function buttonVariants

                • Parameters

                  • Optional props: 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

                \ No newline at end of file +buttonVariants | platform-bible-react

                Function buttonVariants

                • Parameters

                  • Optional props: 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

                \ No newline at end of file diff --git a/platform-bible-react/functions/getSortingIcon.html b/platform-bible-react/functions/getSortingIcon.html index d49c8a3836..535e2a927a 100644 --- a/platform-bible-react/functions/getSortingIcon.html +++ b/platform-bible-react/functions/getSortingIcon.html @@ -2,4 +2,4 @@

                Parameters

                • sortDirection: false | SortDirection

                  Sorting direction. Can be ascending ('asc'), descending ('desc') or false ( i.e. not sorted)

                Returns ReactNode

                The appropriate sorting icon for the provided sorting direction

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index ffc1d9f38e..fca35c9618 100644 --- a/platform-bible-react/functions/inventoryCountColumn.html +++ b/platform-bible-react/functions/inventoryCountColumn.html @@ -1,4 +1,4 @@ inventoryCountColumn | platform-bible-react

                Function inventoryCountColumn

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index 49916b2a4c..ffca036fdf 100644 --- a/platform-bible-react/functions/inventoryItemColumn.html +++ b/platform-bible-react/functions/inventoryItemColumn.html @@ -1,4 +1,4 @@ inventoryItemColumn | platform-bible-react

                Function inventoryItemColumn

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index eaedb097d6..dd4d3bc8dc 100644 --- a/platform-bible-react/functions/inventoryStatusColumn.html +++ b/platform-bible-react/functions/inventoryStatusColumn.html @@ -2,4 +2,4 @@ component.

                Parameters

                • statusLabel: string
                • statusChangeHandler: ((items, status) => void)

                  Callback function that handles status updates to selected item(s)

                    • (items, status): void
                    • Parameters

                      Returns void

                Returns ColumnDef<ItemData>

                Column that shows the status of the related inventory items.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index 8b34b30150..37c32f6f94 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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index e9903c0494..f65a97593f 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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index f25401cb25..1777e7b9c2 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
              • -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 120df85b04..33a2b882ce 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

                Interface ButtonProps

                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?: string;
                    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;
                    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>;
                    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadataCapture?: 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

                Interface ButtonProps

                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?: string;
                    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;
                    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>;
                    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadataCapture?: 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.

                See

                aria-valuetext.

                aria-valuetext?: string

                Defines the human readable text alternative of aria-valuenow for a range widget.

                -
                asChild?: boolean
                autoCapitalize?: string
                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;
                }

                Type declaration

                • __html: string | TrustedHTML
                datatype?: string
                defaultChecked?: boolean
                defaultValue?: string | number | readonly string[]
                dir?: string
                disabled?: boolean
                draggable?: Booleanish
                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?: string
                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;
                }

                Type declaration

                • __html: string | TrustedHTML
                datatype?: string
                defaultChecked?: boolean
                defaultValue?: string | number | readonly string[]
                dir?: string
                disabled?: boolean
                draggable?: Booleanish
                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>

                Deprecated

                onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
                onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
                onLoad?: ReactEventHandler<HTMLButtonElement>
                onLoadCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadStart?: ReactEventHandler<HTMLButtonElement>
                onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedData?: ReactEventHandler<HTMLButtonElement>
                onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadataCapture?: 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
                \ No newline at end of file +
                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>

                Deprecated

                onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
                onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
                onLoad?: ReactEventHandler<HTMLButtonElement>
                onLoadCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadStart?: ReactEventHandler<HTMLButtonElement>
                onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedData?: ReactEventHandler<HTMLButtonElement>
                onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadataCapture?: 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
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index f7c736960d..566cd4c7fe 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

                Interface CommandHandler

                interface CommandHandler ((command) => void)
                \ No newline at end of file +CommandHandler | platform-bible-react

                Interface CommandHandler

                interface CommandHandler ((command) => void)
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 2cbb80d5b5..9d800c8633 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

                Interface MultiColumnMenuProvider

                interface MultiColumnMenuProvider ((isSupportAndDevelopment) => 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;
                    })[];
                }>)
                • 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;
                      })[];
                  }>

                \ No newline at end of file +MultiColumnMenuProvider | platform-bible-react

                Interface MultiColumnMenuProvider

                interface MultiColumnMenuProvider ((isSupportAndDevelopment) => 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;
                    })[];
                }>)
                • 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;
                      })[];
                  }>

                \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index aa557da5ed..a721e6c98c 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react
                \ No newline at end of file +AnchorOrigin | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 0e86644551..f6ba261eec 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

                Type alias ChapterRangeSelectorProps

                ChapterRangeSelectorProps: {
                    chapterCount: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                }

                Type declaration

                • chapterCount: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

                Type alias ChapterRangeSelectorProps

                ChapterRangeSelectorProps: {
                    chapterCount: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                }

                Type declaration

                • chapterCount: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index 1c4e3a52db..e3caf89999 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@
                  • (event): void
                  • Parameters

                    • event: ChangeEvent<HTMLInputElement>

                      The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

                      -

                    Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index e54045cddb..9173a15d01 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -6,4 +6,4 @@
              • Optional legend?: string

                Optional string representing legend for fieldset element

              • listItems: string[]

                Array of strings representing the legend text for the fieldset element

              • selectedListItems: string[]

                Array of strings representing items to be displayed as checkboxes in the checklist

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index c0df68228f..846a578dba 100644 --- a/platform-bible-react/types/CloseReason.html +++ b/platform-bible-react/types/CloseReason.html @@ -1 +1 @@ -CloseReason | platform-bible-react
                \ No newline at end of file +CloseReason | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index 49dcbf544c..2fde573f68 100644 --- a/platform-bible-react/types/ColumnDef.html +++ b/platform-bible-react/types/ColumnDef.html @@ -1 +1 @@ -ColumnDef | platform-bible-react

                Type alias ColumnDef<TData, TValue>

                ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

                Type Parameters

                • TData
                • TValue = unknown
                \ No newline at end of file +ColumnDef | platform-bible-react

                Type alias ColumnDef<TData, TValue>

                ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

                Type Parameters

                • TData
                • TValue = unknown
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index 35b510d1c7..4391621dd3 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

                Type alias ComboBoxLabelOption

                ComboBoxLabelOption: {
                    label: string;
                }

                Type declaration

                • label: string
                \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

                Type alias ComboBoxLabelOption

                ComboBoxLabelOption: {
                    label: string;
                }

                Type declaration

                • label: string
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index bfe86db4ee..908a4f108d 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react
                \ No newline at end of file +ComboBoxOption | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index 162d407d5d..44a3a4c0ce 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -10,4 +10,4 @@
              • Optional textPlaceholder?: string

                Placeholder text for text field

              • Optional value?: T

                The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index 06e75edf66..79df36dd65 100644 --- a/platform-bible-react/types/DropdownGroup.html +++ b/platform-bible-react/types/DropdownGroup.html @@ -1,4 +1,4 @@ DropdownGroup | platform-bible-react

                Type alias DropdownGroup

                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.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index a276363359..b2b0f9b589 100644 --- a/platform-bible-react/types/DropdownItem.html +++ b/platform-bible-react/types/DropdownItem.html @@ -1,4 +1,4 @@ DropdownItem | platform-bible-react

                Type alias DropdownItem

                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

                \ No newline at end of file +
                  • (): void
                  • Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index b3d7bc7bc5..5bfe5b7751 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

                Type alias DropdownMenuCheckboxItemProps

                DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
                    checked?: boolean;
                    className?: string;
                }

                Type declaration

                • Optional checked?: boolean
                • Optional className?: string
                \ No newline at end of file +DropdownMenuCheckboxItemProps | platform-bible-react

                Type alias DropdownMenuCheckboxItemProps

                DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
                    checked?: boolean;
                    className?: string;
                }

                Type declaration

                • Optional checked?: boolean
                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index 72e5397520..07483b0f5f 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

                Type alias DropdownMenuContentProps

                DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
                    className?: string;
                    sideOffset?: number;
                }

                Type declaration

                • Optional className?: string
                • Optional sideOffset?: number
                \ No newline at end of file +DropdownMenuContentProps | platform-bible-react

                Type alias DropdownMenuContentProps

                DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
                    className?: string;
                    sideOffset?: number;
                }

                Type declaration

                • Optional className?: string
                • Optional sideOffset?: number
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index 6f289b3326..77509904fb 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

                Type alias DropdownMenuItemProps

                DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuItemProps | platform-bible-react

                Type alias DropdownMenuItemProps

                DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index 7c3812a1c1..85fbd9545c 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

                Type alias DropdownMenuLabelProps

                DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuLabelProps | platform-bible-react

                Type alias DropdownMenuLabelProps

                DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index f7cd5050b4..979fd46017 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

                Type alias DropdownMenuRadioItemProps

                DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuRadioItemProps | platform-bible-react

                Type alias DropdownMenuRadioItemProps

                DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index a8579ad937..119b938338 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

                Type alias DropdownMenuSeparatorProps

                DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuSeparatorProps | platform-bible-react

                Type alias DropdownMenuSeparatorProps

                DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 2b220c1093..f89be840a0 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

                Type alias DropdownMenuShortcutProps

                DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuShortcutProps | platform-bible-react

                Type alias DropdownMenuShortcutProps

                DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index c422d3c65e..cd8fa74b48 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

                Type alias DropdownMenuSubContentProps

                DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuSubContentProps | platform-bible-react

                Type alias DropdownMenuSubContentProps

                DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index ae38b4bb3e..237bf2857e 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

                Type alias DropdownMenuSubTriggerProps

                DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuSubTriggerProps | platform-bible-react

                Type alias DropdownMenuSubTriggerProps

                DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 76066f8a61..ddb19978a4 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

                Type alias GridMenuInfo

                GridMenuInfo: {
                    multiColumnMenu: Localized<MultiColumnMenu>;
                }

                Type declaration

                • multiColumnMenu: Localized<MultiColumnMenu>

                  The menu object containing information about the columns, groups, and items to display.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 943eb41824..5790061b53 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

                Type alias GridMenuProps

                GridMenuProps: GridMenuInfo & {
                    className?: string;
                    commandHandler: CommandHandler;
                    id?: string;
                }

                Type declaration

                • Optional className?: string

                  Additional css classes to help with unique styling of the grid menu

                • commandHandler: CommandHandler
                • Optional id?: string

                  Optional unique identifier

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 2c32437869..980a087f70 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -16,4 +16,4 @@

                Default

                false
                 
              • Optional tooltip?: string

                Optional tooltip to display if different from the aria-label.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index c43aa0b45d..bdfd658f57 100644 --- a/platform-bible-react/types/InventoryLocalizedStrings.html +++ b/platform-bible-react/types/InventoryLocalizedStrings.html @@ -1 +1 @@ -InventoryLocalizedStrings | platform-bible-react

                Type alias InventoryLocalizedStrings

                InventoryLocalizedStrings: {
                    [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
                }
                \ No newline at end of file +InventoryLocalizedStrings | platform-bible-react

                Type alias InventoryLocalizedStrings

                InventoryLocalizedStrings: {
                    [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
                }
                \ No newline at end of file diff --git a/platform-bible-react/types/ItemData.html b/platform-bible-react/types/ItemData.html index cca41776a8..5934be5709 100644 --- a/platform-bible-react/types/ItemData.html +++ b/platform-bible-react/types/ItemData.html @@ -1 +1 @@ -ItemData | platform-bible-react

                Type alias ItemData

                ItemData: {
                    count: number;
                    item: string;
                    status: Status;
                }

                Type declaration

                • count: number
                • item: string
                • status: Status
                \ No newline at end of file +ItemData | platform-bible-react

                Type alias ItemData

                ItemData: {
                    count: number;
                    item: string;
                    status: Status;
                }

                Type declaration

                • count: number
                • item: string
                • status: Status
                \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 7e34861e8b..9f66098b78 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

                Type alias MenuItemListProps

                MenuItemListProps: MenuPropsBase & {
                    columnId?: ReferencedItem;
                }

                Type declaration

                • Optional columnId?: ReferencedItem

                  Optional unique (column) identifier

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index 0fb8edc5d9..59715fa35b 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.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index a2238be406..c34f5b263e 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.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index 57efbaf62c..cded921ec6 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react
                \ No newline at end of file +RowContents | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/Scope.html b/platform-bible-react/types/Scope.html index 4192f0542f..e329f9803a 100644 --- a/platform-bible-react/types/Scope.html +++ b/platform-bible-react/types/Scope.html @@ -1 +1 @@ -Scope | platform-bible-react
                \ No newline at end of file +Scope | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index 5d9b827cb7..8dd0647a20 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.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index 33abf1404a..bf0b84d1b6 100644 --- a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html +++ b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html @@ -2,4 +2,4 @@
              • Optional scriptureBookGroupName?: string

                Optional text to display to refer to the Scripture book group. Default value: 'Scripture Book'.

              • Optional scriptureReferenceColumnName?: string

                Optional header to display for the Reference column. Default value: 'Scripture Reference'.

              • Optional typeColumnName?: string

                Optional header to display for the Type column. Default value: 'Type'.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index f6e0dd5bd1..f294b59a70 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -3,4 +3,4 @@
              • Optional showColumnHeaders?: boolean

                Flag indicating whether to display column headers. Default is false.

              • Optional showSourceColumn?: boolean

                Flag indicating whether to display source column. Default is false.

              • sources: ResultsSet[]

                Groups of ScriptureItemDetail objects from particular sources (e.g., Scripture checks)

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index ab4364c8a5..81a92cf1ba 100644 --- a/platform-bible-react/types/ScriptureSrcItemDetail.html +++ b/platform-bible-react/types/ScriptureSrcItemDetail.html @@ -1,2 +1,2 @@ ScriptureSrcItemDetail | platform-bible-react

                Type alias ScriptureSrcItemDetail

                ScriptureSrcItemDetail: ScriptureItemDetail & {
                    source: ResultsSource;
                }

                Type declaration

                • source: ResultsSource

                  Source/type of detail. Can be used for grouping.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ScrollGroupSelectorProps.html b/platform-bible-react/types/ScrollGroupSelectorProps.html index 05ac75ad34..995b5517c6 100644 --- a/platform-bible-react/types/ScrollGroupSelectorProps.html +++ b/platform-bible-react/types/ScrollGroupSelectorProps.html @@ -15,4 +15,4 @@

                Example

                const<
                 
              • onChangeScrollGroupId: ((newScrollGroupId) => 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index bc54acac36..94cd5adfc0 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

                Type alias SearchBarProps

                SearchBarProps: {
                    isFullWidth?: boolean;
                    onSearch: ((searchQuery) => void);
                    placeholder?: string;
                }

                Type declaration

                • Optional isFullWidth?: boolean

                  Optional boolean to set the input base to full width

                • onSearch: ((searchQuery) => void)

                  Callback fired to handle the search query when button pressed

                    • (searchQuery): void
                    • Parameters

                      • searchQuery: string

                      Returns void

                • Optional placeholder?: string

                  Optional string that appears in the search bar without a search string

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index 188841d42b..7e447f2894 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -40,4 +40,4 @@

                Default

                'off'
                 
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index 2e521f33a7..89a655d6ea 100644 --- a/platform-bible-react/types/SnackbarContentProps.html +++ b/platform-bible-react/types/SnackbarContentProps.html @@ -1,4 +1,4 @@ SnackbarContentProps | platform-bible-react

                Type alias SnackbarContentProps

                SnackbarContentProps: {
                    action?: ReactNode;
                    className?: string;
                    message?: ReactNode;
                }

                Type declaration

                • Optional action?: ReactNode

                  The action to display, renders after the message

                • Optional className?: string

                  Additional css classes to help with unique styling of the snackbar, internal

                • Optional message?: ReactNode

                  The message to display

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 52e8cbf21e..820be5bcba 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -12,4 +12,4 @@
              • Optional onClose?: ((event, reason) => void)

                Optional, used to control the open prop event: Event | SyntheticEvent<Element, Event>, reason: string

                -
                  • (event, reason): void
                  • Parameters

                    • event: Event | SyntheticEvent<Element, Event>
                    • reason: CloseReason

                    Returns void

              • \ No newline at end of file +
                  • (event, reason): void
                  • Parameters

                    • event: Event | SyntheticEvent<Element, Event>
                    • reason: CloseReason

                    Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 81c248e1a9..bc2f47f9b0 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react
                \ No newline at end of file +SortDirection | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/SpinnerProps.html b/platform-bible-react/types/SpinnerProps.html index 0f0e536fc4..a296140297 100644 --- a/platform-bible-react/types/SpinnerProps.html +++ b/platform-bible-react/types/SpinnerProps.html @@ -1 +1 @@ -SpinnerProps | platform-bible-react
                \ No newline at end of file +SpinnerProps | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/Status.html b/platform-bible-react/types/Status.html index eb366a5324..5e2152a939 100644 --- a/platform-bible-react/types/Status.html +++ b/platform-bible-react/types/Status.html @@ -1 +1 @@ -Status | platform-bible-react
                \ No newline at end of file +Status | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 99a375822f..b730beeac8 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@
                  • (event): void
                  • Parameters

                    • event: ChangeEvent<HTMLInputElement>

                      The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

                      -

                    Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/TabKeyValueContent.html b/platform-bible-react/types/TabKeyValueContent.html index 273cdc7a1b..444fc9eed2 100644 --- a/platform-bible-react/types/TabKeyValueContent.html +++ b/platform-bible-react/types/TabKeyValueContent.html @@ -1 +1 @@ -TabKeyValueContent | platform-bible-react

                Type alias TabKeyValueContent

                TabKeyValueContent: {
                    content: ReactNode;
                    key: string;
                    value: string;
                }

                Type declaration

                • content: ReactNode
                • key: string
                • value: string
                \ No newline at end of file +TabKeyValueContent | platform-bible-react

                Type alias TabKeyValueContent

                TabKeyValueContent: {
                    content: ReactNode;
                    key: string;
                    value: string;
                }

                Type declaration

                • content: ReactNode
                • key: string
                • value: string
                \ No newline at end of file diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index d7fcd2388f..789d2ccaff 100644 --- a/platform-bible-react/types/TableContents.html +++ b/platform-bible-react/types/TableContents.html @@ -1 +1 @@ -TableContents | platform-bible-react

                Type alias TableContents<TData>

                TableContents<TData>: TSTable<TData>

                Type Parameters

                • TData
                \ No newline at end of file +TableContents | platform-bible-react

                Type alias TableContents<TData>

                TableContents<TData>: TSTable<TData>

                Type Parameters

                • TData
                \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index ce24249c20..cddad9cfce 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -20,4 +20,4 @@
              • Optional onFocus?: FocusEventHandler<HTMLInputElement>

                Triggers when textfield gets focus

              • Optional placeholder?: string

                The short hint displayed in the input before the user enters a value.

              • Optional value?: string | number

                Value of the text field if controlled

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 22096d4c8d..0299bc9128 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
              • Optional id?: string

                Optional unique identifier

              • Optional menuProvider?: MultiColumnMenuProvider

                The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index ce71634c14..5b9cc89ce0 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

                Type alias UsePromiseOptions

                UsePromiseOptions: {
                    preserveValue?: boolean;
                }

                Type declaration

                • Optional preserveValue?: 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index 3755987920..90a823ecdc 100644 --- a/platform-bible-react/types/VersionHistoryType.html +++ b/platform-bible-react/types/VersionHistoryType.html @@ -1,2 +1,2 @@ VersionHistoryType | platform-bible-react

                Type alias VersionHistoryType

                VersionHistoryType: Record<string, VersionInformation>

                Type to store the version history information

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index 005b7e5213..1f386f2d50 100644 --- a/platform-bible-react/types/VersionInformation.html +++ b/platform-bible-react/types/VersionInformation.html @@ -1,3 +1,3 @@ VersionInformation | platform-bible-react

                Type alias VersionInformation

                VersionInformation: {
                    date: string;
                    description: string;
                }

                Type declaration

                • date: string

                  Date the version was published

                • description: string

                  Description of the changes in the version

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index f80184e167..103a24836f 100644 --- a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html +++ b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html @@ -2,4 +2,4 @@ component in Platform.Bible extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of the Inventory component

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 0c9ea78879..c7bb353ab0 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

                Class AsyncVariable<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

                Properties

                promiseToValue rejecter resolver @@ -14,18 +14,18 @@
              • 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>

                Properties

                promiseToValue: Promise<T>
                rejecter: undefined | ((reason) => void)

                Type declaration

                  • (reason): void
                  • Parameters

                    • reason: undefined | string

                    Returns void

                resolver: undefined | ((value) => void)

                Type declaration

                  • (value): void
                  • Parameters

                    • value: T

                    Returns void

                variableName: string

                Accessors

                • get hasSettled(): boolean
                • A simple way to see if this variable's promise was resolved or rejected already

                  +

                Returns AsyncVariable<T>

                Properties

                promiseToValue: Promise<T>
                rejecter: undefined | ((reason) => void)

                Type declaration

                  • (reason): void
                  • Parameters

                    • reason: undefined | string

                    Returns void

                resolver: undefined | ((value) => void)

                Type declaration

                  • (value): void
                  • Parameters

                    • value: T

                    Returns void

                variableName: string

                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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index 662327cd69..82b80bbb90 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,15 +1,15 @@ Collator | platform-bible-utils

                Enables language-sensitive string comparison. Wraps Intl.Collator

                -

                Constructors

                Constructors

                Properties

                Methods

                Constructors

                Properties

                collator: Collator

                Methods

                • Compares two strings according to the sort order of this Collator object

                  +

                Constructors

                Properties

                collator: Collator

                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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index 78aeb98523..19c302ebc0 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,30 +1,30 @@ DateTimeFormat | platform-bible-utils

                Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

                -

                Constructors

                Constructors

                Properties

                dateTimeFormatter: DateTimeFormat

                Methods

                • Formats a date according to the locale and formatting option for this DateTimeFormat object

                  +

                Constructors

                Properties

                dateTimeFormatter: DateTimeFormat

                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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 0df5a69f43..977355893e 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

                -
                onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

                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

                +
                onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

                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,22 +33,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.

                  @@ -56,19 +56,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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index a87796d517..72b46f5ed8 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -3,7 +3,7 @@

                Example

                const mutex = new Mutex();

                mutex.runExclusive(async () => {
                // Do some asynchronous stuff
                console.log('These run one-at-a-time');
                });

                mutex.runExclusive(async () => {
                // Do some asynchronous stuff
                console.log('These run one-at-a-time');
                });

                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 3167edf0f5..963fb23776 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,5 +1,5 @@ MutexMap | platform-bible-utils

                Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

                -

                Constructors

                Constructors

                Properties

                Methods

                get -

                Constructors

                Properties

                mutexesByID: Map<string, Mutex> = ...

                Methods

                \ No newline at end of file +

                Constructors

                Properties

                mutexesByID: Map<string, Mutex> = ...

                Methods

                \ No newline at end of file diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 9931af845d..0ff38602cb 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

                Class NonValidatingDocumentCombiner

                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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index 7a3831f0ef..63d3b8961c 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,31 +1,31 @@ NumberFormat | platform-bible-utils

                Enables language-sensitive number formatting. Wraps Intl.NumberFormat

                -

                Constructors

                Constructors

                Properties

                numberFormatter: NumberFormat

                Methods

                • Formats a number according to the locale and formatting options of this NumberFormat object

                  +

                Constructors

                Properties

                numberFormatter: NumberFormat

                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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 0ae0ea3ae9..77ef4c76d4 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

                Constructors

                Properties

                isDisposed: boolean = false

                Whether this emitter has been disposed

                -
                lazyEvent?: PlatformEvent<T>

                Event for listeners to subscribe to. Lazy loaded

                -
                subscribe: PlatformEvent<T> = ...

                Subscribes a function to run when this event is emitted.

                +
                lazyEvent?: PlatformEvent<T>

                Event for listeners to subscribe to. Lazy loaded

                +
                subscribe: PlatformEvent<T> = ...

                Subscribes a function to run when this event is emitted.

                Param: callback

                Function to run with the event when it is emitted

                Returns

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

                Alias

                event

                -
                subscriptions?: PlatformEventHandler<T>[]

                All callback functions that will run when this event is emitted. Lazy loaded

                -

                Accessors

                subscriptions?: PlatformEventHandler<T>[]

                All callback functions that will run when this event is emitted. Lazy loaded

                +

                Accessors

                Methods

                Methods

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

                Returns void

                \ No newline at end of file +

                Parameters

                • event: T

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 3d4bb4d95c..1bd395dc11 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,11 +1,11 @@ UnsubscriberAsyncList | platform-bible-utils

                Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

                -

                Constructors

                Constructors

                Properties

                Methods

                Constructors

                Properties

                name: string = 'Anonymous'
                unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

                Methods

                • Add unsubscribers to the list. Note that duplicates are not added twice.

                  +

                Constructors

                Properties

                name: string = 'Anonymous'
                unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

                Methods

                • Run all unsubscribers added to this list and then clear the list.

                  +

                Returns void

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 828be6c141..b5eb28cb95 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

                Function aggregateUnsubscriberAsyncs

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index a21ce34743..fdcf6a0a6c 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

                Function aggregateUnsubscribers

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 4269e7e18f..819f1b0256 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 5fc046ea58..54a56b68d8 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index 8b82623606..1a40bd7cb1 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index 1857b3521f..cc9d1b23cf 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 9c44fcf51b..8fc708f689 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index da65072dd0..61fa693092 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 3abb8c4661..645c6645b0 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 9ea3638b52..53a477d937 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 03729bb8c6..eeec430244 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

                \ No newline at end of file +

                Returns any

                \ No newline at end of file diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 11b7aa6542..f8fe360e8c 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/ensureArray.html b/platform-bible-utils/functions/ensureArray.html index 17017d5f1d..41cff90533 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index ccd06b90f5..49da76ae5f 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -5,4 +5,4 @@ function is simply copied directly from there to allow a common js export

                Parameters

                • string: string

                Returns string

                Example

                import escapeStringRegexp from 'platform-bible-utils';

                const escapedString = escapeStringRegexp('How much $ for a 🦄?');
                //=> 'How much \\$ for a 🦄\\?'

                new RegExp(escapedString);
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index 90cfea467c..05437e6a80 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -7,4 +7,4 @@

                Example

                FormatBytes(1024, 0) => "1 KB"
                 
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index 089be7e344..08f49f8b6c 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -13,4 +13,4 @@

                Returns string

                Formatted string

                Example

                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.'
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index d2c59b2dcb..e15b3b1d6d 100644 --- a/platform-bible-utils/functions/formatScrRef.html +++ b/platform-bible-utils/functions/formatScrRef.html @@ -9,4 +9,4 @@
              • Optional bookChapterSeparator: 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 5a94235ab3..f7785ef607 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 18768b1cbe..51e8c24822 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

                Function getChaptersForBook

                \ No newline at end of file +getChaptersForBook | platform-bible-utils

                Function getChaptersForBook

                \ No newline at end of file diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index 47df876ea5..17b9e73169 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

                Function getCurrentLocale

                • 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.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 0a5528fae4..3332e6f454 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -5,4 +5,4 @@ stringify

                Example

                `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
                 
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html index 00a9b0a9d0..978585c532 100644 --- a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html +++ b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html @@ -1,2 +1,2 @@ getLocalizeKeyForScrollGroupId | platform-bible-utils

                Function getLocalizeKeyForScrollGroupId

                \ No newline at end of file +

                Parameters

                • scrollGroupId: undefined | number | "undefined"

                Returns LocalizeKey

                \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html index 8f61e1ba5e..19de681828 100644 --- a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html +++ b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html @@ -4,4 +4,4 @@

                Returns `%${string}%`[]

                List of localized string keys for scroll group Ids

                Example

                getLocalizeKeysForScrollGroupIds([undefined, 0, 1, 2, 3, 4]);
                // Gives localized string keys for the provided scroll group ids in an array
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index db638d4645..8d1170a6c2 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) => Promise<string>)

                  Function that provides the localized versions of the book ids and names asynchronously.

                  -
                    • (item): Promise<string>
                    • Parameters

                      • item: {
                            languagesToSearch?: string[];
                            localizeKey: string;
                        }
                        • Optional languagesToSearch?: string[]
                        • localizeKey: string

                      Returns Promise<string>

                Returns Promise<string>

                \ No newline at end of file +

                Returns Promise<string>

                \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 8e089fb006..e3792894cc 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) => 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) => K)
                    • (item): K
                    • Parameters

                      • item: T

                      Returns K

                • valueSelector: ((item, key) => V)
                    • (item, key): V
                    • Parameters

                      • item: T
                      • key: K

                      Returns V

                Returns Map<K, V[]>

              • \ No newline at end of file +
              • Type Parameters

                • T
                • K
                • V

                Parameters

                • items: T[]
                • keySelector: ((item) => K)
                    • (item): K
                    • Parameters

                      • item: T

                      Returns K

                • valueSelector: ((item, key) => V)
                    • (item, key): V
                    • Parameters

                      • item: T
                      • key: K

                      Returns V

                Returns Map<K, V[]>

              • \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index a53016b323..522f06f52b 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index 5a84a52235..1e07706e76 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index b1640e0604..f162b5037d 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index 0b6ea4951c..beba9673c2 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

                Function isLocalizeKey

                • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

                  -

                  Parameters

                  • str: string

                  Returns str is `%${string}%`

                \ No newline at end of file +

                Parameters

                • str: string

                Returns str is `%${string}%`

                \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 9df4020da7..1968acd7ff 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 0f2a9cce67..c5bfb7bc10 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 152318a0aa..5edb41c390 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -13,4 +13,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].

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 26967bac9e..eab421e674 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
              • Optional position: 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index 7881e0f698..24e62e7dfa 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils
                \ No newline at end of file +

                Returns string

                \ No newline at end of file diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index a7d7fb2faa..bd82f9e1e4 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index f9292bc9a4..7ace74e957 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils
                \ No newline at end of file +offsetBook | platform-bible-utils
                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 36c96cf98e..ddbfd2867f 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

                Function offsetChapter

                \ No newline at end of file +offsetChapter | platform-bible-utils

                Function offsetChapter

                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index ab7512119a..bc2ba12feb 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils
                \ No newline at end of file +offsetVerse | platform-bible-utils
                \ No newline at end of file diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 28112930a6..39940c94fa 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index c013050dbb..287a5e2289 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index a7b1f7f215..8d923e6868 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index 034b253d25..8c67fe5823 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 3d2bc9e962..6776e1ed9e 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
              • Optional space: 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

                \ No newline at end of file +

                Returns string

                \ No newline at end of file diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index af5a12ca5f..a32bcb783c 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.

              • Optional indexEnd: 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index d422fb7911..8ad5af1c28 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index a981e354d1..c2a5481ef4 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 921ee93834..0c0768112b 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 24bd6eb12b..95db3002ec 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index f4a78c6cb1..caab41af46 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html index a3368ff825..5604636677 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html index a1689b74f3..9814146a79 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 66214f16aa..22cfcc2a79 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>

                \ No newline at end of file +

                Parameters

                • ms: number

                Returns Promise<void>

                \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 4edf072d22..e5e3f81094 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 60cf982e03..fb8cdb4734 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
                \ No newline at end of file +

                Properties

                chapters: number
                fullNames: string[]
                shortName: string
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 0165721a9c..92f0870d47 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

                Interface CannotHaveOnDidDispose

                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

                -
                \ No newline at end of file +
                onDidDispose?: undefined

                Event that emits when dispose is called on an object

                +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 70b358123a..dc12f86c42 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index a7c1abb449..4eb7e77dc7 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

                Interface LanguageStrings

                Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

                -
                interface LanguageStrings {
                    [k: LocalizeKey]: LocalizedStringValue;
                }

                Indexable

                \ No newline at end of file +
                interface LanguageStrings {
                    [k: LocalizeKey]: LocalizedStringValue;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index 5701e7f81b..ef70b75514 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

                Interface LocalizedStringDataContribution

                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;
                }

                Type declaration

                metadata?: StringsMetadata
                \ No newline at end of file +

                Properties

                localizedStrings?: {
                    [k: string]: LanguageStrings;
                }

                Type declaration

                metadata?: StringsMetadata
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index 731d3166b1..ad933799b9 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

                Interface ModifierExtensionControlled

                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
                \ No newline at end of file +

                Properties

                platformType?: undefined
                type?: undefined
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index d58d0ea045..18c1b07b75 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

                Interface ModifierProject

                interface ModifierProject {
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                }

                Properties

                excludePdpFactoryIds? +ModifierProject | platform-bible-utils

                Interface ModifierProject

                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 @@ -35,13 +35,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.

                @@ -67,4 +67,4 @@
              • Include one
              • Include both two and three.
              • -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 053a695c5c..c8e5eb100f 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

                Interface OnDidDispose

                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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 44083eec5c..439f653cd2 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

                Interface ProjectSettingProperties

                Object whose keys are setting IDs and whose values are settings objects

                -
                interface ProjectSettingProperties {
                    [k: ReferencedItem]: ProjectSetting;
                }

                Indexable

                \ No newline at end of file +
                interface ProjectSettingProperties {
                    [k: ReferencedItem]: ProjectSetting;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index ad1b4c18c8..9179d73234 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

                Interface ProjectSettingsGroup

                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

                -
                \ No newline at end of file +
                label: `%${string}%`

                LocalizeKey that displays in the project settings dialog as the group name

                +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 2fc43f62fc..0b9632fc42 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

                Interface ProjectStateContribution

                The data an extension provides to inform Platform.Bible of the project state it provides

                -
                interface ProjectStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file +
                interface ProjectStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index e1f62da043..fbee6cab89 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

                Interface ScriptureReference

                interface ScriptureReference {
                    bookNum: number;
                    chapterNum: number;
                    verseNum: number;
                }

                Properties

                bookNum +ScriptureReference | platform-bible-utils

                Interface ScriptureReference

                interface ScriptureReference {
                    bookNum: number;
                    chapterNum: number;
                    verseNum: number;
                }

                Properties

                bookNum: number
                chapterNum: number
                verseNum: number
                \ No newline at end of file +

                Properties

                bookNum: number
                chapterNum: number
                verseNum: number
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index 8720936384..3efd5baed4 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

                Interface SettingProperties

                Object whose keys are setting IDs and whose values are settings objects

                -
                interface SettingProperties {
                    [k: ReferencedItem]: Setting;
                }

                Indexable

                \ No newline at end of file +
                interface SettingProperties {
                    [k: ReferencedItem]: Setting;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index 0ba803f635..83136897fb 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

                Interface SettingsGroup

                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
                \ No newline at end of file +
                label: `%${string}%`

                LocalizeKey that displays in the settings dialog as the group name

                +
                properties: SettingProperties
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index e53cd3af34..ae4cf83ae2 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index a7a730ec03..8715af8e0c 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,11 +1,11 @@ StringMetadata | platform-bible-utils

                Interface StringMetadata

                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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index 6f5bcdf40a..63d503b153 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

                Interface StringsMetadata

                Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

                -
                interface StringsMetadata {
                    [k: LocalizeKey]: StringMetadata;
                }

                Indexable

                \ No newline at end of file +
                interface StringsMetadata {
                    [k: LocalizeKey]: StringMetadata;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index 2aea52e883..b0a45cbe76 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

                Interface UserStateContribution

                The data an extension provides to inform Platform.Bible of the user state it provides

                -
                interface UserStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file +
                interface UserStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 1f0c361515..51ebcc39e1 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

                Type alias CanHaveOnDidDispose<T>

                CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

                Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

                -

                Type Parameters

                \ No newline at end of file +

                Type Parameters

                \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 49531aaa64..fb1192c4ea 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

                Type alias ColumnsWithHeaders

                ColumnsWithHeaders: {
                    isExtensible?: boolean;
                    [property: ReferencedItem]: MenuColumnWithHeader;
                }

                Group of columns that can be combined with other columns to form a multi-column menu

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 308804982e..e0015c49c1 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

                Type alias DeepPartial<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
                \ No newline at end of file +

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 9e267df7c9..a27874f7ad 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. -

                Type declaration

                • copyDocuments: boolean
                • ignoreDuplicateProperties: boolean
                \ No newline at end of file +

                Type declaration

                • copyDocuments: boolean
                • ignoreDuplicateProperties: boolean
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index a0f8ee5ea8..8af458dd54 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

                Type alias ExtensionControlledProjectSetting

                ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

                Setting definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index 64ac972681..b5335f71ac 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

                Type alias ExtensionControlledSetting

                ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

                Setting definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 21726edd15..b0a78d003e 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

                Type alias ExtensionControlledState

                ExtensionControlledState: StateBase & ModifierExtensionControlled

                State definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index e981d0e2b0..a2fadbf503 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

                Type alias GroupsInMultiColumnMenu

                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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 0b4dee81ba..f81d090484 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

                Type alias GroupsInSingleColumnMenu

                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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index e578a4fdcb..1152c788b3 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

                Type alias JsonDocumentLike

                JsonDocumentLike: JsonObjectLike | JsonArrayLike
                \ No newline at end of file +JsonDocumentLike | platform-bible-utils

                Type alias JsonDocumentLike

                JsonDocumentLike: JsonObjectLike | JsonArrayLike
                \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index e344afc970..e48032ad14 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

                Type alias LocalizeKey

                LocalizeKey: `%${string}%`

                Identifier for a string that will be localized in a menu based on the user's UI language

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index f9f320feb0..27cb6d0b31 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

                Type alias Localized<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
                \ No newline at end of file +

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 38070caebe..f3d6cb6c5d 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

                Type alias LocalizedStringValue

                LocalizedStringValue: string

                Localized string value associated with this key

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 5c5e31c224..61a15accb0 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

                Type alias MenuColumnWithHeader

                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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index e5237f721e..af64253261 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

                Type alias MenuGroupDetailsInColumn

                MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
                    column: ReferencedItem;
                }

                Group of menu items that belongs in a column

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index f5ec9572bf..2ece0cf4a3 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

                Type alias MenuGroupDetailsInSubMenu

                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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index 76a45532da..4ddf37d683 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

              • Optional searchTerms?: LocalizeKey

                Key that represents words the platform should reference when users are searching for menu items

              • Optional tooltip?: LocalizeKey

                Key that represents the text to display if a mouse pointer hovers over the menu item

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index 2366684171..de7f363cb2 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

              • Optional iconPathBefore?: string

                Uri path to the icon to display before the menu text. Ex: papi-extension://helloWorld/assets/icon.png

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 840aeb2a24..e41530ad67 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

                Type alias MenuItemContainingSubmenu

                MenuItemContainingSubmenu: MenuItemBase & {
                    id: ReferencedItem;
                }

                Menu item that hosts a submenu

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index facec67297..731c17300b 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index df35bd5670..da4f9a3b94 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

                Type alias OrderedExtensibleContainer

                OrderedExtensibleContainer: OrderedItem & {
                    isExtensible?: boolean;
                }

                Type declaration

                • Optional isExtensible?: boolean

                  Determines whether other items can be added to this after it has been defined

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index ac86b1c76f..8e63f0e196 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

                Type alias OrderedItem

                OrderedItem: {
                    order: number;
                }

                Type declaration

                • order: number

                  Relative order of this item compared to other items in the same parent/scope (sorted ascending)

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index ad6378cbfb..db16013559 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

                Type Parameters

                • T

                Type declaration

                Returns

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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index cc321563c6..33eb1fe85b 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

                Type alias PlatformEventAsync<T>

                PlatformEventAsync<T>: ((callback) => Promise<UnsubscriberAsync>)

                A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

                Note: The callback itself is not asynchronous.

                -

                Type Parameters

                • T

                Type declaration

                \ No newline at end of file +

                Type Parameters

                • T

                Type declaration

                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index c1568180af..98a1bca598 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

                Type alias PlatformEventHandler<T>

                PlatformEventHandler<T>: ((event) => void)

                Callback function that accepts an event and should run when an event is emitted

                -

                Type Parameters

                • T

                Type declaration

                  • (event): void
                  • Parameters

                    • event: T

                    Returns void

                \ No newline at end of file +

                Type Parameters

                • T

                Type declaration

                  • (event): void
                  • Parameters

                    • event: T

                    Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index ba2b56947a..97ea00935a 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 2df723fb89..14798da443 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

                Type alias ProjectSetting

                A description of an extension's setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index e11a6b1995..c8f02e647c 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

                Type alias ProjectSettingBase

                ProjectSettingBase: SettingBase & ModifierProject

                Base information needed to describe a project setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index 957c698319..8efa5d08c4 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

                Type alias ProjectSettingsContribution

                ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

                The data an extension provides to inform Platform.Bible of the project settings it provides

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 5a0d61979c..0dfcd4b3e6 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

                Type alias ReferencedItem

                ReferencedItem: `${string}.${string}`

                Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index b837140fad..151e61a579 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

                Type alias ReplaceType<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
                \ No newline at end of file +

                Type Parameters

                • T
                • A
                • B
                \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index a47b0f1f21..84ecca5078 100644 --- a/platform-bible-utils/types/ScriptureNode.html +++ b/platform-bible-utils/types/ScriptureNode.html @@ -1,3 +1,3 @@ ScriptureNode | platform-bible-utils

                Type alias ScriptureNode

                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.

                -

                Type declaration

                • jsonPath: string
                \ No newline at end of file +

                Type declaration

                • jsonPath: string
                \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index d0a7c94452..5101bc3bc5 100644 --- a/platform-bible-utils/types/ScriptureSelection.html +++ b/platform-bible-utils/types/ScriptureSelection.html @@ -1,3 +1,3 @@ ScriptureSelection | platform-bible-utils

                Type alias ScriptureSelection

                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.

                -

                Type declaration

                \ No newline at end of file +

                Type declaration

                \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index 91461e3a99..30ba514e00 100644 --- a/platform-bible-utils/types/ScriptureTextAnchor.html +++ b/platform-bible-utils/types/ScriptureTextAnchor.html @@ -1,2 +1,2 @@ ScriptureTextAnchor | platform-bible-utils

                Type alias ScriptureTextAnchor

                ScriptureTextAnchor: ScriptureNode & {
                    offset: number;
                }

                Represents a specific character offset in the text of a textual Scripture node (in the editor.)

                -

                Type declaration

                • offset: number
                \ No newline at end of file +

                Type declaration

                • offset: number
                \ No newline at end of file diff --git a/platform-bible-utils/types/ScrollGroupId.html b/platform-bible-utils/types/ScrollGroupId.html index 4108ae4a84..1b39800fc5 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).

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 86f4513063..ce558d7273 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

                Type alias Setting

                A description of an extension's setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index e87ab47c2a..58edf70181 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

                Type alias SettingBase

                SettingBase: StateBase & {
                    description?: LocalizeKey;
                    label: LocalizeKey;
                    [k: string]: unknown;
                }

                Base information needed to describe a setting entry

                Type declaration

                • [k: string]: unknown
                • Optional description?: 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index e2ec86645e..3ff3db44d4 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

                Type alias SettingsContribution

                SettingsContribution: SettingsGroup | SettingsGroup[]

                The data an extension provides to inform Platform.Bible of the settings it provides

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 54f292e595..ba90797881 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

                Type alias SingleColumnMenu

                SingleColumnMenu: {
                    groups: GroupsInSingleColumnMenu;
                    items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
                }

                Menu that contains a column without a header

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index eda1c2e840..d0ff8c69b1 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -2,4 +2,4 @@

                Note: this utility type is for use on object types. It may fail on other types.

                Type Parameters

                • U

                Example

                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>;
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 354b76a932..f8b3110d9a 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

                Type alias Unsubscriber

                Unsubscriber: (() => boolean)

                Function to run to dispose of something. Returns true if successfully unsubscribed

                -

                Type declaration

                  • (): boolean
                  • Returns boolean

                \ No newline at end of file +

                Type declaration

                  • (): boolean
                  • Returns boolean

                \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 69c1696d06..96e21e9e25 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

                Type alias UnsubscriberAsync

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

                Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

                -

                Type declaration

                  • (): Promise<boolean>
                  • Returns Promise<boolean>

                \ No newline at end of file +

                Type declaration

                  • (): Promise<boolean>
                  • Returns Promise<boolean>

                \ No newline at end of file diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 45b9764606..c5f3fdee7e 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

                Type alias UserState

                A description of an extension's user state entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index 4b0739fa2b..cbc84b85ec 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 4fed3dc409..ffa16e58b1 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

                Type alias WebViewMenus

                WebViewMenus: {
                    [property: ReferencedItem]: WebViewMenu;
                }

                Menus for all web views

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index 6e861767e2..1ce4a7beb7 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

                Variable FIRST_SCR_BOOK_NUMConst

                FIRST_SCR_BOOK_NUM: 1 = 1
                \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

                Variable FIRST_SCR_BOOK_NUMConst

                FIRST_SCR_BOOK_NUM: 1 = 1
                \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index 66a07dc0e8..9ff44e719a 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

                Variable FIRST_SCR_CHAPTER_NUMConst

                FIRST_SCR_CHAPTER_NUM: 1 = 1
                \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

                Variable FIRST_SCR_CHAPTER_NUMConst

                FIRST_SCR_CHAPTER_NUM: 1 = 1
                \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index 64573a1642..aae28b7155 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

                Variable FIRST_SCR_VERSE_NUMConst

                FIRST_SCR_VERSE_NUM: 1 = 1
                \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

                Variable FIRST_SCR_VERSE_NUMConst

                FIRST_SCR_VERSE_NUM: 1 = 1
                \ No newline at end of file diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index fd56595720..b0c5ddbcef 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

                Variable LAST_SCR_BOOK_NUMConst

                LAST_SCR_BOOK_NUM: number = ...
                \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

                Variable LAST_SCR_BOOK_NUMConst

                LAST_SCR_BOOK_NUM: number = ...
                \ No newline at end of file diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index 29ac4f29b5..1631d1aed8 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

                Variable localizedStringsDocumentSchemaConst

                localizedStringsDocumentSchema: {
                    $defs: {
                        languageStrings: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^%[\w\-\.]+%$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        localizeKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        localizedStringValue: {
                            description: 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

                -

                Type declaration

                • $defs: {
                      languageStrings: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizedStringValue: {
                          description: 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;
                      };
                  }
                  • languageStrings: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizedStringValue: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • stringMetadata: {
                        description: string;
                        properties: {
                            fallbackKey: {
                                description: string;
                                pattern: string;
                                tsType: string;
                                type: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              description: string;
                              pattern: string;
                              tsType: string;
                              type: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        }
                        • description: string
                        • pattern: string
                        • tsType: string
                        • type: string
                      • notes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                    • type: string
                  • stringsMetadata: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • description: string
                • properties: {
                      localizedStrings: {
                          additionalProperties: {
                              $ref: string;
                          };
                          type: string;
                      };
                      metadata: {
                          $ref: string;
                      };
                  }
                  • localizedStrings: {
                        additionalProperties: {
                            $ref: string;
                        };
                        type: string;
                    }
                    • additionalProperties: {
                          $ref: string;
                      }
                      • $ref: string
                    • type: string
                  • metadata: {
                        $ref: string;
                    }
                    • $ref: string
                • title: string
                • type: string
                \ No newline at end of file +

                Type declaration

                • $defs: {
                      languageStrings: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizedStringValue: {
                          description: 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;
                      };
                  }
                  • languageStrings: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizedStringValue: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • stringMetadata: {
                        description: string;
                        properties: {
                            fallbackKey: {
                                description: string;
                                pattern: string;
                                tsType: string;
                                type: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              description: string;
                              pattern: string;
                              tsType: string;
                              type: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        }
                        • description: string
                        • pattern: string
                        • tsType: string
                        • type: string
                      • notes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                    • type: string
                  • stringsMetadata: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • description: string
                • properties: {
                      localizedStrings: {
                          additionalProperties: {
                              $ref: string;
                          };
                          type: string;
                      };
                      metadata: {
                          $ref: string;
                      };
                  }
                  • localizedStrings: {
                        additionalProperties: {
                            $ref: string;
                        };
                        type: string;
                    }
                    • additionalProperties: {
                          $ref: string;
                      }
                      • $ref: string
                    • type: string
                  • metadata: {
                        $ref: string;
                    }
                    • $ref: string
                • title: string
                • type: string
                \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index e0e0ed032f..e77a05bec3 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

                Variable menuDocumentSchemaConst

                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

                -

                Type declaration

                • $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;
                      };
                  }
                  • 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;
                    }
                    • 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;
                          };
                      }
                      • ^[\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;
                        }
                        • 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;
                              };
                          }
                          • isExtensible: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                          • label: {
                                $ref: string;
                                description: string;
                            }
                            • $ref: string
                            • description: string
                          • localizeNotes: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                          • order: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                        • required: string[]
                        • type: string
                    • properties: {
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                      }
                      • isExtensible: {
                            description: string;
                            type: string;
                        }
                        • 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;
                    }
                    • description: string
                    • properties: {
                          groups: {
                              $ref: string;
                              description: string;
                          };
                          items: {
                              description: string;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                              uniqueItems: boolean;
                          };
                      }
                      • groups: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • items: {
                            description: string;
                            items: {
                                $ref: string;
                            };
                            type: string;
                            uniqueItems: boolean;
                        }
                        • description: string
                        • items: {
                              $ref: string;
                          }
                          • $ref: string
                        • type: string
                        • uniqueItems: boolean
                    • required: string[]
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        type: string;
                    }
                    • 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;
                    }
                    • 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;
                          };
                      }
                      • ^[\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;
                        }
                        • 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;
                    }
                    • 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;
                          };
                      }
                      • group: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • localizeNotes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • order: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • searchTerms: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • tooltip: {
                            $ref: string;
                            description: string;
                        }
                        • $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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • properties: {
                          contextMenu: {
                              $ref: string;
                              description: string;
                          };
                          includeDefaults: {
                              description: string;
                              type: string;
                          };
                          topMenu: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • contextMenu: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • includeDefaults: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • topMenu: {
                            $ref: string;
                            description: string;
                        }
                        • $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;
                    }
                    • 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;
                    }
                    • description: string
                    • pattern: string
                    • type: string
                  • singleColumnMenu: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                        type: string;
                        unevaluatedProperties: boolean;
                    }
                    • 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;
                      };
                  }
                  • defaultWebViewContextMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • defaultWebViewTopMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • mainMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • webViewMenus: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • required: string[]
                • title: string
                • type: string
                \ No newline at end of file +

                Type declaration

                • $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;
                      };
                  }
                  • 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;
                    }
                    • 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;
                          };
                      }
                      • ^[\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;
                        }
                        • 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;
                              };
                          }
                          • isExtensible: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                          • label: {
                                $ref: string;
                                description: string;
                            }
                            • $ref: string
                            • description: string
                          • localizeNotes: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                          • order: {
                                description: string;
                                type: string;
                            }
                            • description: string
                            • type: string
                        • required: string[]
                        • type: string
                    • properties: {
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                      }
                      • isExtensible: {
                            description: string;
                            type: string;
                        }
                        • 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;
                    }
                    • description: string
                    • properties: {
                          groups: {
                              $ref: string;
                              description: string;
                          };
                          items: {
                              description: string;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                              uniqueItems: boolean;
                          };
                      }
                      • groups: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • items: {
                            description: string;
                            items: {
                                $ref: string;
                            };
                            type: string;
                            uniqueItems: boolean;
                        }
                        • description: string
                        • items: {
                              $ref: string;
                          }
                          • $ref: string
                        • type: string
                        • uniqueItems: boolean
                    • required: string[]
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        type: string;
                    }
                    • 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;
                    }
                    • 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;
                          };
                      }
                      • ^[\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;
                        }
                        • 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;
                    }
                    • 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;
                          };
                      }
                      • group: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • localizeNotes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • order: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • searchTerms: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • tooltip: {
                            $ref: string;
                            description: string;
                        }
                        • $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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • properties: {
                          contextMenu: {
                              $ref: string;
                              description: string;
                          };
                          includeDefaults: {
                              description: string;
                              type: string;
                          };
                          topMenu: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • contextMenu: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • includeDefaults: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • topMenu: {
                            $ref: string;
                            description: string;
                        }
                        • $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;
                    }
                    • 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;
                    }
                    • description: string
                    • pattern: string
                    • type: string
                  • singleColumnMenu: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                        type: string;
                        unevaluatedProperties: boolean;
                    }
                    • 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;
                      };
                  }
                  • defaultWebViewContextMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • defaultWebViewTopMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • mainMenu: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • webViewMenus: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • required: string[]
                • title: string
                • type: string
                \ No newline at end of file diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 91af2fe75e..8f308ea498 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

                Variable projectSettingsDocumentSchemaConst

                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

                -

                Type declaration

                • $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;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • 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;
                    }
                    • 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;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • 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;
                    }
                    • 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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file +

                Type declaration

                • $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;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • 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;
                    }
                    • 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;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • 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;
                    }
                    • 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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 1db09f3832..dfe76d1543 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

                Variable settingsDocumentSchemaConst

                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

                -

                Type declaration

                • $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;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • 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;
                    }
                    • 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;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • 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;
                    }
                    • 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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file +

                Type declaration

                • $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;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • 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;
                    }
                    • 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;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • 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;
                    }
                    • 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;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • 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;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file