@octostar/platform-types 0.5.1 → 0.5.3

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.
Files changed (287) hide show
  1. package/dist/docs/assets/navigation.js +1 -1
  2. package/dist/docs/assets/search.js +1 -1
  3. package/dist/docs/enums/ProcessingStatusCode.html +16 -16
  4. package/dist/docs/enums/SortOrder.html +3 -3
  5. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  6. package/dist/docs/hierarchy.html +1 -1
  7. package/dist/docs/index.html +2 -2
  8. package/dist/docs/interfaces/AIClient.html +6 -0
  9. package/dist/docs/interfaces/ActionContext.html +4 -4
  10. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  11. package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
  12. package/dist/docs/interfaces/ChatMessage.html +15 -0
  13. package/dist/docs/interfaces/Colorful.html +3 -3
  14. package/dist/docs/interfaces/Concept.html +12 -12
  15. package/dist/docs/interfaces/Desktop.html +103 -90
  16. package/dist/docs/interfaces/DesktopActionContext.html +7 -7
  17. package/dist/docs/interfaces/DesktopSettings.html +5 -5
  18. package/dist/docs/interfaces/FetchOptions.html +4 -0
  19. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  20. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  21. package/dist/docs/interfaces/Inheritance.html +5 -5
  22. package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
  23. package/dist/docs/interfaces/NativeFilterScope.html +2 -2
  24. package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
  25. package/dist/docs/interfaces/Ontology.html +38 -33
  26. package/dist/docs/interfaces/OsAPIClient.html +18 -0
  27. package/dist/docs/interfaces/ProcessingStatus.html +7 -7
  28. package/dist/docs/interfaces/Property.html +5 -5
  29. package/dist/docs/interfaces/RecordData.html +5 -5
  30. package/dist/docs/interfaces/RecordProvider.html +6 -6
  31. package/dist/docs/interfaces/RefObject.html +3 -3
  32. package/dist/docs/interfaces/Relationship.html +20 -20
  33. package/dist/docs/interfaces/SavedDatasource.html +2 -2
  34. package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
  35. package/dist/docs/interfaces/SavedSearchContent.html +2 -2
  36. package/dist/docs/interfaces/SavedSetContent.html +3 -0
  37. package/dist/docs/interfaces/SearchOptions.html +4 -0
  38. package/dist/docs/interfaces/SearchProps.html +11 -7
  39. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  40. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  41. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  42. package/dist/docs/interfaces/StreamJsonOptions.html +6 -0
  43. package/dist/docs/interfaces/StreamOptions.html +6 -0
  44. package/dist/docs/interfaces/StreamTextOptions.html +6 -0
  45. package/dist/docs/interfaces/StylerContext.html +11 -11
  46. package/dist/docs/interfaces/TagAttributes.html +7 -7
  47. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  48. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  49. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  50. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  51. package/dist/docs/modules.html +17 -3
  52. package/dist/docs/types/ActionHandler.html +2 -2
  53. package/dist/docs/types/AddCommentParams.html +2 -2
  54. package/dist/docs/types/AddListener.html +2 -2
  55. package/dist/docs/types/ApiErrorResult.html +2 -2
  56. package/dist/docs/types/ApiResult.html +2 -2
  57. package/dist/docs/types/ApiSuccessResult.html +2 -2
  58. package/dist/docs/types/App.html +2 -2
  59. package/dist/docs/types/AppRegistry.html +2 -2
  60. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  61. package/dist/docs/types/AppServiceCallProps.html +2 -2
  62. package/dist/docs/types/AsyncFilter.html +2 -2
  63. package/dist/docs/types/AttachmentResponseType.html +2 -2
  64. package/dist/docs/types/AttachmentType.html +2 -2
  65. package/dist/docs/types/Behaviour.html +2 -2
  66. package/dist/docs/types/BinaryOperator.html +2 -2
  67. package/dist/docs/types/Callback.html +2 -2
  68. package/dist/docs/types/ChatModel.html +2 -0
  69. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  70. package/dist/docs/types/Comparator.html +2 -2
  71. package/dist/docs/types/ConceptFilter.html +2 -2
  72. package/dist/docs/types/ConceptMap.html +2 -2
  73. package/dist/docs/types/ConceptName.html +1 -1
  74. package/dist/docs/types/ConceptWithParents.html +2 -2
  75. package/dist/docs/types/ConnectedEntity.html +2 -2
  76. package/dist/docs/types/ContextMenuGroup.html +2 -2
  77. package/dist/docs/types/ContextMenuLabels.html +2 -2
  78. package/dist/docs/types/ContextMenuOptions.html +2 -2
  79. package/dist/docs/types/ContextMenuParams.html +2 -2
  80. package/dist/docs/types/ContextMenuRequest.html +2 -2
  81. package/dist/docs/types/CopyOptions.html +2 -2
  82. package/dist/docs/types/CreateEntityFormProps.html +2 -2
  83. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  84. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  85. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  86. package/dist/docs/types/CustomEventListener.html +2 -2
  87. package/dist/docs/types/CustomTemplate.html +2 -2
  88. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  89. package/dist/docs/types/DataContextType.html +2 -2
  90. package/dist/docs/types/DataMask.html +1 -1
  91. package/dist/docs/types/DesktopAction.html +2 -2
  92. package/dist/docs/types/DesktopActionFilter.html +2 -2
  93. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  94. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  95. package/dist/docs/types/DesktopActionOptions.html +4 -2
  96. package/dist/docs/types/DesktopOpenParams.html +2 -2
  97. package/dist/docs/types/DesktopStylerContext.html +2 -2
  98. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  99. package/dist/docs/types/DragEndParams.html +2 -2
  100. package/dist/docs/types/DragStartParams.html +2 -2
  101. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  102. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  103. package/dist/docs/types/EConnection.html +2 -2
  104. package/dist/docs/types/EdgeSpec.html +2 -2
  105. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  106. package/dist/docs/types/Entity.html +3 -5
  107. package/dist/docs/types/EntityBase.html +4 -0
  108. package/dist/docs/types/EntityEdge.html +2 -2
  109. package/dist/docs/types/EntityOTM.html +2 -2
  110. package/dist/docs/types/EntityPasteContext.html +2 -2
  111. package/dist/docs/types/EvalContext.html +1 -1
  112. package/dist/docs/types/EventContextType.html +2 -2
  113. package/dist/docs/types/EventEmitterType.html +2 -2
  114. package/dist/docs/types/EventName.html +2 -2
  115. package/dist/docs/types/EventProducer.html +2 -2
  116. package/dist/docs/types/EventPublisher.html +2 -2
  117. package/dist/docs/types/EventSubscriber.html +2 -2
  118. package/dist/docs/types/EventUnsubscriber.html +2 -2
  119. package/dist/docs/types/ExportOptions.html +2 -2
  120. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  121. package/dist/docs/types/ExtrasApi.html +1 -1
  122. package/dist/docs/types/FetchEntityOptions.html +2 -0
  123. package/dist/docs/types/FileCode.html +2 -2
  124. package/dist/docs/types/FileTreeOptions.html +2 -2
  125. package/dist/docs/types/Filter.html +1 -1
  126. package/dist/docs/types/FilterDefinition.html +2 -2
  127. package/dist/docs/types/FilterDefinitions.html +2 -2
  128. package/dist/docs/types/FilterName.html +2 -2
  129. package/dist/docs/types/FilterReference.html +2 -2
  130. package/dist/docs/types/FilterState.html +1 -1
  131. package/dist/docs/types/FocusListItem.html +2 -2
  132. package/dist/docs/types/FolderPasteOptions.html +2 -2
  133. package/dist/docs/types/GraphDataSpec.html +1 -1
  134. package/dist/docs/types/GraphSpec.html +2 -2
  135. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  136. package/dist/docs/types/Icon.html +2 -2
  137. package/dist/docs/types/IconProps.html +2 -2
  138. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  139. package/dist/docs/types/ImageInfo.html +2 -2
  140. package/dist/docs/types/ImportZipOptions.html +2 -2
  141. package/dist/docs/types/InlineCode.html +2 -2
  142. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  143. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  144. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  145. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  146. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  147. package/dist/docs/types/JavascriptType.html +2 -2
  148. package/dist/docs/types/JobManifest.html +2 -2
  149. package/dist/docs/types/KnownCounts.html +2 -2
  150. package/dist/docs/types/ManifestSecrets.html +1 -1
  151. package/dist/docs/types/ModalTemplateProps.html +2 -2
  152. package/dist/docs/types/NamedEntityGroup.html +2 -2
  153. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  154. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  155. package/dist/docs/types/NunjucksType.html +2 -2
  156. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  157. package/dist/docs/types/OntologyTags.html +2 -2
  158. package/dist/docs/types/OsAuditFields.html +2 -2
  159. package/dist/docs/types/OsConfirmProps.html +2 -2
  160. package/dist/docs/types/OsNotification.html +2 -2
  161. package/dist/docs/types/OsProgress.html +2 -2
  162. package/dist/docs/types/OsTag.html +2 -2
  163. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  164. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  165. package/dist/docs/types/PasteContextOptions.html +2 -2
  166. package/dist/docs/types/Permission.html +2 -2
  167. package/dist/docs/types/Point.html +2 -2
  168. package/dist/docs/types/PromptOptions.html +2 -0
  169. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  170. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  171. package/dist/docs/types/PythonFileStylerDefinition.html +2 -2
  172. package/dist/docs/types/PythonFileTransformDefinition.html +2 -2
  173. package/dist/docs/types/PythonFilterDefinition.html +2 -2
  174. package/dist/docs/types/PythonInlineStylerDefinition.html +2 -2
  175. package/dist/docs/types/PythonInlineTransformDefinition.html +2 -2
  176. package/dist/docs/types/PythonType.html +2 -2
  177. package/dist/docs/types/Query.html +2 -2
  178. package/dist/docs/types/QueryBatchResult.html +2 -2
  179. package/dist/docs/types/QueryErrorResult.html +2 -2
  180. package/dist/docs/types/QueryExecutor.html +2 -2
  181. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  182. package/dist/docs/types/QueryResponse.html +2 -2
  183. package/dist/docs/types/QueryResult.html +2 -2
  184. package/dist/docs/types/QuerySuccessResult.html +2 -2
  185. package/dist/docs/types/ReactCssProperties.html +2 -2
  186. package/dist/docs/types/ReactNode.html +2 -2
  187. package/dist/docs/types/ReactRef.html +2 -2
  188. package/dist/docs/types/ReasonedBoolean.html +2 -2
  189. package/dist/docs/types/RecordFetchOptions.html +1 -1
  190. package/dist/docs/types/RefCallback.html +2 -2
  191. package/dist/docs/types/RelationshipCountResult.html +2 -2
  192. package/dist/docs/types/RemoteAppApi.html +1 -1
  193. package/dist/docs/types/SaveAsModalProps.html +2 -2
  194. package/dist/docs/types/SaveFileOptions.html +2 -2
  195. package/dist/docs/types/SaveOptions.html +2 -2
  196. package/dist/docs/types/SavedTemplate.html +2 -2
  197. package/dist/docs/types/SearchFilter.html +2 -2
  198. package/dist/docs/types/SemanticBinding.html +2 -2
  199. package/dist/docs/types/SemanticBindingType.html +2 -2
  200. package/dist/docs/types/SemanticBindings.html +2 -2
  201. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  202. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  203. package/dist/docs/types/SendQueryOptions.html +2 -2
  204. package/dist/docs/types/ServiceDefinition.html +2 -2
  205. package/dist/docs/types/ServiceDefinitions.html +2 -2
  206. package/dist/docs/types/ServiceRole.html +2 -2
  207. package/dist/docs/types/SetTransformResultFn.html +1 -1
  208. package/dist/docs/types/ShowOntology.html +2 -2
  209. package/dist/docs/types/ShowTabProps.html +2 -2
  210. package/dist/docs/types/Styler.html +2 -2
  211. package/dist/docs/types/StylerConfig.html +2 -2
  212. package/dist/docs/types/StylerDefinition.html +2 -2
  213. package/dist/docs/types/StylerDefinitions.html +2 -2
  214. package/dist/docs/types/StylerOption.html +2 -2
  215. package/dist/docs/types/StylerProducer.html +2 -2
  216. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  217. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  218. package/dist/docs/types/Tag.html +2 -2
  219. package/dist/docs/types/TagInfo.html +2 -2
  220. package/dist/docs/types/TagWithRelationship.html +2 -2
  221. package/dist/docs/types/TaskCleanupReason.html +2 -2
  222. package/dist/docs/types/TemplateMetadata.html +2 -2
  223. package/dist/docs/types/TemplateType.html +2 -2
  224. package/dist/docs/types/TemplateVariant.html +2 -2
  225. package/dist/docs/types/TransformAction.html +2 -2
  226. package/dist/docs/types/TransformActionContext.html +2 -2
  227. package/dist/docs/types/TransformDefinition.html +2 -2
  228. package/dist/docs/types/TransformDefinitions.html +2 -2
  229. package/dist/docs/types/Unsubscribe.html +2 -2
  230. package/dist/docs/types/UnsubscribeFn.html +1 -1
  231. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  232. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  233. package/dist/docs/types/UserProfile.html +2 -2
  234. package/dist/docs/types/Watcher.html +2 -2
  235. package/dist/docs/types/Whoami.html +2 -2
  236. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  237. package/dist/docs/types/Workspace.html +2 -2
  238. package/dist/docs/types/WorkspaceConfig.html +1 -0
  239. package/dist/docs/types/WorkspaceFlags.html +2 -2
  240. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  241. package/dist/docs/types/WorkspaceItem.html +2 -2
  242. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  243. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  244. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  245. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  246. package/dist/docs/types/WorkspaceItems.html +2 -2
  247. package/dist/docs/types/WorkspacePermission.html +2 -2
  248. package/dist/docs/types/WorkspaceRecord.html +2 -2
  249. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  250. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  251. package/dist/docs/types/WorkspaceRecords.html +2 -2
  252. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  253. package/dist/docs/types/WorkspaceSettings.html +2 -2
  254. package/dist/docs/types/trigger.html +2 -2
  255. package/dist/docs/types/uuid.html +2 -2
  256. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  257. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  258. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  259. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  260. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  261. package/dist/platform-types.d.ts +221 -7
  262. package/lib/ai.d.ts +54 -0
  263. package/lib/ai.d.ts.map +1 -0
  264. package/lib/ai.js +2 -0
  265. package/lib/ai.js.map +1 -0
  266. package/lib/client.d.ts +71 -0
  267. package/lib/client.d.ts.map +1 -0
  268. package/lib/client.js +2 -0
  269. package/lib/client.js.map +1 -0
  270. package/lib/desktop.d.ts +48 -4
  271. package/lib/desktop.d.ts.map +1 -1
  272. package/lib/desktop.js.map +1 -1
  273. package/lib/index.d.ts +2 -0
  274. package/lib/index.d.ts.map +1 -1
  275. package/lib/index.js +2 -0
  276. package/lib/index.js.map +1 -1
  277. package/lib/model.d.ts +8 -2
  278. package/lib/model.d.ts.map +1 -1
  279. package/lib/model.js.map +1 -1
  280. package/lib/ontology.d.ts +8 -0
  281. package/lib/ontology.d.ts.map +1 -1
  282. package/lib/savedSearch.d.ts +4 -0
  283. package/lib/savedSearch.d.ts.map +1 -1
  284. package/lib/savedSearch.js.map +1 -1
  285. package/lib/search.d.ts +18 -0
  286. package/lib/search.d.ts.map +1 -1
  287. package/package.json +2 -2
