@octostar/platform-types 0.5.37 → 1.0.0

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 (466) hide show
  1. package/dist/action.d.ts +6 -6
  2. package/dist/action.d.ts.map +1 -1
  3. package/dist/ai.d.ts +7 -6
  4. package/dist/ai.d.ts.map +1 -1
  5. package/dist/desktop.d.ts +380 -204
  6. package/dist/desktop.d.ts.map +1 -1
  7. package/dist/desktop.js.map +1 -1
  8. package/dist/docs/assets/highlight.css +14 -14
  9. package/dist/docs/assets/navigation.js +1 -1
  10. package/dist/docs/assets/search.js +1 -1
  11. package/dist/docs/enums/ProcessingStatusCode.html +5 -27
  12. package/dist/docs/enums/SortOrder.html +3 -3
  13. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  14. package/dist/docs/functions/imageLabelCandidateAggs.html +5 -0
  15. package/dist/docs/functions/imageLabelCandidateSize.html +3 -0
  16. package/dist/docs/functions/imageLabelCountAggs.html +2 -0
  17. package/dist/docs/functions/imageLabelFamilyOfField.html +2 -0
  18. package/dist/docs/functions/imageLabelMatchClause.html +3 -0
  19. package/dist/docs/functions/imageLabelSourceIncludes.html +2 -0
  20. package/dist/docs/functions/isDefaultTemplate.html +3 -0
  21. package/dist/docs/functions/isDeletedEntity.html +2 -0
  22. package/dist/docs/functions/isWorkspaceFileItem.html +1 -1
  23. package/dist/docs/functions/isWorkspaceRoot.html +2 -0
  24. package/dist/docs/functions/ontologyLabel-1.html +4 -0
  25. package/dist/docs/functions/readImageLabelCandidates.html +2 -0
  26. package/dist/docs/functions/readImageLabelCounts.html +2 -0
  27. package/dist/docs/hierarchy.html +1 -1
  28. package/dist/docs/index.html +2 -3
  29. package/dist/docs/interfaces/AIClient.html +4 -4
  30. package/dist/docs/interfaces/ActionContext.html +4 -5
  31. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  32. package/dist/docs/interfaces/BrowseEntry.html +7 -0
  33. package/dist/docs/interfaces/BrowseRequest.html +4 -0
  34. package/dist/docs/interfaces/BrowseResponse.html +5 -0
  35. package/dist/docs/interfaces/ChatMessage.html +6 -6
  36. package/dist/docs/interfaces/Colorful.html +3 -3
  37. package/dist/docs/interfaces/Concept.html +14 -14
  38. package/dist/docs/interfaces/DeleteResponse.html +2 -2
  39. package/dist/docs/interfaces/Desktop.html +199 -122
  40. package/dist/docs/interfaces/DesktopActionContext.html +7 -8
  41. package/dist/docs/interfaces/DesktopSettings.html +6 -6
  42. package/dist/docs/interfaces/DeveloperSettings.html +3 -5
  43. package/dist/docs/interfaces/DownloadOptions.html +2 -2
  44. package/dist/docs/interfaces/EntityUiState.html +2 -2
  45. package/dist/docs/interfaces/FetchOptions.html +4 -4
  46. package/dist/docs/interfaces/FileListResponse.html +2 -2
  47. package/dist/docs/interfaces/FilesAPIClient.html +48 -24
  48. package/dist/docs/interfaces/FragmentRegion.html +6 -0
  49. package/dist/docs/interfaces/FragmentStatusEntry.html +13 -0
  50. package/dist/docs/interfaces/GeocodingResult.html +9 -0
  51. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  52. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  53. package/dist/docs/interfaces/ImageLabelCandidateOptions.html +4 -0
  54. package/dist/docs/interfaces/ImageLabelFamilyFields.html +13 -0
  55. package/dist/docs/interfaces/ImportDestination.html +3 -0
  56. package/dist/docs/interfaces/ImportItem.html +3 -0
  57. package/dist/docs/interfaces/ImportOptions.html +8 -0
  58. package/dist/docs/interfaces/ImportRequest.html +7 -0
  59. package/dist/docs/interfaces/IndexSearchHitSource.html +5 -3
  60. package/dist/docs/interfaces/Inheritance.html +5 -5
  61. package/dist/docs/interfaces/LiveContext.html +11 -11
  62. package/dist/docs/interfaces/MountAccess.html +3 -0
  63. package/dist/docs/interfaces/MountCreate.html +10 -0
  64. package/dist/docs/interfaces/MountGrantCreate.html +3 -0
  65. package/dist/docs/interfaces/MountGrantResponse.html +7 -0
  66. package/dist/docs/interfaces/MountImportCopyResponse.html +4 -0
  67. package/dist/docs/interfaces/MountImportLinkError.html +4 -0
  68. package/dist/docs/interfaces/MountImportLinkResponse.html +5 -0
  69. package/dist/docs/interfaces/MountResponse.html +20 -0
  70. package/dist/docs/interfaces/MountUpdate.html +13 -0
  71. package/dist/docs/interfaces/MoveOptions.html +2 -2
  72. package/dist/docs/interfaces/MoveResponse.html +58 -37
  73. package/dist/docs/interfaces/Ontology.html +110 -53
  74. package/dist/docs/interfaces/OntologyLabel.html +6 -0
  75. package/dist/docs/interfaces/OsAPIClient.html +8 -8
  76. package/dist/docs/interfaces/PeekSourceOptions.html +4 -0
  77. package/dist/docs/interfaces/PerUserCredentialInput.html +5 -0
  78. package/dist/docs/interfaces/PerUserCredentialStatus.html +7 -0
  79. package/dist/docs/interfaces/ProcessingRecursiveStatus.html +27 -0
  80. package/dist/docs/interfaces/ProcessingStatus.html +40 -9
  81. package/dist/docs/interfaces/Property.html +7 -5
  82. package/dist/docs/interfaces/RecordProvider.html +6 -6
  83. package/dist/docs/interfaces/RecordsSourceScope.html +8 -0
  84. package/dist/docs/interfaces/RefObject.html +3 -3
  85. package/dist/docs/interfaces/Relationship.html +22 -20
  86. package/dist/docs/interfaces/ReportApi.html +13 -0
  87. package/dist/docs/interfaces/S3Headers.html +2 -2
  88. package/dist/docs/interfaces/S3UploadResponse.html +2 -2
  89. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  90. package/dist/docs/interfaces/SearchFilter.html +29 -0
  91. package/dist/docs/interfaces/SearchHit.html +11 -0
  92. package/dist/docs/interfaces/SearchInnerHit.html +3 -0
  93. package/dist/docs/interfaces/SearchOptions.html +21 -4
  94. package/dist/docs/interfaces/SearchProps.html +11 -10
  95. package/dist/docs/interfaces/SearchQueryResult.html +5 -0
  96. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  97. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  98. package/dist/docs/interfaces/SemanticBindingOptions.html +8 -0
  99. package/dist/docs/interfaces/SemanticBindingProps.html +8 -6
  100. package/dist/docs/interfaces/SharedCredentialsInput.html +5 -0
  101. package/dist/docs/interfaces/SourceExportError.html +4 -0
  102. package/dist/docs/interfaces/SourceExportRequest.html +8 -0
  103. package/dist/docs/interfaces/SourceExportResponse.html +7 -0
  104. package/dist/docs/interfaces/SourcePeekEntry.html +12 -0
  105. package/dist/docs/interfaces/SourcePeekResponse.html +10 -0
  106. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  107. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  108. package/dist/docs/interfaces/SubscribeOptions.html +4 -0
  109. package/dist/docs/interfaces/TagAttributes.html +7 -7
  110. package/dist/docs/interfaces/TestConnectionRequest.html +12 -0
  111. package/dist/docs/interfaces/TestConnectionResponse.html +4 -0
  112. package/dist/docs/interfaces/UiStateManager.html +2 -2
  113. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  114. package/dist/docs/interfaces/UnzipOptions.html +2 -2
  115. package/dist/docs/interfaces/UploadFromUrlError.html +8 -0
  116. package/dist/docs/interfaces/UploadFromUrlRequest.html +6 -0
  117. package/dist/docs/interfaces/UploadFromUrlResponse.html +6 -0
  118. package/dist/docs/interfaces/UploadOptions.html +2 -2
  119. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +7 -7
  120. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  121. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  122. package/dist/docs/modules.html +106 -38
  123. package/dist/docs/types/ActionHandler.html +2 -2
  124. package/dist/docs/types/AddCommentParams.html +2 -2
  125. package/dist/docs/types/AddListener.html +2 -2
  126. package/dist/docs/types/AddToReportBlocksInput.html +6 -0
  127. package/dist/docs/types/AddToReportContentSelection.html +2 -0
  128. package/dist/docs/types/AddToReportEntityInput.html +5 -0
  129. package/dist/docs/types/AddToReportInput.html +2 -0
  130. package/dist/docs/types/AddToReportResult.html +2 -0
  131. package/dist/docs/types/ApiErrorResult.html +2 -2
  132. package/dist/docs/types/ApiResult.html +2 -2
  133. package/dist/docs/types/ApiSuccessResult.html +2 -2
  134. package/dist/docs/types/App.html +2 -2
  135. package/dist/docs/types/AppRegistry.html +3 -4
  136. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  137. package/dist/docs/types/AppServiceCallProps.html +2 -2
  138. package/dist/docs/types/AsyncFilter.html +2 -2
  139. package/dist/docs/types/AttachmentResponseType.html +2 -2
  140. package/dist/docs/types/AttachmentType.html +2 -2
  141. package/dist/docs/types/BinaryOperator.html +2 -2
  142. package/dist/docs/types/BrowseKind.html +1 -0
  143. package/dist/docs/types/Callback.html +2 -2
  144. package/dist/docs/types/ChatApiResponse.html +1 -1
  145. package/dist/docs/types/ChatModel.html +2 -2
  146. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  147. package/dist/docs/types/CommonOptions.html +1 -1
  148. package/dist/docs/types/Comparator.html +2 -2
  149. package/dist/docs/types/ConceptFilter.html +3 -3
  150. package/dist/docs/types/ConceptMap.html +2 -2
  151. package/dist/docs/types/ConceptName.html +1 -1
  152. package/dist/docs/types/ConceptWithParents.html +2 -2
  153. package/dist/docs/types/ConnectedEntity.html +2 -2
  154. package/dist/docs/types/ContextMenuGroup.html +2 -2
  155. package/dist/docs/types/ContextMenuLabels.html +2 -2
  156. package/dist/docs/types/ContextMenuOptions.html +2 -2
  157. package/dist/docs/types/ContextMenuParams.html +2 -2
  158. package/dist/docs/types/ContextMenuRequest.html +2 -2
  159. package/dist/docs/types/CopyOptions.html +2 -2
  160. package/dist/docs/types/CreateEntityFormProps.html +4 -2
  161. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  162. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  163. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  164. package/dist/docs/types/CredType.html +1 -0
  165. package/dist/docs/types/CredentialMode.html +1 -0
  166. package/dist/docs/types/CustomEventListener.html +2 -2
  167. package/dist/docs/types/CustomTemplate.html +9 -3
  168. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  169. package/dist/docs/types/DataContextType.html +2 -2
  170. package/dist/docs/types/DefaultLiveContextData.html +1 -1
  171. package/dist/docs/types/DefaultTemplate.html +11 -0
  172. package/dist/docs/types/DefaultTemplateProps.html +5 -0
  173. package/dist/docs/types/DeletedEntity.html +3 -0
  174. package/dist/docs/types/DesktopAction.html +2 -2
  175. package/dist/docs/types/DesktopActionFilter.html +2 -2
  176. package/dist/docs/types/DesktopActionMenuItem.html +6 -2
  177. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  178. package/dist/docs/types/DesktopActionOptions.html +17 -3
  179. package/dist/docs/types/DesktopOpenParams.html +2 -2
  180. package/dist/docs/types/DragEndParams.html +2 -2
  181. package/dist/docs/types/DragStartParams.html +2 -2
  182. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  183. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  184. package/dist/docs/types/EConnection.html +2 -2
  185. package/dist/docs/types/EdgeSpec.html +2 -2
  186. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  187. package/dist/docs/types/Entity.html +2 -2
  188. package/dist/docs/types/EntityBase.html +2 -2
  189. package/dist/docs/types/EntityEdge.html +2 -2
  190. package/dist/docs/types/EntityOTM.html +2 -2
  191. package/dist/docs/types/EntityPasteContext.html +2 -2
  192. package/dist/docs/types/EntityRelationshipCount.html +4 -0
  193. package/dist/docs/types/EvalContext.html +1 -1
  194. package/dist/docs/types/EventContextType.html +2 -2
  195. package/dist/docs/types/EventEmitterType.html +2 -2
  196. package/dist/docs/types/EventName.html +2 -2
  197. package/dist/docs/types/EventProducer.html +2 -2
  198. package/dist/docs/types/EventPublisher.html +2 -2
  199. package/dist/docs/types/EventSubscriber.html +2 -2
  200. package/dist/docs/types/EventUnsubscriber.html +2 -2
  201. package/dist/docs/types/ExportOptions.html +2 -2
  202. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  203. package/dist/docs/types/ExtrasApi.html +1 -1
  204. package/dist/docs/types/FetchEntityOptions.html +2 -2
  205. package/dist/docs/types/FileCode.html +2 -2
  206. package/dist/docs/types/FileTreeOptions.html +2 -2
  207. package/dist/docs/types/FilterDefinition.html +2 -2
  208. package/dist/docs/types/FilterDefinitions.html +2 -2
  209. package/dist/docs/types/FilterName.html +2 -2
  210. package/dist/docs/types/FilterQuery.html +2 -2
  211. package/dist/docs/types/FilterReference.html +2 -2
  212. package/dist/docs/types/FilterValue.html +2 -2
  213. package/dist/docs/types/FocusListItem.html +2 -2
  214. package/dist/docs/types/FragmentInfo.html +5 -0
  215. package/dist/docs/types/FragmentLocator.html +5 -0
  216. package/dist/docs/types/FragmentResolution.html +2 -0
  217. package/dist/docs/types/GetSystemSettingResponse.html +4 -1
  218. package/dist/docs/types/GraphDataSpec.html +1 -1
  219. package/dist/docs/types/GraphSpec.html +2 -2
  220. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  221. package/dist/docs/types/Icon.html +2 -2
  222. package/dist/docs/types/IconProps.html +2 -2
  223. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  224. package/dist/docs/types/ImageInfo.html +2 -2
  225. package/dist/docs/types/ImageLabelFamily.html +21 -0
  226. package/dist/docs/types/ImportConflictPolicy.html +1 -0
  227. package/dist/docs/types/ImportEntryKind.html +1 -0
  228. package/dist/docs/types/ImportFoldersOptions.html +2 -2
  229. package/dist/docs/types/ImportMode.html +1 -0
  230. package/dist/docs/types/InlineCode.html +2 -2
  231. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  232. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  233. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  234. package/dist/docs/types/JavascriptType.html +3 -3
  235. package/dist/docs/types/JobManifest.html +4 -4
  236. package/dist/docs/types/KnownCounts.html +2 -2
  237. package/dist/docs/types/ListByParentFolder.html +1 -1
  238. package/dist/docs/types/ListByPath.html +1 -1
  239. package/dist/docs/types/ListFolderOptions.html +1 -1
  240. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  241. package/dist/docs/types/LiveContextListener.html +1 -1
  242. package/dist/docs/types/ManifestSecrets.html +1 -1
  243. package/dist/docs/types/MapSettingKey.html +1 -0
  244. package/dist/docs/types/MkdirResponse.html +1 -1
  245. package/dist/docs/types/ModalTemplateProps.html +2 -2
  246. package/dist/docs/types/MountScheme.html +7 -0
  247. package/dist/docs/types/NamedEntityGroup.html +2 -2
  248. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  249. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  250. package/dist/docs/types/NunjucksType.html +3 -3
  251. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  252. package/dist/docs/types/OntologyTags.html +2 -2
  253. package/dist/docs/types/OpenNewAIChatOptions.html +17 -0
  254. package/dist/docs/types/OpenReportSummary.html +6 -0
  255. package/dist/docs/types/OsAuditFields.html +2 -2
  256. package/dist/docs/types/OsConfirmProps.html +2 -2
  257. package/dist/docs/types/OsNotification.html +2 -2
  258. package/dist/docs/types/OsProgress.html +11 -3
  259. package/dist/docs/types/OsTag.html +2 -2
  260. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  261. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  262. package/dist/docs/types/PeekSourceTarget.html +4 -0
  263. package/dist/docs/types/Permission.html +2 -2
  264. package/dist/docs/types/Point.html +2 -2
  265. package/dist/docs/types/PrincipalType.html +1 -0
  266. package/dist/docs/types/PromptOptions.html +6 -3
  267. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  268. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  269. package/dist/docs/types/Query.html +2 -2
  270. package/dist/docs/types/QueryBatchResult.html +2 -2
  271. package/dist/docs/types/QueryDslQueryContainer.html +6 -0
  272. package/dist/docs/types/QueryErrorResult.html +2 -2
  273. package/dist/docs/types/QueryExecutor.html +2 -2
  274. package/dist/docs/types/QueryFilesystemItemsParams.html +16 -0
  275. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  276. package/dist/docs/types/QueryResponse.html +2 -2
  277. package/dist/docs/types/QueryResult.html +2 -2
  278. package/dist/docs/types/QuerySuccessResult.html +2 -2
  279. package/dist/docs/types/ReactCssProperties.html +2 -2
  280. package/dist/docs/types/ReactNode.html +2 -2
  281. package/dist/docs/types/ReactRef.html +2 -2
  282. package/dist/docs/types/ReasonedBoolean.html +2 -2
  283. package/dist/docs/types/RefCallback.html +2 -2
  284. package/dist/docs/types/RegisteredActionInfo.html +21 -0
  285. package/dist/docs/types/RelationshipCountEntry.html +8 -0
  286. package/dist/docs/types/RelationshipCountResult.html +2 -2
  287. package/dist/docs/types/RelationshipCountState.html +2 -0
  288. package/dist/docs/types/RemoteAppApi.html +1 -1
  289. package/dist/docs/types/RenameTabProps.html +2 -2
  290. package/dist/docs/types/RenderableTemplate.html +11 -0
  291. package/dist/docs/types/ReportTiptapNode.html +4 -0
  292. package/dist/docs/types/RuntimeAppUrlEntity.html +5 -0
  293. package/dist/docs/types/RuntimeAppUrlWorkspaceItem.html +10 -0
  294. package/dist/docs/types/SaveAsModalProps.html +2 -2
  295. package/dist/docs/types/SaveFileOptions.html +2 -2
  296. package/dist/docs/types/SaveOptions.html +2 -3
  297. package/dist/docs/types/SavedTemplate.html +3 -4
  298. package/dist/docs/types/SearchScope.html +9 -0
  299. package/dist/docs/types/SemanticBinding.html +2 -2
  300. package/dist/docs/types/SemanticBindingSpec.html +3 -0
  301. package/dist/docs/types/SemanticBindingType.html +2 -2
  302. package/dist/docs/types/SemanticBindings.html +3 -2
  303. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  304. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  305. package/dist/docs/types/SendQueryOptions.html +2 -2
  306. package/dist/docs/types/ServiceDefinition.html +2 -2
  307. package/dist/docs/types/ServiceDefinitions.html +2 -2
  308. package/dist/docs/types/ServiceRole.html +2 -2
  309. package/dist/docs/types/SetTransformResultFn.html +1 -1
  310. package/dist/docs/types/SetsOptions.html +7 -16
  311. package/dist/docs/types/SetsSortBy.html +1 -0
  312. package/dist/docs/types/ShowOntology.html +2 -2
  313. package/dist/docs/types/ShowTabProps.html +2 -2
  314. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  315. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  316. package/dist/docs/types/Tag.html +2 -2
  317. package/dist/docs/types/TagInfo.html +2 -2
  318. package/dist/docs/types/TagWithRelationship.html +2 -2
  319. package/dist/docs/types/TaskCleanupReason.html +2 -2
  320. package/dist/docs/types/TemplateMetadata.html +3 -3
  321. package/dist/docs/types/TemplateType.html +2 -2
  322. package/dist/docs/types/TemplateVariant.html +2 -2
  323. package/dist/docs/types/TestOutcome.html +2 -0
  324. package/dist/docs/types/TransformAction.html +2 -2
  325. package/dist/docs/types/TransformActionContext.html +2 -2
  326. package/dist/docs/types/TransformDefinition.html +2 -2
  327. package/dist/docs/types/TransformDefinitions.html +2 -2
  328. package/dist/docs/types/Unsubscribe.html +2 -2
  329. package/dist/docs/types/UnsubscribeFn.html +1 -1
  330. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  331. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  332. package/dist/docs/types/UploadFromUrlErrorCode.html +4 -0
  333. package/dist/docs/types/UserProfile.html +2 -2
  334. package/dist/docs/types/VirtualEntity.html +2 -2
  335. package/dist/docs/types/Whoami.html +3 -3
  336. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  337. package/dist/docs/types/WorkspaceConfig.html +5 -3
  338. package/dist/docs/types/WorkspaceFlags.html +2 -2
  339. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  340. package/dist/docs/types/WorkspaceItem.html +21 -2
  341. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  342. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  343. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  344. package/dist/docs/types/WorkspaceItemModel.html +4 -12
  345. package/dist/docs/types/WorkspaceItemTitleProps.html +3 -3
  346. package/dist/docs/types/WorkspacePermission.html +2 -2
  347. package/dist/docs/types/WorkspaceRecord.html +2 -2
  348. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  349. package/dist/docs/types/WorkspaceRelationship.html +3 -2
  350. package/dist/docs/types/WorkspaceSettings.html +2 -2
  351. package/dist/docs/types/trigger.html +2 -2
  352. package/dist/docs/types/uuid.html +2 -2
  353. package/dist/docs/variables/HEAVY_ANNOTATION_FIELDS.html +17 -0
  354. package/dist/docs/variables/IMAGE_LABEL_FAMILIES.html +1 -0
  355. package/dist/docs/variables/IMAGE_LABEL_FIELDS.html +1 -0
  356. package/dist/docs/variables/IMAGE_LABEL_SOURCE_INCLUDES.html +2 -0
  357. package/dist/docs/variables/MAP_SETTINGS_KEYS.html +9 -0
  358. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  359. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  360. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  361. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  362. package/dist/docs/variables/VECTOR_SENTINEL_LABELS.html +4 -0
  363. package/dist/extras.d.ts +0 -1
  364. package/dist/extras.d.ts.map +1 -1
  365. package/dist/files.d.ts +141 -1
  366. package/dist/files.d.ts.map +1 -1
  367. package/dist/files.js.map +1 -1
  368. package/dist/fragmentLocator.d.ts +31 -0
  369. package/dist/fragmentLocator.d.ts.map +1 -0
  370. package/dist/fragmentLocator.js +2 -0
  371. package/dist/fragmentLocator.js.map +1 -0
  372. package/dist/imageLabels.d.ts +84 -0
  373. package/dist/imageLabels.d.ts.map +1 -0
  374. package/dist/imageLabels.js +148 -0
  375. package/dist/imageLabels.js.map +1 -0
  376. package/dist/index.d.ts +6 -3
  377. package/dist/index.d.ts.map +1 -1
  378. package/dist/index.js +6 -3
  379. package/dist/index.js.map +1 -1
  380. package/dist/indexSearch.d.ts +18 -0
  381. package/dist/indexSearch.d.ts.map +1 -1
  382. package/dist/jobManifestTypes.d.ts +5 -25
  383. package/dist/jobManifestTypes.d.ts.map +1 -1
  384. package/dist/mapSettings.d.ts +17 -0
  385. package/dist/mapSettings.d.ts.map +1 -0
  386. package/dist/mapSettings.js +16 -0
  387. package/dist/mapSettings.js.map +1 -0
  388. package/dist/model.d.ts +215 -71
  389. package/dist/model.d.ts.map +1 -1
  390. package/dist/model.js +44 -25
  391. package/dist/model.js.map +1 -1
  392. package/dist/mounts.d.ts +184 -0
  393. package/dist/mounts.d.ts.map +1 -0
  394. package/dist/mounts.js +11 -0
  395. package/dist/mounts.js.map +1 -0
  396. package/dist/ontology.d.ts +148 -8
  397. package/dist/ontology.d.ts.map +1 -1
  398. package/dist/platform-types.d.ts +1692 -663
  399. package/dist/report.d.ts +112 -0
  400. package/dist/report.d.ts.map +1 -0
  401. package/dist/report.js +2 -0
  402. package/dist/report.js.map +1 -0
  403. package/dist/savedSet.d.ts +5 -0
  404. package/dist/savedSet.d.ts.map +1 -0
  405. package/dist/savedSet.js +2 -0
  406. package/dist/savedSet.js.map +1 -0
  407. package/dist/search.d.ts +140 -3
  408. package/dist/search.d.ts.map +1 -1
  409. package/dist/search.js +32 -1
  410. package/dist/search.js.map +1 -1
  411. package/dist/semantic.d.ts +24 -5
  412. package/dist/semantic.d.ts.map +1 -1
  413. package/dist/templates.d.ts +63 -5
  414. package/dist/templates.d.ts.map +1 -1
  415. package/dist/templates.js +8 -1
  416. package/dist/templates.js.map +1 -1
  417. package/dist/workspace.d.ts +25 -41
  418. package/dist/workspace.d.ts.map +1 -1
  419. package/dist/workspace.js.map +1 -1
  420. package/package.json +6 -20
  421. package/dist/behaviour.d.ts +0 -45
  422. package/dist/behaviour.d.ts.map +0 -1
  423. package/dist/behaviour.js +0 -14
  424. package/dist/behaviour.js.map +0 -1
  425. package/dist/docs/interfaces/ChartDataResponseResult.html +0 -20
  426. package/dist/docs/interfaces/NativeFilterColumn.html +0 -3
  427. package/dist/docs/interfaces/NativeFilterScope.html +0 -3
  428. package/dist/docs/interfaces/NativeFilterTarget.html +0 -3
  429. package/dist/docs/interfaces/RecordData.html +0 -20
  430. package/dist/docs/interfaces/SavedDatasource.html +0 -7
  431. package/dist/docs/interfaces/SavedSearchAPIInterface.html +0 -6
  432. package/dist/docs/interfaces/SavedSearchContent.html +0 -7
  433. package/dist/docs/interfaces/StylerContext.html +0 -21
  434. package/dist/docs/types/Behaviour.html +0 -17
  435. package/dist/docs/types/DataMask.html +0 -1
  436. package/dist/docs/types/DesktopStylerContext.html +0 -4
  437. package/dist/docs/types/DraftWorkspaceItem.html +0 -3
  438. package/dist/docs/types/Filter.html +0 -1
  439. package/dist/docs/types/FilterState.html +0 -1
  440. package/dist/docs/types/FolderPasteOptions.html +0 -5
  441. package/dist/docs/types/JavascriptFileStylerDefinition.html +0 -2
  442. package/dist/docs/types/JavascriptInlineStylerDefinition.html +0 -2
  443. package/dist/docs/types/PasteContextOptions.html +0 -8
  444. package/dist/docs/types/RecordFetchOptions.html +0 -1
  445. package/dist/docs/types/SearchFilter.html +0 -2
  446. package/dist/docs/types/Styler.html +0 -19
  447. package/dist/docs/types/StylerConfig.html +0 -6
  448. package/dist/docs/types/StylerDefinition.html +0 -2
  449. package/dist/docs/types/StylerDefinitions.html +0 -2
  450. package/dist/docs/types/StylerOption.html +0 -4
  451. package/dist/docs/types/StylerProducer.html +0 -4
  452. package/dist/docs/types/Watcher.html +0 -11
  453. package/dist/docs/types/Workspace.html +0 -8
  454. package/dist/docs/types/WorkspaceItems.html +0 -2
  455. package/dist/docs/types/WorkspaceRecordInfo.html +0 -6
  456. package/dist/docs/types/WorkspaceRecords.html +0 -2
  457. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +0 -1
  458. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +0 -1
  459. package/dist/savedSearch.d.ts +0 -128
  460. package/dist/savedSearch.d.ts.map +0 -1
  461. package/dist/savedSearch.js +0 -16
  462. package/dist/savedSearch.js.map +0 -1
  463. package/dist/styling.d.ts +0 -100
  464. package/dist/styling.d.ts.map +0 -1
  465. package/dist/styling.js +0 -2
  466. package/dist/styling.js.map +0 -1
