From 4781232f3f8c5d072b4555816405d3d0a492f3d0 Mon Sep 17 00:00:00 2001 From: lyonsil Date: Wed, 1 May 2024 20:03:05 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@7d3bf4215470b680f6122e3ad02c9062f63a2fc9=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 +- ...ider_engine_model_.DataProviderEngine.html | 4 +- ..._network_event_emitter_model_.default.html | 20 +++--- ...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 +- ...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 +- ...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 +- .../_node_utils_util_.getAppDir.html | 2 +- .../_node_utils_util_.getPathFromUri.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 +- ..._hooks_use_project_data_hook_.default.html | 2 +- ...e_project_data_provider_hook_.default.html | 2 +- ...oks_use_project_setting_hook_.default.html | 2 +- ..._papi_hooks_use_setting_hook_.default.html | 2 +- ...service_.blockWebSocketsToPapiNetwork.html | 2 +- ...tDataProviderDataTypeFromFunctionName.html | 2 +- ...ed_services_command_service_.addThree.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 +- ...ices_command_service_.squareAndConcat.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 +- ...ookup_service_.filterProjectsMetadata.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 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...ViewDefinitionUpdatablePropertiesById.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 +- 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 +- ...pi_shared_types_.ProjectDataProviders.html | 4 +- ...api_shared_types_.ProjectSettingTypes.html | 6 +- .../_papi_shared_types_.SettingTypes.html | 4 +- ..._dialog_definition_model_.DialogTypes.html | 4 +- ..._docking_framework_model_.FloatLayout.html | 6 +- ..._docking_framework_model_.PanelLayout.html | 6 +- ...ls_docking_framework_model_.TabLayout.html | 4 +- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +- ...el_.IProjectDataProviderEngineFactory.html | 4 +- ...a_provider_factory_interface_.default.html | 8 +-- ...rvice_model_.ProjectLookupServiceType.html | 6 +- ...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 ++--- ...s_network_service_.PapiNetworkService.html | 6 +- ...PapiBackendProjectDataProviderService.html | 6 +- ...apiFrontendProjectDataProviderService.html | 4 +- ...ervice_model_.IProjectSettingsService.html | 8 +-- ...r_service_.PapiWebViewProviderService.html | 4 +- ...vider_service_.WebViewProviderService.html | 10 +-- ...iew_service_model_.WebViewServiceType.html | 6 +- 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 +- ...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 +- ...er_hooks_papi_hooks_use_setting_hook_.html | 2 +- ...services_renderer_web_socket_service_.html | 2 +- ...es_renderer_xml_http_request_service_.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_global_this_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 +- ...tract_data_provider_data_types_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 +- ...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_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 +- 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 +- ...pi_shared_types_.IProjectDataProvider.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- .../_papi_shared_types_.ProjectDataTypes.html | 2 +- ...api_shared_types_.ProjectSettingNames.html | 2 +- .../_papi_shared_types_.ProjectTypes.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 +- ..._.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_.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 +- ...king_framework_model_.AddWebViewEvent.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 +- ...ta_provider_data_types_model_.default.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 +- ...model_.ProjectDataProviderEngineTypes.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...ider_model_.MandatoryProjectDataTypes.html | 2 +- ...ataProviderEngineExtensionDataMethods.html | 4 +- ...e_model_.ProjectMetadataFilterOptions.html | 2 +- ...e_model_.ProjectMetadataWithFactoryId.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...b_view_model_.UpdateWebViewDefinition.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 +- ...ttings_service_model_.AllSettingsData.html | 2 +- ..._service_model_.AllSettingsValidators.html | 2 +- ...tings_service_model_.ISettingsService.html | 10 +-- ...tings_service_model_.SettingDataTypes.html | 2 +- ...tings_service_model_.SettingValidator.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 +- .../__papi_backend_.DataProviderEngine.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_.projectDataProviders.html | 2 +- .../__papi_backend_.projectLookup.html | 2 +- .../__papi_backend_.projectSettings.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 +- .../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 +- ....SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html | 2 +- ...ion_model_.SELECT_PROJECT_DIALOG_TYPE.html | 2 +- ...al_connection_model_.CATEGORY_COMMAND.html | 2 +- ...al_connection_model_.CLIENT_ID_SERVER.html | 2 +- ...onnection_model_.CLIENT_ID_UNASSIGNED.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 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...ry_interface_.PDP_FACTORY_OBJECT_TYPE.html | 2 +- ...projectLookupServiceNetworkObjectName.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 +- ...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 +- ...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 +- ....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/isPackaged.html | 2 +- papi-dts/variables/logLevel.html | 2 +- papi-dts/variables/processType.html | 2 +- papi-dts/variables/resourcesPath.html | 2 +- platform-bible-react/enums/LabelPosition.html | 4 +- .../functions/BookChapterControl.html | 2 +- platform-bible-react/functions/Button.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- platform-bible-react/functions/Checkbox.html | 2 +- platform-bible-react/functions/ComboBox.html | 2 +- .../functions/ContextMenu.html | 2 +- platform-bible-react/functions/GridMenu.html | 2 +- .../functions/HamburgerMenuButton.html | 2 +- .../functions/IconButton.html | 2 +- platform-bible-react/functions/MenuItem.html | 2 +- .../functions/RefSelector.html | 2 +- platform-bible-react/functions/SearchBar.html | 2 +- platform-bible-react/functions/Slider.html | 2 +- platform-bible-react/functions/Snackbar.html | 2 +- platform-bible-react/functions/Switch.html | 2 +- platform-bible-react/functions/Table.html | 2 +- platform-bible-react/functions/TextField.html | 2 +- platform-bible-react/functions/Toolbar.html | 2 +- platform-bible-react/functions/useEvent.html | 2 +- .../functions/useEventAsync.html | 2 +- .../functions/usePromise.html | 2 +- .../interfaces/CommandHandler.html | 2 +- .../interfaces/MultiColumnMenuProvider.html | 2 +- .../interfaces/ScrRefSelectorProps.html | 4 +- .../interfaces/TableCalculatedColumn.html | 14 ++-- platform-bible-react/types/AnchorOrigin.html | 2 +- platform-bible-react/types/ButtonProps.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- platform-bible-react/types/CheckboxProps.html | 2 +- platform-bible-react/types/CloseReason.html | 2 +- .../types/ComboBoxChangeDetails.html | 2 +- .../types/ComboBoxChangeReason.html | 2 +- .../types/ComboBoxLabelOption.html | 2 +- .../types/ComboBoxOption.html | 2 +- platform-bible-react/types/ComboBoxProps.html | 2 +- platform-bible-react/types/ComboBoxValue.html | 2 +- platform-bible-react/types/GridMenuInfo.html | 2 +- platform-bible-react/types/GridMenuProps.html | 2 +- .../types/IconButtonProps.html | 2 +- .../types/MenuItemListProps.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/SwitchProps.html | 2 +- .../types/TableCellClickArgs.html | 2 +- .../types/TableCellKeyDownArgs.html | 2 +- .../types/TableCellKeyboardEvent.html | 2 +- .../types/TableCellMouseEvent.html | 2 +- platform-bible-react/types/TableColumn.html | 2 +- .../types/TableCopyEvent.html | 2 +- .../types/TableEditorProps.html | 2 +- .../types/TablePasteEvent.html | 2 +- platform-bible-react/types/TableProps.html | 2 +- .../types/TableRowsChangeData.html | 2 +- .../types/TableSortColumn.html | 2 +- .../types/TextFieldProps.html | 2 +- platform-bible-react/types/ToolbarProps.html | 2 +- .../types/UsePromiseOptions.html | 2 +- .../classes/AsyncVariable.html | 14 ++-- .../classes/DocumentCombiner.html | 28 ++++---- platform-bible-utils/classes/Mutex.html | 2 +- platform-bible-utils/classes/MutexMap.html | 4 +- .../NonValidatingDocumentCombiner.html | 28 ++++---- .../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 +- .../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/getAllObjectFunctionNames.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../functions/getErrorMessage.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/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 +- platform-bible-utils/functions/padEnd.html | 2 +- platform-bible-utils/functions/padStart.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 +- 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 | 6 +- .../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/Setting.html | 2 +- platform-bible-utils/types/SettingBase.html | 2 +- .../types/SettingsContribution.html | 2 +- .../types/SingleColumnMenu.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 +- 598 files changed, 838 insertions(+), 838 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 851cdce849..2da10b356c 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 2ec308d3cc..9d90b32e90 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 d7a6dfbeff..6a3eeb77c9 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