package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html CHANGED
@@ -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.1</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.1</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/fd82c95455401590df9a01997e044dcc86ac8825/superset-frontend/packages/octostar-platform-types/src/desktop.ts#L420">desktop.ts:420</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.1</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
+ <!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.3</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.3</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/7e00b5ca2648457cddbb462808f7e3c9bd78c3ce/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.3</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/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html CHANGED
@@ -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</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.1</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">&lt;</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">&quot;octostar:savedSearch:getRecords&quot;</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">&quot;octostar:savedSearch:getRecordsCount&quot;</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">&quot;octostar:savedSearch:getRecordsCountQuery&quot;</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">&quot;octostar:savedSearch:getRecordsQuery&quot;</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">&quot;octostar:savedSearch:getSavedSearchPasteContext&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</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/fd82c95455401590df9a01997e044dcc86ac8825/superset-frontend/packages/octostar-platform-types/src/savedSearch.ts#L130">savedSearch.ts:130</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.1</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
+ <!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.3</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.3</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">&lt;</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">&quot;octostar:savedSearch:getRecords&quot;</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">&quot;octostar:savedSearch:getRecordsCount&quot;</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">&quot;octostar:savedSearch:getRecordsCountQuery&quot;</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">&quot;octostar:savedSearch:getRecordsQuery&quot;</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">&quot;octostar:savedSearch:getSavedSearchPasteContext&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</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/7e00b5ca2648457cddbb462808f7e3c9bd78c3ce/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.3</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/docs/variables/SAVED_SEARCH_PREFIX.html CHANGED
@@ -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</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.1</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">&quot;octostar:savedSearch:&quot;</span><span class="tsd-signature-symbol"> = &#39;octostar:savedSearch:&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/fd82c95455401590df9a01997e044dcc86ac8825/superset-frontend/packages/octostar-platform-types/src/savedSearch.ts#L129">savedSearch.ts:129</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.1</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
+ <!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.3</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.3</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">&quot;octostar:savedSearch:&quot;</span><span class="tsd-signature-symbol"> = &#39;octostar:savedSearch:&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-superset/blob/7e00b5ca2648457cddbb462808f7e3c9bd78c3ce/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.3</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
@@ -682,11 +731,19 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
682
731
  /**
683
732
  * Gets a workspace by identifier.
684
733
  */