package/dist/docs/interfaces/SavedDatasource.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SavedDatasource | @octostar/platform-types - v0.5.37</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.37</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="SavedDatasource.html">SavedDatasource</a></li></ul><h1>Interface SavedDatasource</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedDatasource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#main_dttm_col">main_dttm_col</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#name">name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#table_name">table_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#uid">uid</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L12">savedSearch.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SavedDatasource.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
2
- <a href="SavedDatasource.html#main_dttm_col" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main_<wbr/>dttm_<wbr/>col</span></a>
3
- <a href="SavedDatasource.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name?</span></a>
4
- <a href="SavedDatasource.html#table_name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table_<wbr/>name</span></a>
5
- <a href="SavedDatasource.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
6
- <a href="SavedDatasource.html#uid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</span></a>
7
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L14">savedSearch.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="main_dttm_col" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>main_<wbr/>dttm_<wbr/>col</span><a href="#main_dttm_col" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">main_<wbr/>dttm_<wbr/>col</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L18">savedSearch.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L15">savedSearch.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="table_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>table_<wbr/>name</span><a href="#table_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">table_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L16">savedSearch.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L17">savedSearch.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uid</span><a href="#uid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L13">savedSearch.ts:13</a></li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#main_dttm_col" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main_<wbr/>dttm_<wbr/>col</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#table_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table_<wbr/>name</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</span></a></div></details></div></details></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.37</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/interfaces/SavedSearchAPIInterface.html DELETED
@@ -1,6 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SavedSearchAPIInterface | @octostar/platform-types - v0.5.37</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.37</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="SavedSearchAPIInterface.html">SavedSearchAPIInterface</a></li></ul><h1>Interface SavedSearchAPIInterface</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedSearchAPIInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchAPIInterface.html#getRecords">getRecords</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchAPIInterface.html#getRecordsCount">getRecordsCount</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchAPIInterface.html#getRecordsCountQuery">getRecordsCountQuery</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchAPIInterface.html#getRecordsQuery">getRecordsQuery</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchAPIInterface.html#getSavedSearchPasteContext">getSavedSearchPasteContext</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L132">savedSearch.ts:132</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SavedSearchAPIInterface.html#getRecords" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records</span></a>
2
- <a href="SavedSearchAPIInterface.html#getRecordsCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Count</span></a>
3
- <a href="SavedSearchAPIInterface.html#getRecordsCountQuery" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span></a>
4
- <a href="SavedSearchAPIInterface.html#getRecordsQuery" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Query</span></a>
5
- <a href="SavedSearchAPIInterface.html#getSavedSearchPasteContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="getRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records</span><a href="#getRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Records</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><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-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L137">savedSearch.ts:137</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getRecordsCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count</span><a href="#getRecordsCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Records<wbr/>Count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</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-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L133">savedSearch.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getRecordsCountQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span><a href="#getRecordsCountQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Records<wbr/>Count<wbr/>Query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L135">savedSearch.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getRecordsQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Query</span><a href="#getRecordsQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Records<wbr/>Query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</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-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L142">savedSearch.ts:142</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getSavedSearchPasteContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><a href="#getSavedSearchPasteContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><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-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L147">savedSearch.ts:147</a></li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getRecords" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records</span></a><a href="#getRecordsCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Count</span></a><a href="#getRecordsCountQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span></a><a href="#getRecordsQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Records<wbr/>Query</span></a><a href="#getSavedSearchPasteContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span></a></div></details></div></details></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.37</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/interfaces/SavedSearchContent.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SavedSearchContent | @octostar/platform-types - v0.5.37</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.37</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="SavedSearchContent.html">SavedSearchContent</a></li></ul><h1>Interface SavedSearchContent</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedSearchContent</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#concept">concept</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#crossFilters">crossFilters</a><span class="tsd-signature-symbol">: </span><a href="../types/DataMask.html" class="tsd-signature-type tsd-kind-type-alias">DataMask</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#dataset">dataset</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#datasourcesInScope">datasourcesInScope</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="SavedDatasource.html" class="tsd-signature-type tsd-kind-interface">SavedDatasource</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#filters">filters</a><span class="tsd-signature-symbol">: </span><a href="../types/Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedSearchContent.html#initialCount">initialCount</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L20">savedSearch.ts:20</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SavedSearchContent.html#concept" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>concept</span></a>
2
- <a href="SavedSearchContent.html#crossFilters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cross<wbr/>Filters</span></a>
3
- <a href="SavedSearchContent.html#dataset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dataset</span></a>
4
- <a href="SavedSearchContent.html#datasourcesInScope" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>datasources<wbr/>In<wbr/>Scope</span></a>
5
- <a href="SavedSearchContent.html#filters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filters</span></a>
6
- <a href="SavedSearchContent.html#initialCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Count?</span></a>
7
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>concept</span><a href="#concept" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L21">savedSearch.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="crossFilters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cross<wbr/>Filters</span><a href="#crossFilters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cross<wbr/>Filters</span><span class="tsd-signature-symbol">:</span> <a href="../types/DataMask.html" class="tsd-signature-type tsd-kind-type-alias">DataMask</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L24">savedSearch.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dataset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dataset</span><a href="#dataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dataset</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L22">savedSearch.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="datasourcesInScope" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>datasources<wbr/>In<wbr/>Scope</span><a href="#datasourcesInScope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">datasources<wbr/>In<wbr/>Scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="SavedDatasource.html" class="tsd-signature-type tsd-kind-interface">SavedDatasource</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L25">savedSearch.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="filters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>filters</span><a href="#filters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filters</span><span class="tsd-signature-symbol">:</span> <a href="../types/Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L23">savedSearch.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="initialCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>initial<wbr/>Count</span><a href="#initialCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initial<wbr/>Count</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L26">savedSearch.ts:26</a></li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>concept</span></a><a href="#crossFilters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cross<wbr/>Filters</span></a><a href="#dataset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dataset</span></a><a href="#datasourcesInScope" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>datasources<wbr/>In<wbr/>Scope</span></a><a href="#filters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filters</span></a><a href="#initialCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Count</span></a></div></details></div></details></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.37</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/interfaces/StylerContext.html DELETED
@@ -1,21 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StylerContext | @octostar/platform-types - v0.5.37</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.37</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="StylerContext.html">StylerContext</a></li></ul><h1>Interface StylerContext<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface representing the context for a styler.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">StylerContext</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#DesktopAPI">DesktopAPI</a><span class="tsd-signature-symbol">: </span><a href="Desktop.html" class="tsd-signature-type tsd-kind-interface">Desktop</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#ee">ee</a><span class="tsd-signature-symbol">: </span><a href="../types/EventEmitterType.html" class="tsd-signature-type tsd-kind-type-alias">EventEmitterType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#eventTopicPrefix">eventTopicPrefix</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#graph">graph</a><span class="tsd-signature-symbol">: </span><a href="../types/GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#onTaskCanceled">onTaskCanceled</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#onTaskComplete">onTaskComplete</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><a href="../types/Styler.html" class="tsd-signature-type tsd-kind-type-alias">Styler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#OntologyAPI">OntologyAPI</a><span class="tsd-signature-symbol">: </span><a href="Ontology.html" class="tsd-signature-type tsd-kind-interface">Ontology</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#selected">selected</a><span class="tsd-signature-symbol">: </span><a href="../types/GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="StylerContext.html#taskID">taskID</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L48">styling.ts:48</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="StylerContext.html#DesktopAPI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DesktopAPI</span></a>
3
- <a href="StylerContext.html#ee" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ee</span></a>
4
- <a href="StylerContext.html#eventTopicPrefix" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Topic<wbr/>Prefix</span></a>
5
- <a href="StylerContext.html#graph" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>graph</span></a>
6
- <a href="StylerContext.html#onTaskCanceled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Task<wbr/>Canceled?</span></a>
7
- <a href="StylerContext.html#onTaskComplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Task<wbr/>Complete?</span></a>
8
- <a href="StylerContext.html#OntologyAPI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>OntologyAPI</span></a>
9
- <a href="StylerContext.html#selected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected</span></a>
10
- <a href="StylerContext.html#taskID" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>taskID?</span></a>
11
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="DesktopAPI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>DesktopAPI</span><a href="#DesktopAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DesktopAPI</span><span class="tsd-signature-symbol">:</span> <a href="Desktop.html" class="tsd-signature-type tsd-kind-interface">Desktop</a></div><div class="tsd-comment tsd-typography"><p>The desktop API instance.</p>
12
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L56">styling.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>ee</span><a href="#ee" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ee</span><span class="tsd-signature-symbol">:</span> <a href="../types/EventEmitterType.html" class="tsd-signature-type tsd-kind-type-alias">EventEmitterType</a></div><div class="tsd-comment tsd-typography"><p>The event emitter instance.</p>
13
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L58">styling.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="eventTopicPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>event<wbr/>Topic<wbr/>Prefix</span><a href="#eventTopicPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">event<wbr/>Topic<wbr/>Prefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The event topic prefix.</p>
14
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L60">styling.ts:60</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="graph" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>graph</span><a href="#graph" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">graph</span><span class="tsd-signature-symbol">:</span> <a href="../types/GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a></div><div class="tsd-comment tsd-typography"><p>The graph specification.</p>
15
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L50">styling.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onTaskCanceled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Task<wbr/>Canceled</span><a href="#onTaskCanceled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Task<wbr/>Canceled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Callback function to be called when the task is canceled.</p>
16
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L68">styling.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onTaskComplete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Task<wbr/>Complete</span><a href="#onTaskComplete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Task<wbr/>Complete</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><a href="../types/Styler.html" class="tsd-signature-type tsd-kind-type-alias">Styler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Callback function to be called when the task is complete.</p>
17
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: x"><h4 class="tsd-anchor-link"><a id="Param: x" class="tsd-anchor"></a>Param: x<a href="#Param: x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The styler instance.</p>
18
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L66">styling.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="OntologyAPI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>OntologyAPI</span><a href="#OntologyAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">OntologyAPI</span><span class="tsd-signature-symbol">:</span> <a href="Ontology.html" class="tsd-signature-type tsd-kind-interface">Ontology</a></div><div class="tsd-comment tsd-typography"><p>The ontology API instance.</p>
19
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L54">styling.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="selected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>selected</span><a href="#selected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selected</span><span class="tsd-signature-symbol">:</span> <a href="../types/GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a></div><div class="tsd-comment tsd-typography"><p>The selected graph specification.</p>
20
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L52">styling.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="taskID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>taskID</span><a href="#taskID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">taskID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The task ID associated with the styler.</p>
21
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/styling.ts#L70">styling.ts:70</a></li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#DesktopAPI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DesktopAPI</span></a><a href="#ee" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ee</span></a><a href="#eventTopicPrefix" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Topic<wbr/>Prefix</span></a><a href="#graph" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>graph</span></a><a href="#onTaskCanceled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Task<wbr/>Canceled</span></a><a href="#onTaskComplete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Task<wbr/>Complete</span></a><a href="#OntologyAPI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>OntologyAPI</span></a><a href="#selected" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected</span></a><a href="#taskID" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>taskID</span></a></div></details></div></details></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.37</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/types/Behaviour.html DELETED
@@ -1,17 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Behaviour | @octostar/platform-types - v0.5.37</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.37</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="Behaviour.html">Behaviour</a></li></ul><h1>Type Alias Behaviour<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Behaviour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">edit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getContent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getEntities</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getEntitiesCount</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getEntity</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getGraph</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">open</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type representing a set of behaviors with various methods for entity and graph operations.</p>
2
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">edit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Edits the associated entity or content with the default edit action.</p>
3
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.edit.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the operation is complete.</p>
4
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">get<wbr/>Content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets the content associated with the behavior.</p>
5
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.getContent.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the content.</p>
6
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">get<wbr/>Entities</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets a list of entities.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.getEntities.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Optional limit on the number of entities to retrieve.</p>
8
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to an array of entities.</p>
9
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">get<wbr/>Entities<wbr/>Count</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets the count of entities.</p>
10
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.getEntitiesCount.__type-7.__type-8"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the number of entities.</p>
11
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">get<wbr/>Entity</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets a single entity.</p>
12
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.getEntity.__type-9.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to an entity.</p>
13
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">get<wbr/>Graph</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets the graph specification.</p>
14
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.getGraph.__type-11.__type-12"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves to the graph specification or undefined if not available.</p>
15
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">open</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Opens the associated entity or content with the default action.</p>
16
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.open.__type-13.__type-14"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the operation is complete.</p>
17
- <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/behaviour.ts#L8">behaviour.ts:8</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.37</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/types/DataMask.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataMask | @octostar/platform-types - v0.5.37</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.37</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="DataMask.html">DataMask</a></li></ul><h1>Type Alias DataMask</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Data<wbr/>Mask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">extraFormData</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">filterState</span><span class="tsd-signature-symbol">?: </span><a href="FilterState.html" class="tsd-signature-type tsd-kind-type-alias">FilterState</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ownState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L6">savedSearch.ts:6</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.37</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/types/DesktopStylerContext.html DELETED
@@ -1,4 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DesktopStylerContext | @octostar/platform-types - v0.5.37</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.37</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="DesktopStylerContext.html">DesktopStylerContext</a></li></ul><h1>Type Alias DesktopStylerContext<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Desktop<wbr/>Styler<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">graph</span><span class="tsd-signature-symbol">: </span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">selected</span><span class="tsd-signature-symbol">?: </span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Context for desktop styler.</p>
2
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">graph</span><span class="tsd-signature-symbol">: </span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a></h5><div class="tsd-comment tsd-typography"><p>Graph specification.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">selected</span><span class="tsd-signature-symbol">?: </span><a href="GraphSpec.html" class="tsd-signature-type tsd-kind-type-alias">GraphSpec</a></h5><div class="tsd-comment tsd-typography"><p>Selected graph specification.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/desktop.ts#L758">desktop.ts:758</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.37</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/types/DraftWorkspaceItem.html DELETED
@@ -1,3 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DraftWorkspaceItem | @octostar/platform-types - v0.5.37</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.37</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="DraftWorkspaceItem.html">DraftWorkspaceItem</a></li></ul><h1>Type Alias DraftWorkspaceItem<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Draft<wbr/>Workspace<wbr/>Item</span><span class="tsd-signature-symbol">:</span> <a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">os_draft_item</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Represents a draft workspace item.</p>
2
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">os_<wbr/>draft_<wbr/>item</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if the item is a draft. The attribute is not saved in persistence.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/model.ts#L703">model.ts:703</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.37</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/types/Filter.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Filter | @octostar/platform-types - v0.5.37</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.37</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="Filter.html">Filter</a></li></ul><h1>Type Alias Filter</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Filter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">adhoc_filters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">cascadeParentIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">chartsInScope</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">controlValues</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">defaultDataMask</span><span class="tsd-signature-symbol">: </span><a href="DataMask.html" class="tsd-signature-type tsd-kind-type-alias">DataMask</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">filterType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">granularity</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">granularity_sqla</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">requiredFirst</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">scope</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/NativeFilterScope.html" class="tsd-signature-type tsd-kind-interface">NativeFilterScope</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sortMetric</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tabsInScope</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">targets</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NativeFilterTarget.html" class="tsd-signature-type tsd-kind-interface">NativeFilterTarget</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">time_grain_sqla</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">time_range</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;NATIVE_FILTER&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L49">savedSearch.ts:49</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.37</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/types/FilterState.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FilterState | @octostar/platform-types - v0.5.37</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.37</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="FilterState.html">FilterState</a></li></ul><h1>Type Alias FilterState</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Filter<wbr/>State</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L4">savedSearch.ts:4</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.37</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>