-

Constructors

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 7482b96730..22afbf3e50 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 54bda9fd41..25a8917176 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_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 1120e0190c..c074d00974 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

Implements

Constructors

Type Parameters

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 f53d24407c..596b3db96b 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/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 4d2c74cc12..08b4bf2303 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 1752efbcf0..3079cd8348 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 c014920223..cd65c57165 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 7828fab9de..1252cd7cf2 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_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index 0b2684c027..1133db4481 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 eecbc286c6..24da45d3c0 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 674e3ee98f..5b931c9d4a 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 165e133ce8..10d8bbb9c6 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 826c34ec5c..0e81eaaf8b 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 28deb1168c..f2ac80ef0c 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 75e197fcb8..6c84bab7a6 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 95ea167f13..0a01aae01d 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 45b2a7b54d..1807b232d8 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 71a8bbddd0..cee936b027 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 ab5bb41555..afe352e371 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 4587ae4bda..5fe18ef0b3 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_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index f30cf640f3..7c1b93fee2 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 66e989839c..8c56999d25 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 c231002fbc..b5e7c0014e 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 96961f4558..4fc87d7d41 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 6416dafe26..6825120e68 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 17e82210f7..350cbc5104 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 d9ec97f92a..ffeb3d37ab 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_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index 0e5e6f62c0..67ae81274a 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 08189c3cb4..5494d79290 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_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 5afff546f7..c5529b25c5 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 d14400263b..dec3401245 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 0f5bfd2269..56b1001f74 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 f450811253..0da290c165 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 9c224648c6..24f2f2eb37 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 6f88ebf793..9a477566a0 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 e0d2508815..6a076c7f4a 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 0ce3487cf9..3bdcb9edf6 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 688ee22b6d..bcab116a82 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_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index b089b66842..8d3be9a98e 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?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), 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 fd9b3b73f1..8240430361 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 @@ -9,4 +9,4 @@

    Returns undefined | ProjectDataProviders[ProjectType]

    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 5878326b27..e16a4f9331 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 @@ -31,4 +31,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_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 5c481293ce..4c8bbd2fa9 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 84fe3c6fe8..d2c7eea574 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/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index 3ea2e01e03..dbbae77f57 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_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index bba72a185e..ddb7dcd0d2 100644 --- a/papi-dts/functions/_shared_services_command_service_.addThree.html +++ b/papi-dts/functions/_shared_services_command_service_.addThree.html @@ -1 +1 @@ -addThree | papi-dts
    \ No newline at end of file +addThree | papi-dts
    \ 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 e47e83be2b..f80fd629f1 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 500be8ff06..ff764d50af 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 611c3fbe6a..c73e7df760 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 0b8f31831a..6e5187c365 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_command_service_.squareAndConcat.html b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html index d92d9def60..5f70216f1e 100644 --- a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html +++ b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html @@ -1 +1 @@ -squareAndConcat | papi-dts
    \ No newline at end of file +squareAndConcat | papi-dts
    \ 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 d5d04c1d78..83e2328c1c 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 abe6cf16e5..37ae03e64b 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 ecc932b60b..55033666a5 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 e12c093961..7db772eb9b 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 13929945ba..a6bc5eda77 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 ded461aed7..239a272693 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 076452fcc5..34abeb9b54 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 ad5006a0f4..ddd455ee45 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 bb3f7001fd..a407cd1a5b 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 14dd373cc7..1b4c32523a 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 ba5971b042..2242ffe064 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 bbb210882e..b72ebf4893 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 6e4e6579f4..58436497b2 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 8c153f0c73..d4fa019361 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 117b60faaa..b06b1c65c3 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 426272b25b..4e3c9377d0 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 ede6a6354f..4ffa65ae1d 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 8ff5ccfcf5..5d32a1867e 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 1c708dd54c..47872fb0b2 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 d17679cd77..6afb265662 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 e7f4cb2b46..9a7d4f4add 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 cda60c3f92..96bbb5c646 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 @@ -7,4 +7,4 @@

    Returns Promise<ProjectDataProviders[ProjectType]>

    Data provider with types that are associated with the given project type

    Example

    const pdp = await get('ParatextStandard', 'ProjectID12345');
    pdp.getVerse(new VerseRef('JHN', '1', '1'));
    -
    \ 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 62c696e94f..043cdf0956 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 @@
  • projectMetadataProvider: (() => Promise<ProjectMetadata[]>)

    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_lookup_service_.filterProjectsMetadata.html b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html index 138a544986..31fdaabdcd 100644 --- a/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html +++ b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html @@ -1 +1 @@ -filterProjectsMetadata | papi-dts
    \ No newline at end of file +filterProjectsMetadata | papi-dts
    \ 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 4e184c766a..ebc7f30d78 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 b03fd670c8..68aff3a49c 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 475b16bb3b..8c115e1cc0 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 1f20f117f7..45b9823a41 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 7b6edc94aa..3bf86d1373 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 2f667ef10f..9e30888f79 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 078779720e..20abc35c66 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 1be6c345bf..2ba2088c2f 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 c0745ab53a..be39739d3d 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 640758a65d..361b0290df 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/getWebViewDefinitionUpdatableProperties.html b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html index af600e82d9..333c623488 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ getWebViewDefinitionUpdatableProperties | papi-dts

    Function getWebViewDefinitionUpdatableProperties

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html index d6a8145820..e14242759b 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html @@ -1 +1 @@ -getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

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

    Function getWebViewDefinitionUpdatablePropertiesById

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index cdd045f411..eaf5a3db1d 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 164861bf81..46cb173427 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 e0eac70a9b..70a64dd7e5 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 137dba0668..2c57e244bc 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -5,4 +5,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 38f6e90e79..084e956aef 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/useWebViewState.html b/papi-dts/functions/useWebViewState.html index eb90ee987d..4fc49d70a8 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 5e8c3137dc..79170f219d 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 d9113754d3..9b8c6b9de3 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 39cf2e8c93..70d1e8e3e3 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 e2e5106bc9..8dc283e70e 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.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.echoRenderer: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

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

    Properties

    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.echoRenderer: ((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.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.echoRenderer: ((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 12fc74172f..33eff7581b 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_.ProjectDataProviders.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html index eafaa18b3f..a9965a779a 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -12,6 +12,6 @@ are adding a Project Data Provider type for the MyExtensionProjectTypeName projectType):

    Example

    declare module 'papi-shared-types' {
    export type MyProjectDataTypes = MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    };

    export interface ProjectDataProviders {
    MyExtensionProjectTypeName: IDataProvider<MyProjectDataTypes>;
    }
    }
    -
    interface ProjectDataProviders {
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }
    \ No newline at end of file +

    Properties

    \ 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 e70ab6b06a..10e2f575ef 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,13 +9,13 @@ 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.language: string;
    }

    Properties

    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.language: string;
    }

    Properties

    platform.fullName: string

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

    Example

    'World English Bible'
     
    -
    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'
     
    -
    \ 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 cc6380a16a..3454406794 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -8,6 +8,6 @@ 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.verseRef: ScriptureReference;
    }

    Properties

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

    Properties

    platform.interfaceLanguage: string[]
    platform.verseRef: ScriptureReference
    \ No newline at end of file +

    Properties

    platform.interfaceLanguage: string[]
    platform.verseRef: ScriptureReference
    \ 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 b017592b5d..e400252de9 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,6 +1,6 @@ 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.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    \ No newline at end of file +

    Properties

    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 8ec202b757..ec87e9a077 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 22e1b1fcf0..ca6008a888 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 83e69b4cad..cc64f785a9 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 1d8fffbb11..bcbede7826 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 6b26eeaccf..58c3bddb0d 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,11 +1,11 @@ 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

    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_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html index e38df4fb10..e8f4d8466b 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html @@ -8,10 +8,10 @@

    Project Data Provider Engine Factories create Project Data Provider Engines for a specific projectType. For each project available, a new instance of a PDP with that project's projectType is created by the Project Data Provider Factory with that project's projectType.

    -
    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    \ No newline at end of file +
    \ 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 e13335295f..8bab295f5a 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 @@ -2,16 +2,16 @@ the papi. These are created internally within the platform to layer over TypeScript-extension-provided IProjectDataProviderEngineFactory or are created by independent processes on the papi.

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

    Hierarchy

    Properties

    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(): Promise<ProjectMetadata[]>;
        getProjectDataProviderId(projectId): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

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

    Methods

    • 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_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/interfaces/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index 90c04048a3..93a604973c 100644 --- a/papi-dts/interfaces/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/interfaces/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -1,13 +1,13 @@ ProjectLookupServiceType | papi-dts

    Provides metadata for projects known by the platform

    -
    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadataWithFactoryId[]>);
        getMetadataForProject: ((projectId, projectType?, pdpFactoryId?) => Promise<ProjectMetadataWithFactoryId>);
    }

    Properties

    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadataWithFactoryId[]>);
        getMetadataForProject: ((projectId, projectType?, pdpFactoryId?) => Promise<ProjectMetadataWithFactoryId>);
    }

    Properties

    getMetadataForAllProjects: (() => Promise<ProjectMetadataWithFactoryId[]>)

    Provide metadata for all projects that have PDP factories

    Type declaration

    Returns

    ProjectMetadata for all projects stored on the local system

    -
    getMetadataForProject: ((projectId, projectType?, pdpFactoryId?) => Promise<ProjectMetadataWithFactoryId>)

    Look up metadata for a specific project ID

    +
    getMetadataForProject: ((projectId, projectType?, pdpFactoryId?) => Promise<ProjectMetadataWithFactoryId>)

    Look up metadata for a specific project ID

    Type declaration

      • (projectId, projectType?, pdpFactoryId?): Promise<ProjectMetadataWithFactoryId>
      • Parameters

        • projectId: string

          ID of the project to load

        • Optional projectType: keyof ProjectDataProviders

          Optional type of the project to load. If not provided, then look at all project types for the given project ID.

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

    Returns

    ProjectMetadata for the given project

    -
    \ 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 fb221149c8..2192b63e18 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 e64a2d3e8a..89e13727dd 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 c42ab57690..b0829f8ba6 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 b111c414b7..b6d23e1eae 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 cda3b9fe3d..e320833732 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 41f3bd9a40..86890cabe4 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 14cc1c9467..d9ea9a8c4d 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_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 13ee41b9ac..1e142a97c8 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 5e74a9687e..fee4aacc04 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: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider) => Promise<Dispose>);
    }

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the @@ -9,11 +9,11 @@

        Returns Promise<ProjectDataProviders[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -
    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an +

    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory, projectMetadataProvider): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an existing factory already that handles the same project type or this operation will fail.

        Type Parameters

        Parameters

        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 4789ef50f3..a24379c398 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: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the specified id. The TypeScript type for the returned project data provider will have the project @@ -8,4 +8,4 @@

        Returns Promise<ProjectDataProviders[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -
    \ 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 90301ef32d..456e6a7456 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, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    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

    -
    • Calls registered project settings validators to determine whether or not a project setting +

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

      @@ -21,7 +21,7 @@
    • projectType: keyof ProjectDataProviders

      The projectType for the project whose setting is being changed

    • 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_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 407c5b2d53..66ce906ca7 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 4c9c741c3b..4d627c6324 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 1c6fde6397..1dbccc5326 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>;
    }

    Properties

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

    Properties

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

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

    @@ -12,5 +12,5 @@

    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

    -
    \ No newline at end of file +
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +
    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index 42de39b127..16913a5383 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

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

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine commands dataProviders default diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 2bb47618a9..c89f6c9d43 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 2392ef89b7..1490b0bea9 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 2350a8d006..be97174ab6 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 cf61093ffa..c7989d73e1 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 4395322bbb..e487eabd72 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 6fb743740e..03c094ec74 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 681f3fa9dc..fb3fbe4d3c 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 f6e7a819ae..01d6128eb2 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 8bc8a839f8..00e5045ac6 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 dc80f679b0..c19ad71fbd 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 684459d983..01cdb5d507 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 88f7e84cc6..8f1e2757e6 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 1cf4de1226..cf6d0b5d53 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 ba4b89d6d3..abaceb12ed 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 2841a25c05..b7b6d6e2b6 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 83bc212bb9..31adabc4c8 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,3 +1,3 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce +"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

    \ 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 b417351ea1..c105b80588 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 41f4149ff7..95ba94b2b7 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 ProjectDataProviders 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 881b5ce539..3d6a5f6461 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 8f999e1921..cd6d5e98f0 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 c067c46eb2..3be1ff8a55 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 b2228b33f6..5035570219 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 1a5c9d378a..7672e9a7a1 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 2e2bb0b1fb..feb54bdece 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 9675b986db..e4f8c96757 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 da459828cc..d0d84e3dfa 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 d5605bcf53..f433254500 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_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index 749123b56e..30f093bb0c 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 be8740baf0..e6ad13e812 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 52fad90a2c..4582b75e77 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_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index 72cdf40acd..97436cc7c8 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 34159f5c26..b5eb6cb473 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 34e4711521..36d26ed18d 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/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 9d3e79ffbd..59f55f4467 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 eca9cb57aa..1936fcd181 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 74a2674463..468b572327 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_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index 6453c2803a..fe62a762b4 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_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index 35e5323247..3dbf57bbec 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 4c31491c7a..8b2d02ec03 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 5981bb45a7..a7d606bf58 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 ab4f395193..1fd2f7bf1a 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,3 +1,3 @@ -"shared/models/dialog-options.model" | papi-dts

    Namespace "shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts

    Namespace "shared/models/dialog-options.model"

    Index

    Type Aliases

    \ 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 e1c9604522..80c793e379 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

    AddWebViewEvent 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 dd18a8b58e..ac302026b3 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_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index a714640f8b..373346d70b 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 bd6c1ed58b..89420e75be 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 8a4325ca6e..ee0bba12dd 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_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index b508a23831..8fab0a8f1f 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,4 +1,4 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace "shared/models/project-data-provider-engine.model"

    Index

    Interfaces

    IProjectDataProviderEngineFactory +"shared/models/project-data-provider-engine.model" | papi-dts
    \ 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 263dff0a70..5fb3c83961 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,3 +1,3 @@ -"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

    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 c54068f1b4..ee25d9a875 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
    \ No newline at end of file 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 8c482c634e..ef5b0dbf62 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

    Interfaces

    ProjectLookupServiceType +"shared/models/project-lookup.service-model" | papi-dts

    Namespace "shared/models/project-lookup.service-model"

    Index

    Interfaces

    Type Aliases

    Variables

    projectLookupServiceNetworkObjectName diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 9b43f5d2e7..2c329af747 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,2 +1,2 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectMetadata +"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    \ 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 0738812565..fca86f413f 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

    GetWebViewDefinitionUpdatableProperties 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 e14816e53f..715bc47c67 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 c27257112d..ecbbf1c518 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

    addThree createSendCommandFunction initialize diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index 911b500eac..1dbb33e04a 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 3818051c04..54e14a66d5 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 5422243594..2ea933636e 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 db3598cc78..db0902e9ea 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 6cbba163c5..d68dc4feb7 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 e65f30e5d1..6dd8520049 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 631df13cb4..58715af9dd 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 7b853663bc..134849a076 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 14a1433b08..05fe8e180e 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 053f5503d2..820fed8716 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 b85ecd31eb..43b877b331 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 fe91c81b83..fb3c446777 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 b86a72bb94..61da4a00a4 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

    Variables

    default +"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    Functions

    onDidCreateNetworkObject onDidDisposeNetworkObject overrideDispose 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 fdc7db9e93..07ab0d7aaf 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 4c4ef91d63..e97ac16f77 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 e444809330..e11d57bb65 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 be06c7b09a..028a29c74d 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,3 +1,3 @@ -"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

    Functions

    \ 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 37229a8219..80269238e1 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-settings.service" | papi-dts

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    default +"shared/services/project-settings.service" | papi-dts

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    \ 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 e2c5faf43b..a9f81e9f5b 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_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index dd306b63b7..2db904c674 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 923b92a262..6c2811f611 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 cfbc31398c..a641b0e72d 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 09dbb8209a..361ab1833d 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 e0d11c1198..4d3f358946 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
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 3070f2b8f7..a206b38ec6 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_util_.html b/papi-dts/modules/_shared_utils_util_.html index 4e080ce618..b7d00e3820 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 47c01a0b94..ef321c3c9a 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 20ca37dd4c..d906919e0b 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 b03c55217c..1fdb9304a8 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 @@ -2,4 +2,4 @@

    Type declaration

    • executionToken: ExecutionToken

      Used to save and load data from 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 0e7efea4b4..acb4ebebec 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 @@ -22,4 +22,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 3a4c64e632..3b5a70a42a 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 939a0147c5..3397f2c3ac 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 ba481ca155..accabeda68 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 d5373544ea..c991ce1173 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 d817268319..da58c19584 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 0333fdfd7d..e52b5de294 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_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index ae62a1b52b..501a9f7552 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -16,4 +16,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_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index c36983b961..7dcbd4aa0f 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 c5e2ff7fad..95e7aef94a 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_.ProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html index 1c6d5697ac..3f7ebb583e 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -6,4 +6,4 @@ provider data types.

    Example

    ProjectDataTypes['MyExtensionProjectTypeName'] => 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_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index c96852cf6b..3993989318 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_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index bf2828251c..bc9a5a0b07 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -5,4 +5,4 @@ ProjectDataProviders.

    Example

    'platform.notesOnly'
     
    -
    \ 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 5357540f4e..3e7dfd9142 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 488c34e496..a32f733f42 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 a26ffbe67d..85f3ff2286 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -18,4 +18,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 96f3b481da..ef93041d72 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 cd0ca8fd0a..d8ab7eb790 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 ddc84bc707..980d669b10 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 04bab0d2d2..f8120fc5c8 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 5c240d5671..575a4ab0ff 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 7ebe373431..7f365509e5 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_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index cd7e318568..6caae4b7f7 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 f7a19009e4..24cbd46dc3 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 580f9fe199..e8b995156b 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 19207d1c58..75a58dfbb3 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 f622b31906..791704dbd6 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 2b6c6284cf..bc8598d4a7 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 4bba56329a..2548005202 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 2d9d20806f..040fe17f80 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 10694a8031..5dd5d54f9f 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 81ae1713df..89ed8555a4 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 8cde0220bf..0cad1beba7 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 2fabd3239e..f4fe06da37 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 9cd8359d91..1be24cb421 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 0b0194886d..bca9d6e530 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 8586b99ea6..312ac5fccb 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 b88091f54c..2d2dad7d29 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 78462f96a2..c826d1fee1 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 f90a6b32a8..1f04e3d5d0 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 2dbdb7506f..2d745f7377 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 fde916e001..1e66e920ab 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 a877667f58..189f2aa47d 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 318260fbf8..c4f50578ce 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_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index df5ad0b99f..deb226ce45 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 67eaa4af93..68a025032e 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 47c6e60af2..f8ca59e9d6 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>) {}
    ...
    }
    -
    \ No newline at end of file +
    \ 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 c2781755f2..e4ddf28292 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 306b5a074b..1f990a9c71 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 45a7b6ebfd..adb6c0bb89 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 80c81ef7b3..b26d63434f 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 e949127de1..c2a4a70d59 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 08ae05e1f9..0c0cdd3987 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 90c02eed37..4632c55f89 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 1b06ff8ad9..cdb40d9e69 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 499eaf314e..4d774a6c6d 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 aff7885ed7..96c1aab10d 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 2c9bd5b8e8..2941fa4ccf 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 265fc24807..56f8aee8de 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 0e5c193b5f..42c8f78a1a 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 4d5600e186..b62ad200be 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 b9788daf81..62fbb2202c 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 ce45ee65b8..f4e4f62b43 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional iconUrl?: string

      Url of dialog icon to display in the header. Default is Platform.Bible logo

    • Optional prompt?: string

      The message to show the user in the dialog. Default depends on the dialog

    • Optional title?: string

      Dialog title to display in the header. 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_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index b2e5192529..e9e54df5bd 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_models_docking_framework_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_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index a7aacb8894..2c20017e69 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 25585e4b8d..6b3e262e10 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 959caddacc..3eb86bc29d 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 cca91026e7..1a7ade509c 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 1bb24a5a2b..67ec1e3957 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 500a0e863a..f2cdf61029 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 27c6ca9cbb..7c0b747b5d 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 1fc933d71b..c354a8b0f5 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 2052e13f60..bdd13aeed8 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 cc7aad9618..0b2035dfbf 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 952256fa5d..35fdf73bfc 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_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index 666f180d20..239141677d 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

    \ No newline at end of file +

    Type Parameters

    \ 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 0187c15da5..0d12434246 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 708b78b662..63aa8265f5 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 8f269c057b..5a5ed95e06 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 71271f93cf..30687ce157 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 7d80c8a0c1..4ddeca4651 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 5d8dcb7020..6788d7bb08 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 @@ -15,4 +15,4 @@

    OR

    class MyPDPE implements IProjectDataProviderEngine<'MyProjectData'> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -
    \ 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_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 1d94cb8b9c..591e279efd 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts
    ProjectDataProviderEngineTypes: {
        [ProjectType in ProjectTypes]: IProjectDataProviderEngine<ProjectType>
    }

    All possible types for ProjectDataProviderEngines: IProjectDataProviderEngine

    -
    \ 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 ce4b4bcb03..8a730e94d9 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 d0be7daa4e..98d274744c 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 @@ -29,4 +29,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 cc2a9e4c52..eba834faf9 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_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataFilterOptions.html index 4422bad492..5cd27ffdbe 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataFilterOptions.html @@ -12,4 +12,4 @@ function) to determine if they should be included.

    Defaults to all ProjectTypes, so all projects that do not match excludeProjectTypes will be included

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataWithFactoryId.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataWithFactoryId.html index 6c85585c03..ea87b6f5ad 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataWithFactoryId.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectMetadataWithFactoryId.html @@ -1 +1 @@ -ProjectMetadataWithFactoryId | papi-dts
    ProjectMetadataWithFactoryId: ProjectMetadata & {
        pdpFactoryId: string;
    }

    Type declaration

    • pdpFactoryId: string
    \ No newline at end of file +ProjectMetadataWithFactoryId | papi-dts
    ProjectMetadataWithFactoryId: ProjectMetadata & {
        pdpFactoryId: string;
    }

    Type declaration

    • pdpFactoryId: string
    \ 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 c2cdc4d4e9..ccacc6f919 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -4,4 +4,4 @@
  • name: string

    Short name of the project (not necessarily unique)

  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 4286f51bd6..3acf9f673c 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts
    GetWebViewDefinitionUpdatableProperties: (() => WebViewDefinitionUpdatableProperties | undefined)

    Gets the updatable properties on this WebView's WebView definition

    @returns updatable 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 1fd31c8dd3..e26f22119e 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 06af7a9f9a..181362852e 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
    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, "content" | "styles" | "allowScripts">> | Partial<Omit<WebViewDefinitionHtml, "content" | "allowScripts">> | Partial<Omit<WebViewDefinitionURL, "content" | "allowScripts">>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    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_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index a14b0a8084..320efda52d 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,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_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index 8eeb0a5fea..b312322069 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 f917efa28a..9abe3385dd 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 b054b18bd7..41d07c5a19 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -65,4 +65,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 4757e3d0f7..f34e9a5bf5 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 c398f137f5..a309233e5f 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 0e75a25e5f..9aa480c5f7 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 7159d61d56..98150d2dd5 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, "iconUrl" | "title" | "tooltip">

    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 a9b05e32ce..4c9bcac907 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 8a0f54a8a9..7eeea54ab4 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 f7668e24cf..738bc6a7cd 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -35,4 +35,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 6963fd848f..72c2b9bad3 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 4ea599e468..3f2f3080f0 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 89ebb41d32..b494e6d3d6 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 6c843c3fcc..600bf6fbc5 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 d69fc43bc4..71a57e4986 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 67d48f92e1..49dd9459a7 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 17a92b2c6a..45b2361219 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 4e7a9d5f19..d3481a7adb 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 6ebba1abae..6b05f141cd 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 34fad163a4..9edb1ba396 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 b09654f11f..a09a0368db 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 2d4be9f18b..820ae9cf40 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 3d1a9efe3b..f5d11f0291 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 b99334c8f0..41b76bdf35 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 @@ -1,2 +1,2 @@ ProjectSettingValidator | papi-dts

        Type alias ProjectSettingValidator<ProjectSettingName>

        ProjectSettingValidator<ProjectSettingName>: ((newValue, currentValue, allChanges, projectType) => Promise<boolean>)

        Function that validates whether a new project 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_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index 2753ac84ca..a08ca8e68c 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_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 2fcdf5d2cd..7ee794c200 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 913aad30de..1ddf0b8bbe 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 308ef86f5e..78de6b074d 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,23 +3,23 @@

        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.

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

          -
      • \ No newline at end of file +
        \ 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 323e06074c..14e30e1d18 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 0e4c0f2fec..4aa35feeae 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_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index 8b632e749c..68ff53396b 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 fae288d11d..d980ab5225 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 50e234385f..0bce023242 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 016b449375..f909bfbba5 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 cce53ca922..1e70447aa9 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 603b365247..1e7ace08bf 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_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index 3a50c6eda6..b348032f54 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_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index 712598b23e..b0b3e20a44 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 22188bd337..ab6446f9cb 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 9a347615ba..5c24d8bc61 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -23,4 +23,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 0c2370808e..b23b439454 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 198ccff501..13a9c6597f 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 7b78295ad0..3f8dce86d7 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 263260acaf..897d0796d6 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 796aacddd7..dce1222bbe 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 f74f590d0e..578951f49e 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_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 5bf641b857..dfd9736455 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 b2f4ffbd04..da11110a27 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

            Variable projectLookupConst

            Provides metadata for projects known by the platform

            -
            \ 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 35dbc94b44..3205fa992a 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_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index da9d71623c..b0ae824e33 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 6df484940b..53e0e53cb4 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 427d98287a..bdd1217e85 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 5333c64489..54c81163dd 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 e21dd27324..794f6688c9 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 cd42daa9bf..0a0619debf 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 b538bf0883..2d6da9520a 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 09511639f1..6f5ab9f066 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 17dc9694a4..1b1a15fa91 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -23,4 +23,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 49c897e4dd..0ff2084d76 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 e1d55045ef..e835f2a438 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 4fadae7386..bdb3f8714c 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 2e2ad36bd5..3fe51b296f 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 348da093bd..49da759642 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 969440d89b..b0d22f5ce8 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 34f8184352..11394793bd 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 30193ac357..fd2b9affd9 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

                Variable projectLookupConst

                Provides metadata for projects known by the platform

                -
                \ 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 89e7d466a5..fb93af3823 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_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 5385890ce2..c480b60635 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 b92e486449..c487624118 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 ec1989b2d5..71c954959f 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 ebfac03029..c9d15fe17c 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 e661143e16..8da08bb460 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 29d548ec69..af11fc9706 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 4b5c4750b3..73155f06da 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_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index d37c6a4944..b23ba9eee2 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 3bec396c7f..f49ae7f26c 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/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index a100ca5cd1..475ca6b152 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 ae52e03747..49af1336de 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 f5b51eee47..4dc5ada83d 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_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index eec2889dd1..ca8d57d7c5 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 57f3a8c8c0..43ea9f9ea2 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 2108651ba2..94369756d6 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 7150742204..c081a168b0 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_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 2860d7504a..6e7f11d7ec 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 ef8870f715..df8d8359f1 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_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index 61e95d5d83..0f2ed6f240 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts
                projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'
                \ No newline at end of file +projectLookupServiceNetworkObjectName | papi-dts
                projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'
                \ 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 4dfc91a936..62e11bc00a 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 d37f0297a1..0380bbba13 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 53aa79ad69..0f58a77891 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 e316a9713d..f66b36ed10 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 66c0968160..ccd85706b4 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 495ca9ed41..7bc687e587 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 9c39239024..f5dfc62689 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 36ef8b1833..8050ee40e0 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 a7fc5a2341..12bef9e7b3 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 89b56df8e0..3da6d8ce89 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 56bb700c6a..8f27a31c66 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 1b0a51070c..41cddedfad 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 5a989e060f..6caa6a8490 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_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 1c76d9e724..d5b1203c61 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 +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_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 9e8b37fe9a..cdc8dba8b3 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 482462a67f..1150a93ab6 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 77ee0272bc..07374df91f 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 416d38cb3f..f9bd6b4572 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 f6d7af335e..4a4d8c1cc6 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 6dd5f35041..0442fa789c 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 fce2f24a16..bf2fdf8a93 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 eb3dcb6c5c..f2a44e9e52 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_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 4e7a27e410..85a25174d3 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 034378adce..a360ce7b96 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 ca9813b9bf..66c560a616 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 727dcb02c4..383551bbe6 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 e6850e95eb..5536b6cffa 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 011233fcd1..998c497200 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 1ec6a2f41f..3f7be50e24 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 5c7d9775de..397c6e8758 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_.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 d62e67c463..739a74a912 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 345fad3575..22f514e54b 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 e623d6c7ef..cb947f7e79 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/isPackaged.html b/papi-dts/variables/isPackaged.html index 5f7220ee22..a7a8c3b34b 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 d24e78e312..57252c2e7e 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 94fa9ccc5b..433d24419e 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 898ac7fe8f..47e00b36cd 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/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index b06fdefe3b..c4960d27a5 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/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index 42a1281815..1b35597f1b 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 2631481e38..f6faea63b9 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ Button | 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/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index e2b1c7826d..c5615c7433 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 b0e1b985e8..ecf223ee18 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/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 6198f3f47b..385e1107df 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 57aff50067..31b3e49f30 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/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 052633db12..a08d4efc2c 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 7203da478b..6a6ca0fbe5 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 18a21182ff..74aa6a9652 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/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 10e5e8392e..2e5c404f1a 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/RefSelector.html b/platform-bible-react/functions/RefSelector.html index b29fb35d20..4c2522ff07 100644 --- a/platform-bible-react/functions/RefSelector.html +++ b/platform-bible-react/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | platform-bible-react
                \ No newline at end of file +RefSelector | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 2e41d64b20..a9d55d4d71 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/Slider.html b/platform-bible-react/functions/Slider.html index 677c93941c..0bf1be5ed3 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 514ed22db8..7a2cead3e1 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/Switch.html b/platform-bible-react/functions/Switch.html index 7a44fe6b3b..404e8cdf93 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 72f7f169e7..8eef36cdc5 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react
                \ No newline at end of file +

                Type Parameters

                • R

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index fdc484925f..518924bff8 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 cc32e2420c..ce1e16c590 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/useEvent.html b/platform-bible-react/functions/useEvent.html index 15b207a008..f61b438802 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 1330f5bd76..f1c97fb2aa 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 504de76cd6..62c19b2a86 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/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 3ed0d1e9b8..437b218176 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 79825faf23..d8a5a5258d 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/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index ef50595c6c..a18b3220c3 100644 --- a/platform-bible-react/interfaces/ScrRefSelectorProps.html +++ b/platform-bible-react/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | platform-bible-react

                Interface ScrRefSelectorProps

                interface ScrRefSelectorProps {
                    handleSubmit: ((scrRef) => void);
                    id?: string;
                    scrRef: ScriptureReference;
                }

                Properties

                handleSubmit +ScrRefSelectorProps | platform-bible-react

                Interface ScrRefSelectorProps

                interface ScrRefSelectorProps {
                    handleSubmit: ((scrRef) => void);
                    id?: string;
                    scrRef: ScriptureReference;
                }

                Properties

                Properties

                handleSubmit: ((scrRef) => void)

                Type declaration

                  • (scrRef): void
                  • Parameters

                    • scrRef: ScriptureReference

                    Returns void

                id?: string
                scrRef: ScriptureReference
                \ No newline at end of file +

                Properties

                handleSubmit: ((scrRef) => void)

                Type declaration

                  • (scrRef): void
                  • Parameters

                    • scrRef: ScriptureReference

                    Returns void

                id?: string
                scrRef: ScriptureReference
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 6c6bc62cc8..379bb712a2 100644 --- a/platform-bible-react/interfaces/TableCalculatedColumn.html +++ b/platform-bible-react/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | platform-bible-react

                Interface TableCalculatedColumn<R>

                interface TableCalculatedColumn<R> {
                    draggable: boolean;
                    editable?: null | boolean | ((row) => boolean);
                    frozen: boolean;
                    idx: number;
                    isLastFrozenColumn: boolean;
                    key: string;
                    level: number;
                    maxWidth: undefined | number;
                    minWidth: number;
                    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
                    parent: undefined | TableCalculatedColumnParent<R>;
                    renderCell: ((props) => ReactNode);
                    renderEditCell?: null | ((props) => ReactNode);
                    resizable: boolean;
                    sortDescendingFirst?: null | boolean;
                    sortable: boolean;
                    width: string | number;
                }

                Type Parameters

                • R

                Hierarchy (view full)

                Properties

                draggable +TableCalculatedColumn | platform-bible-react

                Interface TableCalculatedColumn<R>

                interface TableCalculatedColumn<R> {
                    draggable: boolean;
                    editable?: null | boolean | ((row) => boolean);
                    frozen: boolean;
                    idx: number;
                    isLastFrozenColumn: boolean;
                    key: string;
                    level: number;
                    maxWidth: undefined | number;
                    minWidth: number;
                    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
                    parent: undefined | TableCalculatedColumnParent<R>;
                    renderCell: ((props) => ReactNode);
                    renderEditCell?: null | ((props) => ReactNode);
                    resizable: boolean;
                    sortDescendingFirst?: null | boolean;
                    sortable: boolean;
                    width: string | number;
                }

                Type Parameters

                • R

                Hierarchy (view full)

                Properties

                draggable: boolean
                editable?: null | boolean | ((row) => boolean)

                If true, editing is enabled. If no custom cell editor is provided through renderEditCell +

                Properties

                draggable: boolean
                editable?: null | boolean | ((row) => boolean)

                If true, editing is enabled. If no custom cell editor is provided through renderEditCell the default text editor will be used for editing. Note: If editable is set to 'true' and no custom renderEditCell is provided, the internal logic that sets the renderEditCell will shallow clone the column.

                -

                Type declaration

                  • (row): boolean
                  • Parameters

                    • row: R

                    Returns boolean

                frozen: boolean
                idx: number
                isLastFrozenColumn: boolean
                key: string

                A unique key to distinguish each column

                -
                level: number
                maxWidth: undefined | number
                minWidth: number
                name: string | ReactElement<any, string | JSXElementConstructor<any>>

                The name of the column. By default it will be displayed in the header cell

                -
                parent: undefined | TableCalculatedColumnParent<R>
                renderCell: ((props) => ReactNode)

                Type declaration

                  • (props): ReactNode
                  • Parameters

                    • props: RenderCellProps<R, unknown>

                    Returns ReactNode

                renderEditCell?: null | ((props) => ReactNode)

                Editor to be rendered when cell of column is being edited. Don't forget to also set the +

                Type declaration

                  • (row): boolean
                  • Parameters

                    • row: R

                    Returns boolean

                frozen: boolean
                idx: number
                isLastFrozenColumn: boolean
                key: string

                A unique key to distinguish each column

                +
                level: number
                maxWidth: undefined | number
                minWidth: number
                name: string | ReactElement<any, string | JSXElementConstructor<any>>

                The name of the column. By default it will be displayed in the header cell

                +
                parent: undefined | TableCalculatedColumnParent<R>
                renderCell: ((props) => ReactNode)

                Type declaration

                  • (props): ReactNode
                  • Parameters

                    • props: RenderCellProps<R, unknown>

                    Returns ReactNode

                renderEditCell?: null | ((props) => ReactNode)

                Editor to be rendered when cell of column is being edited. Don't forget to also set the editable prop to true in order to enable editing.

                -

                Type declaration

                resizable: boolean
                sortDescendingFirst?: null | boolean

                Sets the column sort order to be descending instead of ascending the first time the column is +

                Type declaration

                resizable: boolean
                sortDescendingFirst?: null | boolean

                Sets the column sort order to be descending instead of ascending the first time the column is sorted

                -
                sortable: boolean
                width: string | number
                \ No newline at end of file +
                sortable: boolean
                width: string | number
                \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index 4a481901f5..3e75f75e0a 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react

                Type alias AnchorOrigin

                AnchorOrigin: SnackbarOrigin
                \ No newline at end of file +AnchorOrigin | platform-bible-react

                Type alias AnchorOrigin

                AnchorOrigin: SnackbarOrigin
                \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index 670c79ca55..700677c80a 100644 --- a/platform-bible-react/types/ButtonProps.html +++ b/platform-bible-react/types/ButtonProps.html @@ -5,4 +5,4 @@
              • Optional onClick?: MouseEventHandler<HTMLButtonElement>

                Optional click handler

              • Optional onContextMenu?: MouseEventHandler<HTMLButtonElement>

                Optional context menu handler

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 1882c48291..9c46208586 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;
                    endChapter: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                    startChapter: number;
                }

                Type declaration

                • chapterCount: number
                • endChapter: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                • startChapter: number
                \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

                Type alias ChapterRangeSelectorProps

                ChapterRangeSelectorProps: {
                    chapterCount: number;
                    endChapter: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                    startChapter: number;
                }

                Type declaration

                • chapterCount: number
                • endChapter: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                • startChapter: number
                \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index ed40db5ef5..ab8e7baeca 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@
                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index 663bc6c3bd..1686fe3d11 100644 --- a/platform-bible-react/types/CloseReason.html +++ b/platform-bible-react/types/CloseReason.html @@ -1 +1 @@ -CloseReason | platform-bible-react

                Type alias CloseReason

                CloseReason: SnackbarCloseReason
                \ No newline at end of file +CloseReason | platform-bible-react

                Type alias CloseReason

                CloseReason: SnackbarCloseReason
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index da09896b91..1e41c88878 100644 --- a/platform-bible-react/types/ComboBoxChangeDetails.html +++ b/platform-bible-react/types/ComboBoxChangeDetails.html @@ -1 +1 @@ -ComboBoxChangeDetails | platform-bible-react

                Type alias ComboBoxChangeDetails<T>

                ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

                Type Parameters

                • T
                \ No newline at end of file +ComboBoxChangeDetails | platform-bible-react

                Type alias ComboBoxChangeDetails<T>

                ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index bd3a1bf382..aa619484d7 100644 --- a/platform-bible-react/types/ComboBoxChangeReason.html +++ b/platform-bible-react/types/ComboBoxChangeReason.html @@ -1 +1 @@ -ComboBoxChangeReason | platform-bible-react

                Type alias ComboBoxChangeReason

                ComboBoxChangeReason: AutocompleteChangeReason
                \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

                Type alias ComboBoxChangeReason

                ComboBoxChangeReason: AutocompleteChangeReason
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index cfe39cd8cf..cb9b5866c4 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 0102687cda..bfc675eecd 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 1122027ba1..0ccbfb6df9 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -21,4 +21,4 @@
              • Optional value?: T

                The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

              • Optional width?: number

                Width of the combobox in pixels. Setting this prop overrides the isFullWidth prop

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 95cef3b04a..f53051b8f8 100644 --- a/platform-bible-react/types/ComboBoxValue.html +++ b/platform-bible-react/types/ComboBoxValue.html @@ -1 +1 @@ -ComboBoxValue | platform-bible-react

                Type alias ComboBoxValue<T, X, Y, Z>

                ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

                Type Parameters

                • T
                • X
                • Y
                • Z
                \ No newline at end of file +ComboBoxValue | platform-bible-react

                Type alias ComboBoxValue<T, X, Y, Z>

                ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

                Type Parameters

                • T
                • X
                • Y
                • Z
                \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 13026b38a5..17d342088b 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 0ccda2b663..c7bd5cc52d 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 a17f6e0a86..0d1b0575ec 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/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index a96db7c57a..8c221b0118 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/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 819fbdf2fc..27f7a558c0 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 da8d77f4df..660af5bbd5 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 e7436b6a22..26a06e5738 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 b8e1ae19cb..fea96a47ff 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 +
                \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index ee23d71dc5..9995f2e510 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@
                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index 2c4e336601..b4213cd9a6 100644 --- a/platform-bible-react/types/TableCellClickArgs.html +++ b/platform-bible-react/types/TableCellClickArgs.html @@ -1 +1 @@ -TableCellClickArgs | platform-bible-react

                Type alias TableCellClickArgs<R>

                TableCellClickArgs<R>: CellClickArgs<R>

                Type Parameters

                • R
                \ No newline at end of file +TableCellClickArgs | platform-bible-react

                Type alias TableCellClickArgs<R>

                TableCellClickArgs<R>: CellClickArgs<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index f68917661c..f17872ce22 100644 --- a/platform-bible-react/types/TableCellKeyDownArgs.html +++ b/platform-bible-react/types/TableCellKeyDownArgs.html @@ -1 +1 @@ -TableCellKeyDownArgs | platform-bible-react

                Type alias TableCellKeyDownArgs<R>

                TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

                Type Parameters

                • R
                \ No newline at end of file +TableCellKeyDownArgs | platform-bible-react

                Type alias TableCellKeyDownArgs<R>

                TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index 4e00bd8593..ef6733f330 100644 --- a/platform-bible-react/types/TableCellKeyboardEvent.html +++ b/platform-bible-react/types/TableCellKeyboardEvent.html @@ -1 +1 @@ -TableCellKeyboardEvent | platform-bible-react

                Type alias TableCellKeyboardEvent

                TableCellKeyboardEvent: CellKeyboardEvent
                \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

                Type alias TableCellKeyboardEvent

                TableCellKeyboardEvent: CellKeyboardEvent
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index 42df115b3d..d38fb48474 100644 --- a/platform-bible-react/types/TableCellMouseEvent.html +++ b/platform-bible-react/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | platform-bible-react

                Type alias TableCellMouseEvent

                TableCellMouseEvent: CellMouseEvent
                \ No newline at end of file +TableCellMouseEvent | platform-bible-react

                Type alias TableCellMouseEvent

                TableCellMouseEvent: CellMouseEvent
                \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index cdef6118ae..f959983fc7 100644 --- a/platform-bible-react/types/TableColumn.html +++ b/platform-bible-react/types/TableColumn.html @@ -15,4 +15,4 @@
              • Optional Readonly sortable?: boolean

                Enable sorting of a column

              • Optional Readonly width?: number | string

                Column width. If not specified, it will be determined automatically based on grid width and specified widths of other columns

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 98c572e935..99064fbbf9 100644 --- a/platform-bible-react/types/TableCopyEvent.html +++ b/platform-bible-react/types/TableCopyEvent.html @@ -1 +1 @@ -TableCopyEvent | platform-bible-react

                Type alias TableCopyEvent<R>

                TableCopyEvent<R>: CopyEvent<R>

                Type Parameters

                • R
                \ No newline at end of file +TableCopyEvent | platform-bible-react

                Type alias TableCopyEvent<R>

                TableCopyEvent<R>: CopyEvent<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index 2576534c34..422011dc0b 100644 --- a/platform-bible-react/types/TableEditorProps.html +++ b/platform-bible-react/types/TableEditorProps.html @@ -1 +1 @@ -TableEditorProps | platform-bible-react

                Type alias TableEditorProps<R>

                TableEditorProps<R>: {
                    column: TableCalculatedColumn<R>;
                    onClose: ((commitChanges?) => void);
                    onRowChange: ((row, commitChanges?) => void);
                    row: R;
                }

                Type Parameters

                • R

                Type declaration

                • column: TableCalculatedColumn<R>
                • onClose: ((commitChanges?) => void)
                    • (commitChanges?): void
                    • Parameters

                      • Optional commitChanges: boolean

                      Returns void

                • onRowChange: ((row, commitChanges?) => void)
                    • (row, commitChanges?): void
                    • Parameters

                      • row: R
                      • Optional commitChanges: boolean

                      Returns void

                • row: R
                \ No newline at end of file +TableEditorProps | platform-bible-react

                Type alias TableEditorProps<R>

                TableEditorProps<R>: {
                    column: TableCalculatedColumn<R>;
                    onClose: ((commitChanges?) => void);
                    onRowChange: ((row, commitChanges?) => void);
                    row: R;
                }

                Type Parameters

                • R

                Type declaration

                • column: TableCalculatedColumn<R>
                • onClose: ((commitChanges?) => void)
                    • (commitChanges?): void
                    • Parameters

                      • Optional commitChanges: boolean

                      Returns void

                • onRowChange: ((row, commitChanges?) => void)
                    • (row, commitChanges?): void
                    • Parameters

                      • row: R
                      • Optional commitChanges: boolean

                      Returns void

                • row: R
                \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index 9becb0aa69..d2474e779e 100644 --- a/platform-bible-react/types/TablePasteEvent.html +++ b/platform-bible-react/types/TablePasteEvent.html @@ -1 +1 @@ -TablePasteEvent | platform-bible-react

                Type alias TablePasteEvent<R>

                TablePasteEvent<R>: PasteEvent<R>

                Type Parameters

                • R
                \ No newline at end of file +TablePasteEvent | platform-bible-react

                Type alias TablePasteEvent<R>

                TablePasteEvent<R>: PasteEvent<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index 88d38a5223..7f4befb5d5 100644 --- a/platform-bible-react/types/TableProps.html +++ b/platform-bible-react/types/TableProps.html @@ -52,4 +52,4 @@
              • Optional selectedRows?: ReadonlySet<Key>

                A set of keys representing the currently selected rows

              • Optional sortColumns?: readonly TableSortColumn[]

                An array of objects representing the currently sorted columns

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index bb6ddbc9ec..679ab8df62 100644 --- a/platform-bible-react/types/TableRowsChangeData.html +++ b/platform-bible-react/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | platform-bible-react

                Type alias TableRowsChangeData<R>

                TableRowsChangeData<R>: RowsChangeData<R>

                Type Parameters

                • R
                \ No newline at end of file +TableRowsChangeData | platform-bible-react

                Type alias TableRowsChangeData<R>

                TableRowsChangeData<R>: RowsChangeData<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index a77b29e2ec..7afb20c9f9 100644 --- a/platform-bible-react/types/TableSortColumn.html +++ b/platform-bible-react/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | platform-bible-react

                Type alias TableSortColumn

                TableSortColumn: SortColumn
                \ No newline at end of file +TableSortColumn | platform-bible-react

                Type alias TableSortColumn

                TableSortColumn: SortColumn
                \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 710525d553..6263f0bb7d 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -23,4 +23,4 @@
              • Optional variant?: "outlined" | "filled"

                The variant to use.

                Default

                'outlined'
                 
                -
              • \ 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 14548cd325..0462eab535 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 8520884b2d..cc0902f798 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-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index e899e376a8..b6515d266a 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.

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

                    -

                  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

                    -

                  Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 5021868e17..bb3fc93f96 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 7589c797d5..f26c1948ae 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 784fa0039c..f04febfaa0 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 50e6ea457e..066dbf5ce2 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/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 45a8fbbe44..08fb581d84 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 e7d9e061cf..77cc08b641 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 8ab35cab00..8e2469cb88 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 19261847b5..cfc96af046 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 137368e1a9..48fe6107ef 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 772e7ae418..d3f23092cc 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 8666dd059e..695e557067 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/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 78ffe9251b..1bde4355b0 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 5728edbc04..e2482c1fd3 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 be20ff1fb9..7eb9a34f32 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 90bb4cb805..c786c9c559 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 53dd7aeadf..655610e6e1 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 b8565d2590..76970885e4 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/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 9c56df2733..78d2e89c5c 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 1d01d5d79a..c47604fa21 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/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 77d45e5f8d..d15aa7ca05 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/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index 8bb09a5e46..08f0d01dea 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 5ecdefd722..d9926ee231 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 fcec8c3470..1e3a7875f9 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 51db0b0818..79143ee0e7 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 f89eecbe3a..8ac9617517 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/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index ff4546e46a..870cfafd45 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 8e5f732447..046a605a7d 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 70bbac1203..64045f9cdf 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -12,4 +12,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 c308a628bb..6b50b8aaae 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 8df6d15baa..7e6a9359dc 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 04f9f972c5..01bbc4b4df 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 ed69bf22b8..0d91547791 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 15c77ca639..96837b017a 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 c287f3f3b4..3aa224944f 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/padEnd.html b/platform-bible-utils/functions/padEnd.html index 52bfcc2e03..16d3260d02 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 e7683250ee..cbd5cda93d 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/serialize.html b/platform-bible-utils/functions/serialize.html index 562cffdcd3..e225302c03 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 659927e7b5..1b46024f88 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 e6d588c2ea..e8b643c743 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 cb94a37668..7d63531ebd 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 06acec9483..9090186143 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 1f425596a6..d25b975734 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 4f041e286b..d23b81ae50 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/wait.html b/platform-bible-utils/functions/wait.html index 3b53de8153..5e3101f777 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 da0e2c9ddc..2dbe945a21 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 bc16a52c16..b189c518c7 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 f5178107a3..5195995514 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 9cf4e3bc3f..5a8a05990a 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 dcd5e177e2..99759cf2c9 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 d6548f2c5d..0255b97b1e 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 ff2fa94147..85b085442b 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 1c71d1e9bc..ecd65597f9 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,11 +1,11 @@ ModifierProject | platform-bible-utils

                Interface ModifierProject

                Modifies setting type to be project setting

                -
                interface ModifierProject {
                    excludeProjectTypes?: string | string[];
                    includeProjectTypes?: string | string[];
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface ModifierProject {
                    excludeProjectTypes?: string | string[];
                    includeProjectTypes?: string | string[];
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                excludeProjectTypes?: string | string[]

                RegExp pattern to match against projectType to determine if this project setting should absolutely not be displayed in the Project Settings dialog of that projectType even if it matches with includeProjectTypes

                -
                includeProjectTypes?: string | string[]

                RegExp pattern(s) to match against projectType (using the +

                includeProjectTypes?: string | string[]

                RegExp pattern(s) to match against projectType (using the test function) to determine whether this project setting should be displayed in the Project Settings Dialog of that projectType. null means do not show on any Project Settings dialog

                -
                \ 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 5ea1904e7b..6d35d1bd3b 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 eb2aba82e3..e91908a7df 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 b84e297133..423670590d 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 fbdd50ff0f..1aa24eab92 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 e5261be32a..3adb407292 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 ec1b581335..93bede5e07 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 4bf22593d1..d4e85f7341 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 73e8b61911..9f0960e0c4 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 24d8304bb9..9df44700e4 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,9 +1,9 @@ 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

                -
                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 779ad00ee6..341ad985b7 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 6ff156fa2f..b31da8509e 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 ea56034881..dafac8fa7c 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 899b7e6fb1..4f749e156a 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 fe5a356426..180587d043 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 b724889090..b4be25d24a 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 575dfdd891..dbb0d5b280 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 1c80a3fd02..7ce71ef63f 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 f0f4935dea..e4260fcea2 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 918dd1d7d9..de2d4e17fa 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 a104172d0f..45276958e8 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 9ad9ca3de8..f8ee3c5b21 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 a1c8d972d2..20e4398ba3 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 a57e82b481..40099457eb 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 78e7eb914f..7f84bdb077 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 f26b7cd218..c67143e7bd 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 9e489d8ae7..65c1bf57c1 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 4073af9f13..28112c3290 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 4cdbc7a3d5..1c7a233461 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 c484b6f5be..532fdc0c39 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

                Type declaration

                • command: ReferencedItem

                  Name of the PAPI command to run when this menu item is selected.

                • Optional iconPathAfter?: string

                  Path to the icon to display after the menu text

                • Optional iconPathBefore?: string

                  Path to the icon to display before the menu text

                  -
                \ 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 84a2c16396..aa5fa1d8d8 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 f4b26cdb8c..f1fe6c6d3b 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 a220c0c74b..c9a0ed6f39 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 0c22d64687..ad89f13efa 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 1e7161d06a..faed7795d6 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 a473e6d675..4bcbb4c8d3 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 d7755542f3..195276983a 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 0c3c491fbb..c33339713a 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 92b47499e8..5f1bd1a1c4 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 a4795b7298..604d7b2e42 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 79a1d64274..36e4274006 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 643fa6c21d..3dd575778f 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 c0f24d326d..eaa2e0ba6a 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/Setting.html b/platform-bible-utils/types/Setting.html index 7c1be7cf1f..3401ba33a8 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 a5c7066f4e..2e3f12335e 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 355190ac64..663ee196fc 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 7387335a5a..1ce6009b1e 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/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index da5a305141..40e32cde9a 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 659cb2312a..b5c13507c9 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 b4c486e63d..c583ea8678 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 3ce206c69e..cf81b8b903 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 6f44b3d68f..2554c4f79d 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 51c99b102f..5ae9412f89 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 7197ae7021..78176f9fdc 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 993e7b0d1e..e4abca067d 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 35a0fd5def..8a9a934678 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 1eb801af98..62505fc46c 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: {
                                    $ref: string;
                                    description: 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: {
                                  $ref: string;
                                  description: 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: {
                                $ref: string;
                                description: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              $ref: string;
                              description: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: 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: {
                                  $ref: string;
                                  description: 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: {
                                $ref: string;
                                description: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              $ref: string;
                              description: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: 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 a41b3c0d5f..a02fa292fe 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 305bc130e7..1045266e88 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: {
                                excludeProjectTypes: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includeProjectTypes: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        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: {
                              excludeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      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: {
                            excludeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              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: {
                              excludeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      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: {
                            excludeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              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 6ec0a0e273..9cbe50e7da 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: {
                                excludeProjectTypes: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includeProjectTypes: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        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: {
                              excludeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      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: {
                            excludeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              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: {
                              excludeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectTypes: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      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: {
                            excludeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectTypes: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectTypes: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              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