685
- getWorkspace: (ws: WorkspaceIdentifier) => Promise<Workspace | undefined>;
734
+ getWorkspace: (ws: WorkspaceIdentifier, shouldRetry?: boolean) => Promise<Workspace | undefined>;
686
735
  /**
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,11 @@ 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>;
795
+ /**
796
+ * Creates a private workspace for user by name.
797
+ */
798
+ createPrivateWorkspace: (name: string, config?: WorkspaceConfig) => Promise<Workspace>;
738
799
  /**
739
800
  * Connects two entities with a relationship in a workspace.
740
801
  */
@@ -759,6 +820,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
759
820
  * Exports an item or items with optional export options.
760
821
  */
761
822
  export: (item: WorkspaceItem | WorkspaceItem[], options?: ExportOptions) => Promise<void>;
823
+ /**
824
+ * Fetches an entity from the index, or from the ontology if not found in the index.
825
+ */
826
+ fetchEntity: (entity: EntityBase, options?: FetchEntityOptions) => Promise<Entity>;
762
827
  /**
763
828
  * Extracts entities from some text which may be json or a list of urls.
764
829
  */
@@ -787,6 +852,13 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
787
852
  * Deletes local concept records in a workspace by base concept.
788
853
  */
789
854
  delete_local_concept_records: (workspace_id: string, base_concept: string) => Promise<void>;
