@octostar/platform-types 0.5.1 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/enums/ProcessingStatusCode.html +16 -16
- package/dist/docs/enums/SortOrder.html +3 -3
- package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
- package/dist/docs/hierarchy.html +1 -1
- package/dist/docs/index.html +2 -2
- package/dist/docs/interfaces/AIClient.html +6 -0
- package/dist/docs/interfaces/ActionContext.html +4 -4
- package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
- package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
- package/dist/docs/interfaces/ChatMessage.html +15 -0
- package/dist/docs/interfaces/Colorful.html +3 -3
- package/dist/docs/interfaces/Concept.html +12 -12
- package/dist/docs/interfaces/Desktop.html +101 -90
- package/dist/docs/interfaces/DesktopActionContext.html +7 -7
- package/dist/docs/interfaces/DesktopSettings.html +5 -5
- package/dist/docs/interfaces/FetchOptions.html +4 -0
- package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
- package/dist/docs/interfaces/IDataTransfer.html +11 -11
- package/dist/docs/interfaces/Inheritance.html +5 -5
- package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
- package/dist/docs/interfaces/NativeFilterScope.html +2 -2
- package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
- package/dist/docs/interfaces/Ontology.html +38 -33
- package/dist/docs/interfaces/OsAPIClient.html +18 -0
- package/dist/docs/interfaces/ProcessingStatus.html +7 -7
- package/dist/docs/interfaces/Property.html +5 -5
- package/dist/docs/interfaces/RecordData.html +5 -5
- package/dist/docs/interfaces/RecordProvider.html +6 -6
- package/dist/docs/interfaces/RefObject.html +3 -3
- package/dist/docs/interfaces/Relationship.html +20 -20
- package/dist/docs/interfaces/SavedDatasource.html +2 -2
- package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
- package/dist/docs/interfaces/SavedSearchContent.html +2 -2
- package/dist/docs/interfaces/SavedSetContent.html +3 -0
- package/dist/docs/interfaces/SearchOptions.html +4 -0
- package/dist/docs/interfaces/SearchProps.html +6 -6
- package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
- package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
- package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
- package/dist/docs/interfaces/StreamJsonOptions.html +6 -0
- package/dist/docs/interfaces/StreamOptions.html +6 -0
- package/dist/docs/interfaces/StreamTextOptions.html +6 -0
- package/dist/docs/interfaces/StylerContext.html +11 -11
- package/dist/docs/interfaces/TagAttributes.html +7 -7
- package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
- package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
- package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
- package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
- package/dist/docs/modules.html +17 -3
- package/dist/docs/types/ActionHandler.html +2 -2
- package/dist/docs/types/AddCommentParams.html +2 -2
- package/dist/docs/types/AddListener.html +2 -2
- package/dist/docs/types/ApiErrorResult.html +2 -2
- package/dist/docs/types/ApiResult.html +2 -2
- package/dist/docs/types/ApiSuccessResult.html +2 -2
- package/dist/docs/types/App.html +2 -2
- package/dist/docs/types/AppRegistry.html +2 -2
- package/dist/docs/types/AppServiceCallOptions.html +2 -2
- package/dist/docs/types/AppServiceCallProps.html +2 -2
- package/dist/docs/types/AsyncFilter.html +2 -2
- package/dist/docs/types/AttachmentResponseType.html +2 -2
- package/dist/docs/types/AttachmentType.html +2 -2
- package/dist/docs/types/Behaviour.html +2 -2
- package/dist/docs/types/BinaryOperator.html +2 -2
- package/dist/docs/types/Callback.html +2 -2
- package/dist/docs/types/ChatModel.html +2 -0
- package/dist/docs/types/CommentWorkspaceItem.html +2 -2
- package/dist/docs/types/Comparator.html +2 -2
- package/dist/docs/types/ConceptFilter.html +2 -2
- package/dist/docs/types/ConceptMap.html +2 -2
- package/dist/docs/types/ConceptName.html +1 -1
- package/dist/docs/types/ConceptWithParents.html +2 -2
- package/dist/docs/types/ConnectedEntity.html +2 -2
- package/dist/docs/types/ContextMenuGroup.html +2 -2
- package/dist/docs/types/ContextMenuLabels.html +2 -2
- package/dist/docs/types/ContextMenuOptions.html +2 -2
- package/dist/docs/types/ContextMenuParams.html +2 -2
- package/dist/docs/types/ContextMenuRequest.html +2 -2
- package/dist/docs/types/CopyOptions.html +2 -2
- package/dist/docs/types/CreateEntityFormProps.html +2 -2
- package/dist/docs/types/CreateLinkChartFn.html +1 -1
- package/dist/docs/types/CreateLinkChartParams.html +1 -1
- package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
- package/dist/docs/types/CustomEventListener.html +2 -2
- package/dist/docs/types/CustomTemplate.html +2 -2
- package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
- package/dist/docs/types/DataContextType.html +2 -2
- package/dist/docs/types/DataMask.html +1 -1
- package/dist/docs/types/DesktopAction.html +2 -2
- package/dist/docs/types/DesktopActionFilter.html +2 -2
- package/dist/docs/types/DesktopActionMenuItem.html +2 -2
- package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
- package/dist/docs/types/DesktopActionOptions.html +4 -2
- package/dist/docs/types/DesktopOpenParams.html +2 -2
- package/dist/docs/types/DesktopStylerContext.html +2 -2
- package/dist/docs/types/DraftWorkspaceItem.html +2 -2
- package/dist/docs/types/DragEndParams.html +2 -2
- package/dist/docs/types/DragStartParams.html +2 -2
- package/dist/docs/types/DropZoneRequestFn.html +1 -1
- package/dist/docs/types/DropZoneRequestResult.html +1 -1
- package/dist/docs/types/EConnection.html +2 -2
- package/dist/docs/types/EdgeSpec.html +2 -2
- package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
- package/dist/docs/types/Entity.html +3 -5
- package/dist/docs/types/EntityBase.html +4 -0
- package/dist/docs/types/EntityEdge.html +2 -2
- package/dist/docs/types/EntityOTM.html +2 -2
- package/dist/docs/types/EntityPasteContext.html +2 -2
- package/dist/docs/types/EvalContext.html +1 -1
- package/dist/docs/types/EventContextType.html +2 -2
- package/dist/docs/types/EventEmitterType.html +2 -2
- package/dist/docs/types/EventName.html +2 -2
- package/dist/docs/types/EventProducer.html +2 -2
- package/dist/docs/types/EventPublisher.html +2 -2
- package/dist/docs/types/EventSubscriber.html +2 -2
- package/dist/docs/types/EventUnsubscriber.html +2 -2
- package/dist/docs/types/ExportOptions.html +2 -2
- package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
- package/dist/docs/types/ExtrasApi.html +1 -1
- package/dist/docs/types/FetchEntityOptions.html +2 -0
- package/dist/docs/types/FileCode.html +2 -2
- package/dist/docs/types/FileTreeOptions.html +2 -2
- package/dist/docs/types/Filter.html +1 -1
- package/dist/docs/types/FilterDefinition.html +2 -2
- package/dist/docs/types/FilterDefinitions.html +2 -2
- package/dist/docs/types/FilterName.html +2 -2
- package/dist/docs/types/FilterReference.html +2 -2
- package/dist/docs/types/FilterState.html +1 -1
- package/dist/docs/types/FocusListItem.html +2 -2
- package/dist/docs/types/FolderPasteOptions.html +2 -2
- package/dist/docs/types/GraphDataSpec.html +1 -1
- package/dist/docs/types/GraphSpec.html +2 -2
- package/dist/docs/types/HttpTransformDefinition.html +2 -2
- package/dist/docs/types/Icon.html +2 -2
- package/dist/docs/types/IconProps.html +2 -2
- package/dist/docs/types/IframeTransformDefinition.html +2 -2
- package/dist/docs/types/ImageInfo.html +2 -2
- package/dist/docs/types/ImportZipOptions.html +2 -2
- package/dist/docs/types/InlineCode.html +2 -2
- package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
- package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
- package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
- package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
- package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
- package/dist/docs/types/JavascriptType.html +2 -2
- package/dist/docs/types/JobManifest.html +2 -2
- package/dist/docs/types/KnownCounts.html +2 -2
- package/dist/docs/types/ManifestSecrets.html +1 -1
- package/dist/docs/types/ModalTemplateProps.html +2 -2
- package/dist/docs/types/NamedEntityGroup.html +2 -2
- package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
- package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
- package/dist/docs/types/NunjucksType.html +2 -2
- package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
- package/dist/docs/types/OntologyTags.html +2 -2
- package/dist/docs/types/OsAuditFields.html +2 -2
- package/dist/docs/types/OsConfirmProps.html +2 -2
- package/dist/docs/types/OsNotification.html +2 -2
- package/dist/docs/types/OsProgress.html +2 -2
- package/dist/docs/types/OsTag.html +2 -2
- package/dist/docs/types/OsWorkspaceEntity.html +2 -2
- package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
- package/dist/docs/types/PasteContextOptions.html +2 -2
- package/dist/docs/types/Permission.html +2 -2
- package/dist/docs/types/Point.html +2 -2
- package/dist/docs/types/PromptOptions.html +2 -0
- package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
- package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
- package/dist/docs/types/PythonFileStylerDefinition.html +2 -2
- package/dist/docs/types/PythonFileTransformDefinition.html +2 -2
- package/dist/docs/types/PythonFilterDefinition.html +2 -2
- package/dist/docs/types/PythonInlineStylerDefinition.html +2 -2
- package/dist/docs/types/PythonInlineTransformDefinition.html +2 -2
- package/dist/docs/types/PythonType.html +2 -2
- package/dist/docs/types/Query.html +2 -2
- package/dist/docs/types/QueryBatchResult.html +2 -2
- package/dist/docs/types/QueryErrorResult.html +2 -2
- package/dist/docs/types/QueryExecutor.html +2 -2
- package/dist/docs/types/QueryObjectFilterClause.html +2 -2
- package/dist/docs/types/QueryResponse.html +2 -2
- package/dist/docs/types/QueryResult.html +2 -2
- package/dist/docs/types/QuerySuccessResult.html +2 -2
- package/dist/docs/types/ReactCssProperties.html +2 -2
- package/dist/docs/types/ReactNode.html +2 -2
- package/dist/docs/types/ReactRef.html +2 -2
- package/dist/docs/types/ReasonedBoolean.html +2 -2
- package/dist/docs/types/RecordFetchOptions.html +1 -1
- package/dist/docs/types/RefCallback.html +2 -2
- package/dist/docs/types/RelationshipCountResult.html +2 -2
- package/dist/docs/types/RemoteAppApi.html +1 -1
- package/dist/docs/types/SaveAsModalProps.html +2 -2
- package/dist/docs/types/SaveFileOptions.html +2 -2
- package/dist/docs/types/SaveOptions.html +2 -2
- package/dist/docs/types/SavedTemplate.html +2 -2
- package/dist/docs/types/SearchFilter.html +2 -2
- package/dist/docs/types/SemanticBinding.html +2 -2
- package/dist/docs/types/SemanticBindingType.html +2 -2
- package/dist/docs/types/SemanticBindings.html +2 -2
- package/dist/docs/types/SemanticallyBoundApp.html +2 -2
- package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
- package/dist/docs/types/SendQueryOptions.html +2 -2
- package/dist/docs/types/ServiceDefinition.html +2 -2
- package/dist/docs/types/ServiceDefinitions.html +2 -2
- package/dist/docs/types/ServiceRole.html +2 -2
- package/dist/docs/types/SetTransformResultFn.html +1 -1
- package/dist/docs/types/ShowOntology.html +2 -2
- package/dist/docs/types/ShowTabProps.html +2 -2
- package/dist/docs/types/Styler.html +2 -2
- package/dist/docs/types/StylerConfig.html +2 -2
- package/dist/docs/types/StylerDefinition.html +2 -2
- package/dist/docs/types/StylerDefinitions.html +2 -2
- package/dist/docs/types/StylerOption.html +2 -2
- package/dist/docs/types/StylerProducer.html +2 -2
- package/dist/docs/types/SubscribeDragStartFn.html +1 -1
- package/dist/docs/types/SubscribeToContextFn.html +1 -1
- package/dist/docs/types/Tag.html +2 -2
- package/dist/docs/types/TagInfo.html +2 -2
- package/dist/docs/types/TagWithRelationship.html +2 -2
- package/dist/docs/types/TaskCleanupReason.html +2 -2
- package/dist/docs/types/TemplateMetadata.html +2 -2
- package/dist/docs/types/TemplateType.html +2 -2
- package/dist/docs/types/TemplateVariant.html +2 -2
- package/dist/docs/types/TransformAction.html +2 -2
- package/dist/docs/types/TransformActionContext.html +2 -2
- package/dist/docs/types/TransformDefinition.html +2 -2
- package/dist/docs/types/TransformDefinitions.html +2 -2
- package/dist/docs/types/Unsubscribe.html +2 -2
- package/dist/docs/types/UnsubscribeFn.html +1 -1
- package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
- package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
- package/dist/docs/types/UserProfile.html +2 -2
- package/dist/docs/types/Watcher.html +2 -2
- package/dist/docs/types/Whoami.html +2 -2
- package/dist/docs/types/WithProgressBarOptions.html +2 -2
- package/dist/docs/types/Workspace.html +2 -2
- package/dist/docs/types/WorkspaceConfig.html +1 -0
- package/dist/docs/types/WorkspaceFlags.html +2 -2
- package/dist/docs/types/WorkspaceIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItem.html +2 -2
- package/dist/docs/types/WorkspaceItemBase.html +2 -2
- package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItemModel.html +2 -2
- package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
- package/dist/docs/types/WorkspaceItems.html +2 -2
- package/dist/docs/types/WorkspacePermission.html +2 -2
- package/dist/docs/types/WorkspaceRecord.html +2 -2
- package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
- package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
- package/dist/docs/types/WorkspaceRecords.html +2 -2
- package/dist/docs/types/WorkspaceRelationship.html +2 -2
- package/dist/docs/types/WorkspaceSettings.html +2 -2
- package/dist/docs/types/trigger.html +2 -2
- package/dist/docs/types/uuid.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
- package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
- package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
- package/dist/platform-types.d.ts +207 -6
- package/lib/ai.d.ts +54 -0
- package/lib/ai.d.ts.map +1 -0
- package/lib/ai.js +2 -0
- package/lib/ai.js.map +1 -0
- package/lib/client.d.ts +71 -0
- package/lib/client.d.ts.map +1 -0
- package/lib/client.js +2 -0
- package/lib/client.js.map +1 -0
- package/lib/desktop.d.ts +42 -3
- package/lib/desktop.d.ts.map +1 -1
- package/lib/desktop.js.map +1 -1
- package/lib/index.d.ts +2 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +2 -0
- package/lib/index.js.map +1 -1
- package/lib/model.d.ts +8 -2
- package/lib/model.d.ts.map +1 -1
- package/lib/model.js.map +1 -1
- package/lib/ontology.d.ts +8 -0
- package/lib/ontology.d.ts.map +1 -1
- package/lib/savedSearch.d.ts +4 -0
- package/lib/savedSearch.d.ts.map +1 -1
- package/lib/savedSearch.js.map +1 -1
- package/lib/search.d.ts +10 -0
- package/lib/search.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OS_CONFIRM_MODAL_YES | @octostar/platform-types - v0.5.
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OS_CONFIRM_MODAL_YES | @octostar/platform-types - v0.5.2</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="OS_CONFIRM_MODAL_YES.html">OS_CONFIRM_MODAL_YES</a></li></ul><h1>Variable OS_CONFIRM_MODAL_YES<code class="tsd-tag">Const</code> <code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">OS_<wbr/>CONFIRM_<wbr/>MODAL_<wbr/>YES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div><div class="tsd-comment tsd-typography"><p>Affirmative option for the confirmation modal.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/00fd2d55a0d79744840182541702360e40a09812/superset-frontend/packages/octostar-platform-types/src/desktop.ts#L431">desktop.ts:431</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_MESSAGE_TYPES | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_MESSAGE_TYPES | @octostar/platform-types - v0.5.2</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_MESSAGE_TYPES.html">SAVED_SEARCH_MESSAGE_TYPES</a></li></ul><h1>Variable SAVED_SEARCH_MESSAGE_TYPES<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>MESSAGE_<wbr/>TYPES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">getRecords</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"octostar:savedSearch:getRecords"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getRecordsCount</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"octostar:savedSearch:getRecordsCount"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getRecordsCountQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"octostar:savedSearch:getRecordsCountQuery"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getRecordsQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"octostar:savedSearch:getRecordsQuery"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getSavedSearchPasteContext</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"octostar:savedSearch:getSavedSearchPasteContext"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/00fd2d55a0d79744840182541702360e40a09812/superset-frontend/packages/octostar-platform-types/src/savedSearch.ts#L135">savedSearch.ts:135</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_PREFIX | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_PREFIX | @octostar/platform-types - v0.5.2</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_PREFIX.html">SAVED_SEARCH_PREFIX</a></li></ul><h1>Variable SAVED_SEARCH_PREFIX<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>PREFIX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"octostar:savedSearch:"</span><span class="tsd-signature-symbol"> = 'octostar:savedSearch:'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/00fd2d55a0d79744840182541702360e40a09812/superset-frontend/packages/octostar-platform-types/src/savedSearch.ts#L134">savedSearch.ts:134</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/dist/platform-types.d.ts
CHANGED
|
@@ -70,6 +70,20 @@ export declare type AddCommentParams = {
|
|
|
70
70
|
*/
|
|
71
71
|
export declare type AddListener<T> = (callback: Callback<T>) => Promise<Unsubscribe>;
|
|
72
72
|
|
|
73
|
+
/**
|
|
74
|
+
* The interface for the AI client.
|
|
75
|
+
*/
|
|
76
|
+
export declare interface AIClient {
|
|
77
|
+
/**
|
|
78
|
+
* Get the chat models.
|
|
79
|
+
*/
|
|
80
|
+
getChatModels(): Promise<ChatModel[]>;
|
|
81
|
+
/**
|
|
82
|
+
* Prompt the AI.
|
|
83
|
+
*/
|
|
84
|
+
prompt(prompt: string, options?: PromptOptions): Promise<string>;
|
|
85
|
+
}
|
|
86
|
+
|
|
73
87
|
/**
|
|
74
88
|
* @beta
|
|
75
89
|
* Type representing an error API result.
|
|
@@ -277,6 +291,41 @@ export declare interface ChartDataResponseResult {
|
|
|
277
291
|
to_dttm: number | null;
|
|
278
292
|
}
|
|
279
293
|
|
|
294
|
+
export declare interface ChatMessage {
|
|
295
|
+
/**
|
|
296
|
+
* The id of the message. This is used to identify the message in the conversation.
|
|
297
|
+
* It is generated by the chat agent, and is used to update the message in the conversation.
|
|
298
|
+
* (It is repeated in each update, but this is ok because it is used to identify the message in the conversation.)
|
|
299
|
+
*/
|
|
300
|
+
id: string;
|
|
301
|
+
/**
|
|
302
|
+
* The role of the message.
|
|
303
|
+
*/
|
|
304
|
+
role: 'user' | 'assistant' | 'system';
|
|
305
|
+
/**
|
|
306
|
+
* The content of the message.
|
|
307
|
+
* For `update` and `complete` messages, this is the partial or final response.
|
|
308
|
+
* For `add_entities` and `remove_entities` messages, this is the json encoded list of entities.
|
|
309
|
+
*/
|
|
310
|
+
content: string;
|
|
311
|
+
/**
|
|
312
|
+
* The type of the message.
|
|
313
|
+
*/
|
|
314
|
+
type?: 'update' | 'complete' | 'add_entities' | 'remove_entities';
|
|
315
|
+
/**
|
|
316
|
+
* The timestamp of the message in ISO 8601 format.
|
|
317
|
+
*/
|
|
318
|
+
timestamp?: string;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* The type for the chat model.
|
|
323
|
+
*/
|
|
324
|
+
export declare type ChatModel = {
|
|
325
|
+
model_name: string;
|
|
326
|
+
description: string;
|
|
327
|
+
};
|
|
328
|
+
|
|
280
329
|
/**
|
|
281
330
|
* Interface for items that can have a color attribute.
|
|
282
331
|
* @beta
|
|
@@ -687,6 +736,14 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
687
736
|
* Gets items in a workspace by name.
|
|
688
737
|
*/
|
|
689
738
|
getWorkspaceItems(os_item_name: string): Promise<WorkspaceItem[]>;
|
|
739
|
+
/**
|
|
740
|
+
* Gets the OsAPIClient.
|
|
741
|
+
*/
|
|
742
|
+
getOsAPIClient(): Promise<OsAPIClient>;
|
|
743
|
+
/**
|
|
744
|
+
* Gets the AI client.
|
|
745
|
+
*/
|
|
746
|
+
getAIClient(): Promise<AIClient>;
|
|
690
747
|
/**
|
|
691
748
|
* Applies a tag to an entity.
|
|
692
749
|
*/
|
|
@@ -734,7 +791,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
734
791
|
/**
|
|
735
792
|
* Creates a workspace by name.
|
|
736
793
|
*/
|
|
737
|
-
createWorkspace: (name: string) => Promise<WorkspaceItem>;
|
|
794
|
+
createWorkspace: (name: string, config?: WorkspaceConfig) => Promise<WorkspaceItem>;
|
|
738
795
|
/**
|
|
739
796
|
* Connects two entities with a relationship in a workspace.
|
|
740
797
|
*/
|
|
@@ -759,6 +816,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
759
816
|
* Exports an item or items with optional export options.
|
|
760
817
|
*/
|
|
761
818
|
export: (item: WorkspaceItem | WorkspaceItem[], options?: ExportOptions) => Promise<void>;
|
|
819
|
+
/**
|
|
820
|
+
* Fetches an entity from the index, or from the ontology if not found in the index.
|
|
821
|
+
*/
|
|
822
|
+
fetchEntity: (entity: EntityBase, options?: FetchEntityOptions) => Promise<Entity>;
|
|
762
823
|
/**
|
|
763
824
|
* Extracts entities from some text which may be json or a list of urls.
|
|
764
825
|
*/
|
|
@@ -787,6 +848,13 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
787
848
|
* Deletes local concept records in a workspace by base concept.
|
|
788
849
|
*/
|
|
789
850
|
delete_local_concept_records: (workspace_id: string, base_concept: string) => Promise<void>;
|
|
851
|
+
/**
|
|
852
|
+
* Searches the index using the query string
|
|
853
|
+
* @param query OpenSearch qeuery string.
|
|
854
|
+
* @param options query options
|
|
855
|
+
* @returns a promise resolving to the found entities.
|
|
856
|
+
*/
|
|
857
|
+
search: (query: string, options?: SearchOptions) => Promise<Entity[]>;
|
|
790
858
|
/**
|
|
791
859
|
* Searches experience with optional search options.
|
|
792
860
|
*/
|
|
@@ -1080,6 +1148,14 @@ export declare type DesktopActionOptions = {
|
|
|
1080
1148
|
* Whether to raise the tab to the front.
|
|
1081
1149
|
*/
|
|
1082
1150
|
raiseOnly?: boolean;
|
|
1151
|
+
/**
|
|
1152
|
+
* Open tab in a new tabset
|
|
1153
|
+
*/
|
|
1154
|
+
newTabset?: boolean;
|
|
1155
|
+
/**
|
|
1156
|
+
* Wait for the tab to open
|
|
1157
|
+
*/
|
|
1158
|
+
awaitShowTab?: boolean;
|
|
1083
1159
|
};
|
|
1084
1160
|
|
|
1085
1161
|
/**
|
|
@@ -1234,7 +1310,18 @@ export declare type EmitEventTransformDefinition = {
|
|
|
1234
1310
|
* Represents an entity with basic attributes.
|
|
1235
1311
|
* @beta
|
|
1236
1312
|
*/
|
|
1237
|
-
export declare type Entity = {
|
|
1313
|
+
export declare type Entity = EntityBase & {
|
|
1314
|
+
/**
|
|
1315
|
+
* The label of the entity.
|
|
1316
|
+
*/
|
|
1317
|
+
entity_label: string;
|
|
1318
|
+
};
|
|
1319
|
+
|
|
1320
|
+
/**
|
|
1321
|
+
* Represents an entity without a label.
|
|
1322
|
+
* @beta
|
|
1323
|
+
*/
|
|
1324
|
+
export declare type EntityBase = {
|
|
1238
1325
|
/**
|
|
1239
1326
|
* The ID of the entity.
|
|
1240
1327
|
*/
|
|
@@ -1243,10 +1330,6 @@ export declare type Entity = {
|
|
|
1243
1330
|
* The type of the entity.
|
|
1244
1331
|
*/
|
|
1245
1332
|
entity_type: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* The label of the entity.
|
|
1248
|
-
*/
|
|
1249
|
-
entity_label: string;
|
|
1250
1333
|
};
|
|
1251
1334
|
|
|
1252
1335
|
/**
|
|
@@ -1416,6 +1499,23 @@ export declare type ExtrasApi = {
|
|
|
1416
1499
|
createLinkChart: CreateLinkChartFn;
|
|
1417
1500
|
};
|
|
1418
1501
|
|
|
1502
|
+
/**
|
|
1503
|
+
* Options for fetching an entity.
|
|
1504
|
+
* @beta
|
|
1505
|
+
*/
|
|
1506
|
+
export declare type FetchEntityOptions = {};
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* @beta
|
|
1510
|
+
* Options for fetching data from an API.
|
|
1511
|
+
*/
|
|
1512
|
+
export declare interface FetchOptions extends RequestInit {
|
|
1513
|
+
/**
|
|
1514
|
+
* The API endpoint to hit, starting with a slash.
|
|
1515
|
+
*/
|
|
1516
|
+
endpoint: string;
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1419
1519
|
/**
|
|
1420
1520
|
* @beta
|
|
1421
1521
|
* File containing the code. Not yet supported.
|
|
@@ -1992,6 +2092,13 @@ export declare interface Ontology {
|
|
|
1992
2092
|
* @returns A promise that resolves to an array of connected entities.
|
|
1993
2093
|
*/
|
|
1994
2094
|
getConnectedEntities: <T extends Entity>(entity: Entity, relationship: Relationship | string, forceRefresh?: boolean) => Promise<T[]>;
|
|
2095
|
+
/**
|
|
2096
|
+
* Gets connections by type for a given entity and concept.
|
|
2097
|
+
* @param entity - The entity for which to get connections.
|
|
2098
|
+
* @param concept - The concept for which to get connections.
|
|
2099
|
+
* @returns A promise that resolves to an array of connections.
|
|
2100
|
+
*/
|
|
2101
|
+
getConnectionsByType: <T extends Entity>(entity: Entity, concept: string) => Promise<EConnection[]>;
|
|
1995
2102
|
/**
|
|
1996
2103
|
* Gets the concept names.
|
|
1997
2104
|
* @returns A promise that resolves to an array concept names.
|
|
@@ -2123,6 +2230,37 @@ export declare type OS_CONFIRM_MODAL_RESPONSE = typeof OS_CONFIRM_MODAL_YES | ty
|
|
|
2123
2230
|
*/
|
|
2124
2231
|
export declare const OS_CONFIRM_MODAL_YES = true;
|
|
2125
2232
|
|
|
2233
|
+
/**
|
|
2234
|
+
* @beta
|
|
2235
|
+
* Interface representing a client for interacting with the OctoStar API.
|
|
2236
|
+
*/
|
|
2237
|
+
export declare interface OsAPIClient {
|
|
2238
|
+
/**
|
|
2239
|
+
* Fetch data from the API.
|
|
2240
|
+
* @param options - Configuration options for the fetch request.
|
|
2241
|
+
* @returns A promise that resolves with the fetched data of type T.
|
|
2242
|
+
*/
|
|
2243
|
+
fetchData<T>(options: FetchOptions): Promise<T>;
|
|
2244
|
+
/**
|
|
2245
|
+
* Stream data from the API.
|
|
2246
|
+
* @param options - Configuration options for the stream request.
|
|
2247
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2248
|
+
*/
|
|
2249
|
+
streamData(options: StreamOptions): Promise<void>;
|
|
2250
|
+
/**
|
|
2251
|
+
* Streams text data from the API.
|
|
2252
|
+
* @param options - Configuration options for the stream request.
|
|
2253
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2254
|
+
*/
|
|
2255
|
+
streamText(options: StreamTextOptions): Promise<void>;
|
|
2256
|
+
/**
|
|
2257
|
+
* Streams JSON line data from the API.
|
|
2258
|
+
* @param options - Configuration options for the stream request.
|
|
2259
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2260
|
+
*/
|
|
2261
|
+
streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
|
|
2262
|
+
}
|
|
2263
|
+
|
|
2126
2264
|
/**
|
|
2127
2265
|
* Represents audit fields for OS (Operational Support) records.
|
|
2128
2266
|
* @beta
|
|
@@ -2397,6 +2535,14 @@ export declare enum ProcessingStatusCode {
|
|
|
2397
2535
|
UNKNOWN = "UNKNOWN"
|
|
2398
2536
|
}
|
|
2399
2537
|
|
|
2538
|
+
/**
|
|
2539
|
+
* The options for the prompt.
|
|
2540
|
+
*/
|
|
2541
|
+
export declare type PromptOptions = {
|
|
2542
|
+
model?: string;
|
|
2543
|
+
apiKey?: string;
|
|
2544
|
+
};
|
|
2545
|
+
|
|
2400
2546
|
/**
|
|
2401
2547
|
* Represents a property of a concept.
|
|
2402
2548
|
* @beta
|
|
@@ -2792,6 +2938,11 @@ export declare interface SavedSearchContent {
|
|
|
2792
2938
|
initialCount?: number;
|
|
2793
2939
|
}
|
|
2794
2940
|
|
|
2941
|
+
export declare interface SavedSetContent {
|
|
2942
|
+
lastFiredQuery: string;
|
|
2943
|
+
uiState: Record<string, any>;
|
|
2944
|
+
}
|
|
2945
|
+
|
|
2795
2946
|
/**
|
|
2796
2947
|
* @beta
|
|
2797
2948
|
* Type representing a saved template, extending CustomTemplate.
|
|
@@ -2844,6 +2995,17 @@ export declare type SearchFilter = {
|
|
|
2844
2995
|
imageUrl?: string;
|
|
2845
2996
|
};
|
|
2846
2997
|
|
|
2998
|
+
/**
|
|
2999
|
+
* @beta
|
|
3000
|
+
* Interface representing the options given to search
|
|
3001
|
+
*/
|
|
3002
|
+
export declare interface SearchOptions {
|
|
3003
|
+
/**
|
|
3004
|
+
* The maximum number of entities returned.
|
|
3005
|
+
*/
|
|
3006
|
+
limit?: number;
|
|
3007
|
+
}
|
|
3008
|
+
|
|
2847
3009
|
/**
|
|
2848
3010
|
* @beta
|
|
2849
3011
|
* Interface representing the properties for the Search component.
|
|
@@ -3079,6 +3241,39 @@ export declare enum SortOrder {
|
|
|
3079
3241
|
HIDE = -1
|
|
3080
3242
|
}
|
|
3081
3243
|
|
|
3244
|
+
/**
|
|
3245
|
+
* @beta
|
|
3246
|
+
* Options for streaming JSON line data from an API.
|
|
3247
|
+
*/
|
|
3248
|
+
export declare interface StreamJsonOptions<T> extends FetchOptions {
|
|
3249
|
+
/**
|
|
3250
|
+
* The asynchronous function to process each JSON object.
|
|
3251
|
+
*/
|
|
3252
|
+
jsonHandler: (value: T) => Promise<void>;
|
|
3253
|
+
}
|
|
3254
|
+
|
|
3255
|
+
/**
|
|
3256
|
+
* @beta
|
|
3257
|
+
* Options for streaming data from an API.
|
|
3258
|
+
*/
|
|
3259
|
+
export declare interface StreamOptions extends FetchOptions {
|
|
3260
|
+
/**
|
|
3261
|
+
* The asynchronous function to process each chunk of data.
|
|
3262
|
+
*/
|
|
3263
|
+
handler: (chunk: Uint8Array) => Promise<void>;
|
|
3264
|
+
}
|
|
3265
|
+
|
|
3266
|
+
/**
|
|
3267
|
+
* @beta
|
|
3268
|
+
* Options for streaming text data from an API.
|
|
3269
|
+
*/
|
|
3270
|
+
export declare interface StreamTextOptions extends FetchOptions {
|
|
3271
|
+
/**
|
|
3272
|
+
* The asynchronous function to process each line of text.
|
|
3273
|
+
*/
|
|
3274
|
+
handler: (line: string) => Promise<void>;
|
|
3275
|
+
}
|
|
3276
|
+
|
|
3082
3277
|
/**
|
|
3083
3278
|
* @beta
|
|
3084
3279
|
* Type representing a styler with methods for getting G6 node and edge styles.
|
|
@@ -3549,6 +3744,12 @@ export declare interface WorkspaceChangeEmitter {
|
|
|
3549
3744
|
onOpenWorkspacesChanged: AddListener<Workspace[]>;
|
|
3550
3745
|
}
|
|
3551
3746
|
|
|
3747
|
+
export declare type WorkspaceConfig = Partial<{
|
|
3748
|
+
description: string;
|
|
3749
|
+
os_icon: string;
|
|
3750
|
+
color: string;
|
|
3751
|
+
}>;
|
|
3752
|
+
|
|
3552
3753
|
/**
|
|
3553
3754
|
*
|
|
3554
3755
|
* @beta
|
package/lib/ai.d.ts
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The type for the chat model.
|
|
3
|
+
*/
|
|
4
|
+
export type ChatModel = {
|
|
5
|
+
model_name: string;
|
|
6
|
+
description: string;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* The options for the prompt.
|
|
10
|
+
*/
|
|
11
|
+
export type PromptOptions = {
|
|
12
|
+
model?: string;
|
|
13
|
+
apiKey?: string;
|
|
14
|
+
};
|
|
15
|
+
export interface ChatMessage {
|
|
16
|
+
/**
|
|
17
|
+
* The id of the message. This is used to identify the message in the conversation.
|
|
18
|
+
* It is generated by the chat agent, and is used to update the message in the conversation.
|
|
19
|
+
* (It is repeated in each update, but this is ok because it is used to identify the message in the conversation.)
|
|
20
|
+
*/
|
|
21
|
+
id: string;
|
|
22
|
+
/**
|
|
23
|
+
* The role of the message.
|
|
24
|
+
*/
|
|
25
|
+
role: 'user' | 'assistant' | 'system';
|
|
26
|
+
/**
|
|
27
|
+
* The content of the message.
|
|
28
|
+
* For `update` and `complete` messages, this is the partial or final response.
|
|
29
|
+
* For `add_entities` and `remove_entities` messages, this is the json encoded list of entities.
|
|
30
|
+
*/
|
|
31
|
+
content: string;
|
|
32
|
+
/**
|
|
33
|
+
* The type of the message.
|
|
34
|
+
*/
|
|
35
|
+
type?: 'update' | 'complete' | 'add_entities' | 'remove_entities';
|
|
36
|
+
/**
|
|
37
|
+
* The timestamp of the message in ISO 8601 format.
|
|
38
|
+
*/
|
|
39
|
+
timestamp?: string;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* The interface for the AI client.
|
|
43
|
+
*/
|
|
44
|
+
export interface AIClient {
|
|
45
|
+
/**
|
|
46
|
+
* Get the chat models.
|
|
47
|
+
*/
|
|
48
|
+
getChatModels(): Promise<ChatModel[]>;
|
|
49
|
+
/**
|
|
50
|
+
* Prompt the AI.
|
|
51
|
+
*/
|
|
52
|
+
prompt(prompt: string, options?: PromptOptions): Promise<string>;
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=ai.d.ts.map
|
package/lib/ai.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../src/ai.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAClE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,aAAa,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAClE"}
|
package/lib/ai.js
ADDED
package/lib/ai.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ai.js","sourceRoot":"","sources":["../src/ai.ts"],"names":[],"mappings":""}
|
package/lib/client.d.ts
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @beta
|
|
3
|
+
* Options for fetching data from an API.
|
|
4
|
+
*/
|
|
5
|
+
export interface FetchOptions extends RequestInit {
|
|
6
|
+
/**
|
|
7
|
+
* The API endpoint to hit, starting with a slash.
|
|
8
|
+
*/
|
|
9
|
+
endpoint: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* @beta
|
|
13
|
+
* Interface representing a client for interacting with the OctoStar API.
|
|
14
|
+
*/
|
|
15
|
+
export interface OsAPIClient {
|
|
16
|
+
/**
|
|
17
|
+
* Fetch data from the API.
|
|
18
|
+
* @param options - Configuration options for the fetch request.
|
|
19
|
+
* @returns A promise that resolves with the fetched data of type T.
|
|
20
|
+
*/
|
|
21
|
+
fetchData<T>(options: FetchOptions): Promise<T>;
|
|
22
|
+
/**
|
|
23
|
+
* Stream data from the API.
|
|
24
|
+
* @param options - Configuration options for the stream request.
|
|
25
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
26
|
+
*/
|
|
27
|
+
streamData(options: StreamOptions): Promise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Streams text data from the API.
|
|
30
|
+
* @param options - Configuration options for the stream request.
|
|
31
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
32
|
+
*/
|
|
33
|
+
streamText(options: StreamTextOptions): Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Streams JSON line data from the API.
|
|
36
|
+
* @param options - Configuration options for the stream request.
|
|
37
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
38
|
+
*/
|
|
39
|
+
streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @beta
|
|
43
|
+
* Options for streaming data from an API.
|
|
44
|
+
*/
|
|
45
|
+
export interface StreamOptions extends FetchOptions {
|
|
46
|
+
/**
|
|
47
|
+
* The asynchronous function to process each chunk of data.
|
|
48
|
+
*/
|
|
49
|
+
handler: (chunk: Uint8Array) => Promise<void>;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @beta
|
|
53
|
+
* Options for streaming text data from an API.
|
|
54
|
+
*/
|
|
55
|
+
export interface StreamTextOptions extends FetchOptions {
|
|
56
|
+
/**
|
|
57
|
+
* The asynchronous function to process each line of text.
|
|
58
|
+
*/
|
|
59
|
+
handler: (line: string) => Promise<void>;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @beta
|
|
63
|
+
* Options for streaming JSON line data from an API.
|
|
64
|
+
*/
|
|
65
|
+
export interface StreamJsonOptions<T> extends FetchOptions {
|
|
66
|
+
/**
|
|
67
|
+
* The asynchronous function to process each JSON object.
|
|
68
|
+
*/
|
|
69
|
+
jsonHandler: (value: T) => Promise<void>;
|
|
70
|
+
}
|
|
71
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhD;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;OAIG;IACH,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;OAEG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,YAAY;IACxD;;OAEG;IACH,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C"}
|
package/lib/client.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":""}
|