855
+ /**
856
+ * Searches the index using the query string
857
+ * @param query OpenSearch qeuery string.
858
+ * @param options query options
859
+ * @returns a promise resolving to the found entities.
860
+ */
861
+ search: (query: string, options?: SearchOptions) => Promise<Entity[]>;
790
862
  /**
791
863
  * Searches experience with optional search options.
792
864
  */
@@ -1080,6 +1152,14 @@ export declare type DesktopActionOptions = {
1080
1152
  * Whether to raise the tab to the front.
1081
1153
  */
1082
1154
  raiseOnly?: boolean;
1155
+ /**
1156
+ * Open tab in a new tabset
1157
+ */
1158
+ newTabset?: boolean;
1159
+ /**
1160
+ * Wait for the tab to open
1161
+ */
1162
+ awaitShowTab?: boolean;
1083
1163
  };
1084
1164
 
1085
1165
  /**
@@ -1234,7 +1314,18 @@ export declare type EmitEventTransformDefinition = {
1234
1314
  * Represents an entity with basic attributes.
1235
1315
  * @beta
1236
1316
  */
1237
- export declare type Entity = {
1317
+ export declare type Entity = EntityBase & {
1318
+ /**
1319
+ * The label of the entity.
1320
+ */
1321
+ entity_label: string;
1322
+ };
1323
+
1324
+ /**
1325
+ * Represents an entity without a label.
1326
+ * @beta
1327
+ */
1328
+ export declare type EntityBase = {
1238
1329
  /**
1239
1330
  * The ID of the entity.
1240
1331
  */
@@ -1243,10 +1334,6 @@ export declare type Entity = {
1243
1334
  * The type of the entity.
1244
1335
  */
1245
1336
  entity_type: string;
1246
- /**
1247
- * The label of the entity.
1248
- */
1249
- entity_label: string;
1250
1337
  };
1251
1338
 
1252
1339
  /**
@@ -1416,6 +1503,23 @@ export declare type ExtrasApi = {
1416
1503
  createLinkChart: CreateLinkChartFn;
1417
1504
  };
1418
1505
 
1506
+ /**
1507
+ * Options for fetching an entity.
1508
+ * @beta
1509
+ */
1510
+ export declare type FetchEntityOptions = {};
1511
+
1512
+ /**
1513
+ * @beta
1514
+ * Options for fetching data from an API.
1515
+ */
1516
+ export declare interface FetchOptions extends RequestInit {
1517
+ /**
1518
+ * The API endpoint to hit, starting with a slash.
1519
+ */
1520
+ endpoint: string;
1521
+ }
1522
+
1419
1523
  /**
1420
1524
  * @beta
1421
1525
  * File containing the code. Not yet supported.
@@ -1992,6 +2096,13 @@ export declare interface Ontology {
1992
2096
  * @returns A promise that resolves to an array of connected entities.
1993
2097
  */
1994
2098
  getConnectedEntities: <T extends Entity>(entity: Entity, relationship: Relationship | string, forceRefresh?: boolean) => Promise<T[]>;
2099
+ /**
2100
+ * Gets connections by type for a given entity and concept.
2101
+ * @param entity - The entity for which to get connections.
2102
+ * @param concept - The concept for which to get connections.
2103
+ * @returns A promise that resolves to an array of connections.
2104
+ */
2105
+ getConnectionsByType: <T extends Entity>(entity: Entity, concept: string) => Promise<EConnection[]>;
1995
2106
  /**
1996
2107
  * Gets the concept names.
1997
2108
  * @returns A promise that resolves to an array concept names.
@@ -2123,6 +2234,37 @@ export declare type OS_CONFIRM_MODAL_RESPONSE = typeof OS_CONFIRM_MODAL_YES | ty
2123
2234
  */
2124
2235
  export declare const OS_CONFIRM_MODAL_YES = true;
2125
2236
 
2237
+ /**
2238
+ * @beta
2239
+ * Interface representing a client for interacting with the OctoStar API.
2240
+ */
2241
+ export declare interface OsAPIClient {
2242
+ /**
2243
+ * Fetch data from the API.
2244
+ * @param options - Configuration options for the fetch request.
2245
+ * @returns A promise that resolves with the fetched data of type T.
2246
+ */
2247
+ fetchData<T>(options: FetchOptions): Promise<T>;
2248
+ /**
2249
+ * Stream data from the API.
2250
+ * @param options - Configuration options for the stream request.
2251
+ * @returns A promise that resolves when the streaming is complete.
2252
+ */
2253
+ streamData(options: StreamOptions): Promise<void>;
2254
+ /**
2255
+ * Streams text data from the API.
2256
+ * @param options - Configuration options for the stream request.
2257
+ * @returns A promise that resolves when the streaming is complete.
2258
+ */
2259
+ streamText(options: StreamTextOptions): Promise<void>;
2260
+ /**
2261
+ * Streams JSON line data from the API.
2262
+ * @param options - Configuration options for the stream request.
2263
+ * @returns A promise that resolves when the streaming is complete.
2264
+ */
2265
+ streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
2266
+ }
2267
+
2126
2268
  /**
2127
2269
  * Represents audit fields for OS (Operational Support) records.
2128
2270
  * @beta
@@ -2397,6 +2539,14 @@ export declare enum ProcessingStatusCode {
2397
2539
  UNKNOWN = "UNKNOWN"
2398
2540
  }
2399
2541
 
2542
+ /**
2543
+ * The options for the prompt.
2544
+ */
2545
+ export declare type PromptOptions = {
2546
+ model?: string;
2547
+ apiKey?: string;
2548
+ };
2549
+
2400
2550
  /**
2401
2551
  * Represents a property of a concept.
2402
2552
  * @beta
@@ -2792,6 +2942,11 @@ export declare interface SavedSearchContent {
2792
2942
  initialCount?: number;
2793
2943
  }
2794
2944
 
2945
+ export declare interface SavedSetContent {
2946
+ lastFiredQuery: string;
2947
+ uiState: Record<string, any>;
2948
+ }
2949
+
2795
2950
  /**
2796
2951
  * @beta
2797
2952
  * Type representing a saved template, extending CustomTemplate.
@@ -2844,6 +2999,17 @@ export declare type SearchFilter = {
2844
2999
  imageUrl?: string;
2845
3000
  };
2846
3001
 
3002
+ /**
3003
+ * @beta
3004
+ * Interface representing the options given to search
3005
+ */
3006
+ export declare interface SearchOptions {
3007
+ /**
3008
+ * The maximum number of entities returned.
3009
+ */
3010
+ limit?: number;
3011
+ }
3012
+
2847
3013
  /**
2848
3014
  * @beta
2849
3015
  * Interface representing the properties for the Search component.
@@ -2865,6 +3031,14 @@ export declare interface SearchProps {
2865
3031
  * the default image to use for the search.
2866
3032
  */
2867
3033
  image?: WorkspaceItem;
3034
+ /**
3035
+ * disable ask AI
3036
+ */
3037
+ disableAskAI?: boolean;
3038
+ /**
3039
+ * disable save search
3040
+ */
3041
+ disableSaveSearch?: boolean;
2868
3042
  }
2869
3043
 
2870
3044
  /**
@@ -3079,6 +3253,39 @@ export declare enum SortOrder {
3079
3253
  HIDE = -1
3080
3254
  }
3081
3255
 
3256
+ /**
3257
+ * @beta
3258
+ * Options for streaming JSON line data from an API.
3259
+ */
3260
+ export declare interface StreamJsonOptions<T> extends FetchOptions {
3261
+ /**
3262
+ * The asynchronous function to process each JSON object.
3263
+ */
3264
+ jsonHandler: (value: T) => Promise<void>;
3265
+ }
3266
+
3267
+ /**
3268
+ * @beta
3269
+ * Options for streaming data from an API.
3270
+ */
3271
+ export declare interface StreamOptions extends FetchOptions {
3272
+ /**
3273
+ * The asynchronous function to process each chunk of data.
3274
+ */
3275
+ handler: (chunk: Uint8Array) => Promise<void>;
3276
+ }
3277
+
3278
+ /**
3279
+ * @beta
3280
+ * Options for streaming text data from an API.
3281
+ */
3282
+ export declare interface StreamTextOptions extends FetchOptions {
3283
+ /**
3284
+ * The asynchronous function to process each line of text.
3285
+ */
3286
+ handler: (line: string) => Promise<void>;
3287
+ }
3288
+
3082
3289
  /**
3083
3290
  * @beta
3084
3291
  * Type representing a styler with methods for getting G6 node and edge styles.
@@ -3549,6 +3756,13 @@ export declare interface WorkspaceChangeEmitter {
3549
3756
  onOpenWorkspacesChanged: AddListener<Workspace[]>;
3550
3757
  }
3551
3758
 
3759
+ export declare type WorkspaceConfig = Partial<{
3760
+ description: string;
3761
+ os_icon: string;
3762
+ color: string;
3763
+ id?: string;
3764
+ }>;
3765
+
3552
3766
  /**
3553
3767
  *
3554
3768
  * @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
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ai.js.map
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
package/lib/client.d.ts.map ADDED
@@ -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,2 @@
1
+ export {};
2
+ //# sourceMappingURL=client.js.map
package/lib/client.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":""}