@octostar/platform-types 0.5.34 → 0.5.36

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 (292) hide show
  1. package/dist/desktop.d.ts +25 -0
  2. package/dist/desktop.d.ts.map +1 -1
  3. package/dist/desktop.js.map +1 -1
  4. package/dist/docs/assets/navigation.js +1 -1
  5. package/dist/docs/assets/search.js +1 -1
  6. package/dist/docs/enums/ProcessingStatusCode.html +16 -16
  7. package/dist/docs/enums/SortOrder.html +3 -3
  8. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  9. package/dist/docs/functions/isWorkspaceFileItem.html +1 -1
  10. package/dist/docs/hierarchy.html +1 -1
  11. package/dist/docs/index.html +2 -2
  12. package/dist/docs/interfaces/AIClient.html +4 -4
  13. package/dist/docs/interfaces/ActionContext.html +4 -4
  14. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  15. package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
  16. package/dist/docs/interfaces/ChatMessage.html +6 -6
  17. package/dist/docs/interfaces/Colorful.html +3 -3
  18. package/dist/docs/interfaces/Concept.html +12 -12
  19. package/dist/docs/interfaces/DeleteResponse.html +2 -2
  20. package/dist/docs/interfaces/Desktop.html +108 -105
  21. package/dist/docs/interfaces/DesktopActionContext.html +7 -7
  22. package/dist/docs/interfaces/DesktopSettings.html +6 -6
  23. package/dist/docs/interfaces/DeveloperSettings.html +4 -4
  24. package/dist/docs/interfaces/DownloadOptions.html +2 -2
  25. package/dist/docs/interfaces/EntityUiState.html +2 -2
  26. package/dist/docs/interfaces/FetchOptions.html +4 -4
  27. package/dist/docs/interfaces/FileListResponse.html +2 -2
  28. package/dist/docs/interfaces/FilesAPIClient.html +12 -12
  29. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  30. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  31. package/dist/docs/interfaces/IndexSearchHitSource.html +3 -3
  32. package/dist/docs/interfaces/Inheritance.html +5 -5
  33. package/dist/docs/interfaces/LiveContext.html +11 -11
  34. package/dist/docs/interfaces/MoveOptions.html +2 -2
  35. package/dist/docs/interfaces/MoveResponse.html +27 -27
  36. package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
  37. package/dist/docs/interfaces/NativeFilterScope.html +2 -2
  38. package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
  39. package/dist/docs/interfaces/Ontology.html +25 -25
  40. package/dist/docs/interfaces/OsAPIClient.html +8 -8
  41. package/dist/docs/interfaces/ProcessingStatus.html +7 -7
  42. package/dist/docs/interfaces/Property.html +5 -5
  43. package/dist/docs/interfaces/RecordData.html +5 -5
  44. package/dist/docs/interfaces/RecordProvider.html +6 -6
  45. package/dist/docs/interfaces/RefObject.html +3 -3
  46. package/dist/docs/interfaces/Relationship.html +20 -20
  47. package/dist/docs/interfaces/S3Headers.html +2 -2
  48. package/dist/docs/interfaces/S3UploadResponse.html +2 -2
  49. package/dist/docs/interfaces/SavedDatasource.html +2 -2
  50. package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
  51. package/dist/docs/interfaces/SavedSearchContent.html +2 -2
  52. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  53. package/dist/docs/interfaces/SearchOptions.html +3 -3
  54. package/dist/docs/interfaces/SearchProps.html +10 -10
  55. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  56. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  57. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  58. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  59. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  60. package/dist/docs/interfaces/StylerContext.html +11 -11
  61. package/dist/docs/interfaces/TagAttributes.html +7 -7
  62. package/dist/docs/interfaces/UiStateManager.html +2 -2
  63. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  64. package/dist/docs/interfaces/UnzipOptions.html +2 -2
  65. package/dist/docs/interfaces/UploadOptions.html +2 -2
  66. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  67. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  68. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  69. package/dist/docs/modules.html +3 -2
  70. package/dist/docs/types/ActionHandler.html +2 -2
  71. package/dist/docs/types/AddCommentParams.html +2 -2
  72. package/dist/docs/types/AddListener.html +2 -2
  73. package/dist/docs/types/ApiErrorResult.html +2 -2
  74. package/dist/docs/types/ApiResult.html +2 -2
  75. package/dist/docs/types/ApiSuccessResult.html +2 -2
  76. package/dist/docs/types/App.html +2 -2
  77. package/dist/docs/types/AppRegistry.html +2 -2
  78. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  79. package/dist/docs/types/AppServiceCallProps.html +2 -2
  80. package/dist/docs/types/AsyncFilter.html +2 -2
  81. package/dist/docs/types/AttachmentResponseType.html +2 -2
  82. package/dist/docs/types/AttachmentType.html +2 -2
  83. package/dist/docs/types/Behaviour.html +2 -2
  84. package/dist/docs/types/BinaryOperator.html +2 -2
  85. package/dist/docs/types/Callback.html +2 -2
  86. package/dist/docs/types/ChatApiResponse.html +1 -1
  87. package/dist/docs/types/ChatModel.html +2 -2
  88. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  89. package/dist/docs/types/CommonOptions.html +1 -1
  90. package/dist/docs/types/Comparator.html +2 -2
  91. package/dist/docs/types/ConceptFilter.html +2 -2
  92. package/dist/docs/types/ConceptMap.html +2 -2
  93. package/dist/docs/types/ConceptName.html +1 -1
  94. package/dist/docs/types/ConceptWithParents.html +2 -2
  95. package/dist/docs/types/ConnectedEntity.html +2 -2
  96. package/dist/docs/types/ContextMenuGroup.html +2 -2
  97. package/dist/docs/types/ContextMenuLabels.html +2 -2
  98. package/dist/docs/types/ContextMenuOptions.html +2 -2
  99. package/dist/docs/types/ContextMenuParams.html +2 -2
  100. package/dist/docs/types/ContextMenuRequest.html +2 -2
  101. package/dist/docs/types/CopyOptions.html +2 -2
  102. package/dist/docs/types/CreateEntityFormProps.html +2 -2
  103. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  104. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  105. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  106. package/dist/docs/types/CustomEventListener.html +2 -2
  107. package/dist/docs/types/CustomTemplate.html +2 -2
  108. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  109. package/dist/docs/types/DataContextType.html +2 -2
  110. package/dist/docs/types/DataMask.html +1 -1
  111. package/dist/docs/types/DefaultLiveContextData.html +1 -1
  112. package/dist/docs/types/DesktopAction.html +2 -2
  113. package/dist/docs/types/DesktopActionFilter.html +2 -2
  114. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  115. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  116. package/dist/docs/types/DesktopActionOptions.html +2 -2
  117. package/dist/docs/types/DesktopOpenParams.html +2 -2
  118. package/dist/docs/types/DesktopStylerContext.html +2 -2
  119. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  120. package/dist/docs/types/DragEndParams.html +2 -2
  121. package/dist/docs/types/DragStartParams.html +2 -2
  122. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  123. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  124. package/dist/docs/types/EConnection.html +2 -2
  125. package/dist/docs/types/EdgeSpec.html +2 -2
  126. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  127. package/dist/docs/types/Entity.html +2 -2
  128. package/dist/docs/types/EntityBase.html +2 -2
  129. package/dist/docs/types/EntityEdge.html +2 -2
  130. package/dist/docs/types/EntityOTM.html +2 -2
  131. package/dist/docs/types/EntityPasteContext.html +2 -2
  132. package/dist/docs/types/EvalContext.html +1 -1
  133. package/dist/docs/types/EventContextType.html +2 -2
  134. package/dist/docs/types/EventEmitterType.html +2 -2
  135. package/dist/docs/types/EventName.html +2 -2
  136. package/dist/docs/types/EventProducer.html +2 -2
  137. package/dist/docs/types/EventPublisher.html +2 -2
  138. package/dist/docs/types/EventSubscriber.html +2 -2
  139. package/dist/docs/types/EventUnsubscriber.html +2 -2
  140. package/dist/docs/types/ExportOptions.html +2 -2
  141. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  142. package/dist/docs/types/ExtrasApi.html +1 -1
  143. package/dist/docs/types/FetchEntityOptions.html +2 -2
  144. package/dist/docs/types/FileCode.html +2 -2
  145. package/dist/docs/types/FileTreeOptions.html +2 -2
  146. package/dist/docs/types/Filter.html +1 -1
  147. package/dist/docs/types/FilterDefinition.html +2 -2
  148. package/dist/docs/types/FilterDefinitions.html +2 -2
  149. package/dist/docs/types/FilterName.html +2 -2
  150. package/dist/docs/types/FilterQuery.html +2 -2
  151. package/dist/docs/types/FilterReference.html +2 -2
  152. package/dist/docs/types/FilterState.html +1 -1
  153. package/dist/docs/types/FilterValue.html +2 -2
  154. package/dist/docs/types/FocusListItem.html +2 -2
  155. package/dist/docs/types/FolderPasteOptions.html +2 -2
  156. package/dist/docs/types/GetSystemSettingResponse.html +1 -1
  157. package/dist/docs/types/GraphDataSpec.html +1 -1
  158. package/dist/docs/types/GraphSpec.html +2 -2
  159. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  160. package/dist/docs/types/Icon.html +2 -2
  161. package/dist/docs/types/IconProps.html +2 -2
  162. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  163. package/dist/docs/types/ImageInfo.html +2 -2
  164. package/dist/docs/types/ImportFoldersOptions.html +5 -0
  165. package/dist/docs/types/ImportZipOptions.html +2 -2
  166. package/dist/docs/types/InlineCode.html +2 -2
  167. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  168. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  169. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  170. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  171. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  172. package/dist/docs/types/JavascriptType.html +2 -2
  173. package/dist/docs/types/JobManifest.html +2 -2
  174. package/dist/docs/types/KnownCounts.html +2 -2
  175. package/dist/docs/types/ListByParentFolder.html +1 -1
  176. package/dist/docs/types/ListByPath.html +1 -1
  177. package/dist/docs/types/ListFolderOptions.html +1 -1
  178. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  179. package/dist/docs/types/LiveContextListener.html +1 -1
  180. package/dist/docs/types/ManifestSecrets.html +1 -1
  181. package/dist/docs/types/MkdirResponse.html +1 -1
  182. package/dist/docs/types/ModalTemplateProps.html +2 -2
  183. package/dist/docs/types/NamedEntityGroup.html +2 -2
  184. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  185. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  186. package/dist/docs/types/NunjucksType.html +2 -2
  187. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  188. package/dist/docs/types/OntologyTags.html +2 -2
  189. package/dist/docs/types/OsAuditFields.html +2 -2
  190. package/dist/docs/types/OsConfirmProps.html +2 -2
  191. package/dist/docs/types/OsNotification.html +2 -2
  192. package/dist/docs/types/OsProgress.html +2 -2
  193. package/dist/docs/types/OsTag.html +2 -2
  194. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  195. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  196. package/dist/docs/types/PasteContextOptions.html +2 -2
  197. package/dist/docs/types/Permission.html +2 -2
  198. package/dist/docs/types/Point.html +2 -2
  199. package/dist/docs/types/PromptOptions.html +2 -2
  200. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  201. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  202. package/dist/docs/types/Query.html +2 -2
  203. package/dist/docs/types/QueryBatchResult.html +2 -2
  204. package/dist/docs/types/QueryErrorResult.html +2 -2
  205. package/dist/docs/types/QueryExecutor.html +2 -2
  206. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  207. package/dist/docs/types/QueryResponse.html +2 -2
  208. package/dist/docs/types/QueryResult.html +2 -2
  209. package/dist/docs/types/QuerySuccessResult.html +2 -2
  210. package/dist/docs/types/ReactCssProperties.html +2 -2
  211. package/dist/docs/types/ReactNode.html +2 -2
  212. package/dist/docs/types/ReactRef.html +2 -2
  213. package/dist/docs/types/ReasonedBoolean.html +2 -2
  214. package/dist/docs/types/RecordFetchOptions.html +1 -1
  215. package/dist/docs/types/RefCallback.html +2 -2
  216. package/dist/docs/types/RelationshipCountResult.html +2 -2
  217. package/dist/docs/types/RemoteAppApi.html +1 -1
  218. package/dist/docs/types/RenameTabProps.html +2 -2
  219. package/dist/docs/types/SaveAsModalProps.html +2 -2
  220. package/dist/docs/types/SaveFileOptions.html +2 -2
  221. package/dist/docs/types/SaveOptions.html +2 -2
  222. package/dist/docs/types/SavedTemplate.html +2 -2
  223. package/dist/docs/types/SearchFilter.html +2 -2
  224. package/dist/docs/types/SemanticBinding.html +2 -2
  225. package/dist/docs/types/SemanticBindingType.html +2 -2
  226. package/dist/docs/types/SemanticBindings.html +2 -2
  227. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  228. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  229. package/dist/docs/types/SendQueryOptions.html +2 -2
  230. package/dist/docs/types/ServiceDefinition.html +2 -2
  231. package/dist/docs/types/ServiceDefinitions.html +2 -2
  232. package/dist/docs/types/ServiceRole.html +2 -2
  233. package/dist/docs/types/SetTransformResultFn.html +1 -1
  234. package/dist/docs/types/SetsOptions.html +2 -2
  235. package/dist/docs/types/ShowOntology.html +2 -2
  236. package/dist/docs/types/ShowTabProps.html +2 -2
  237. package/dist/docs/types/Styler.html +2 -2
  238. package/dist/docs/types/StylerConfig.html +2 -2
  239. package/dist/docs/types/StylerDefinition.html +2 -2
  240. package/dist/docs/types/StylerDefinitions.html +2 -2
  241. package/dist/docs/types/StylerOption.html +2 -2
  242. package/dist/docs/types/StylerProducer.html +2 -2
  243. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  244. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  245. package/dist/docs/types/Tag.html +2 -2
  246. package/dist/docs/types/TagInfo.html +2 -2
  247. package/dist/docs/types/TagWithRelationship.html +2 -2
  248. package/dist/docs/types/TaskCleanupReason.html +2 -2
  249. package/dist/docs/types/TemplateMetadata.html +2 -2
  250. package/dist/docs/types/TemplateType.html +2 -2
  251. package/dist/docs/types/TemplateVariant.html +2 -2
  252. package/dist/docs/types/TransformAction.html +2 -2
  253. package/dist/docs/types/TransformActionContext.html +2 -2
  254. package/dist/docs/types/TransformDefinition.html +2 -2
  255. package/dist/docs/types/TransformDefinitions.html +2 -2
  256. package/dist/docs/types/Unsubscribe.html +2 -2
  257. package/dist/docs/types/UnsubscribeFn.html +1 -1
  258. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  259. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  260. package/dist/docs/types/UserProfile.html +2 -2
  261. package/dist/docs/types/VirtualEntity.html +2 -2
  262. package/dist/docs/types/Watcher.html +2 -2
  263. package/dist/docs/types/Whoami.html +2 -2
  264. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  265. package/dist/docs/types/Workspace.html +2 -2
  266. package/dist/docs/types/WorkspaceConfig.html +2 -2
  267. package/dist/docs/types/WorkspaceFlags.html +2 -2
  268. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  269. package/dist/docs/types/WorkspaceItem.html +2 -2
  270. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  271. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  272. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  273. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  274. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  275. package/dist/docs/types/WorkspaceItems.html +2 -2
  276. package/dist/docs/types/WorkspacePermission.html +2 -2
  277. package/dist/docs/types/WorkspaceRecord.html +2 -2
  278. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  279. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  280. package/dist/docs/types/WorkspaceRecords.html +2 -2
  281. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  282. package/dist/docs/types/WorkspaceSettings.html +2 -2
  283. package/dist/docs/types/trigger.html +2 -2
  284. package/dist/docs/types/uuid.html +2 -2
  285. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  286. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  287. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  288. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  289. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  290. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  291. package/dist/platform-types.d.ts +26 -0
  292. package/package.json +1 -1
package/dist/docs/interfaces/Inheritance.html CHANGED
@@ -1,8 +1,8 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Inheritance | @octostar/platform-types - v0.5.34</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.34</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="Inheritance.html">Inheritance</a></li></ul><h1>Interface Inheritance<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an inheritance relationship between concepts.</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">Inheritance</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="Inheritance.html#base_concept">base_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="Inheritance.html#derived_concept">derived_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="Inheritance.html#display_name">display_name</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/model.ts#L65">model.ts:65</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="Inheritance.html#base_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>base_<wbr/>concept</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Inheritance | @octostar/platform-types - v0.5.36</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.36</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="Inheritance.html">Inheritance</a></li></ul><h1>Interface Inheritance<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an inheritance relationship between concepts.</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">Inheritance</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="Inheritance.html#base_concept">base_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="Inheritance.html#derived_concept">derived_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="Inheritance.html#display_name">display_name</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/model.ts#L65">model.ts:65</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="Inheritance.html#base_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>base_<wbr/>concept</span></a>
3
3
  <a href="Inheritance.html#derived_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>derived_<wbr/>concept</span></a>
4
4
  <a href="Inheritance.html#display_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>display_<wbr/>name</span></a>
5
5
  </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="base_concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>base_<wbr/>concept</span><a href="#base_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">base_<wbr/>concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The base concept in the inheritance.</p>
6
- </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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/model.ts#L69">model.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="derived_concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>derived_<wbr/>concept</span><a href="#derived_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">derived_<wbr/>concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The derived concept in the inheritance.</p>
7
- </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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/model.ts#L73">model.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="display_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>display_<wbr/>name</span><a href="#display_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">display_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name will be displayed on ui</p>
8
- </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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/model.ts#L77">model.ts:77</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="#base_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base_<wbr/>concept</span></a><a href="#derived_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>derived_<wbr/>concept</span></a><a href="#display_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name</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.34</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>
6
+ </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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/model.ts#L69">model.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="derived_concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>derived_<wbr/>concept</span><a href="#derived_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">derived_<wbr/>concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The derived concept in the inheritance.</p>
7
+ </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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/model.ts#L73">model.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="display_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>display_<wbr/>name</span><a href="#display_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">display_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name will be displayed on ui</p>
8
+ </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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/model.ts#L77">model.ts:77</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="#base_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base_<wbr/>concept</span></a><a href="#derived_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>derived_<wbr/>concept</span></a><a href="#display_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display_<wbr/>name</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.36</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/LiveContext.html CHANGED
@@ -1,5 +1,5 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveContext | @octostar/platform-types - v0.5.34</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.34</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="LiveContext.html">LiveContext</a></li></ul><h1>Interface LiveContext&lt;ContextData&gt;<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a context management interface for handling state across components</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">LiveContext</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#addContextListener">addContextListener</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextAPI</span><span class="tsd-signature-symbol">: </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">mapContext</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span><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><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><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#connect">connect</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#destroy">destroy</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="LiveContext.html#getContext">getContext</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><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#id">id</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="LiveContext.html#removeContextListener">removeContextListener</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">idOrContextAPI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#setContext">setContext</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextAPISetParams.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextAPISetParams</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#subscribeToChanges">subscribeToChanges</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#unsubscribeFromChanges">unsubscribeFromChanges</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ContextData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ContextData</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DefaultLiveContextData.html" class="tsd-signature-type tsd-kind-type-alias">DefaultLiveContextData</a> = <a href="../types/DefaultLiveContextData.html" class="tsd-signature-type tsd-kind-type-alias">DefaultLiveContextData</a></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L15">liveContext.ts:15</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="LiveContext.html#addContextListener" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Context<wbr/>Listener</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveContext | @octostar/platform-types - v0.5.36</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.36</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="LiveContext.html">LiveContext</a></li></ul><h1>Interface LiveContext&lt;ContextData&gt;<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a context management interface for handling state across components</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">LiveContext</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#addContextListener">addContextListener</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextAPI</span><span class="tsd-signature-symbol">: </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">mapContext</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#addContextListener.__type.__type-1.ContextDataToConnect">ContextDataToConnect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span><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><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><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#connect">connect</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#destroy">destroy</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="LiveContext.html#getContext">getContext</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><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#id">id</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="LiveContext.html#removeContextListener">removeContextListener</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">idOrContextAPI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#setContext">setContext</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextAPISetParams.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextAPISetParams</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#subscribeToChanges">subscribeToChanges</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LiveContext.html#unsubscribeFromChanges">unsubscribeFromChanges</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ContextData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ContextData</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DefaultLiveContextData.html" class="tsd-signature-type tsd-kind-type-alias">DefaultLiveContextData</a> = <a href="../types/DefaultLiveContextData.html" class="tsd-signature-type tsd-kind-type-alias">DefaultLiveContextData</a></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L15">liveContext.ts:15</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="LiveContext.html#addContextListener" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Context<wbr/>Listener</span></a>
3
3
  <a href="LiveContext.html#connect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connect</span></a>
4
4
  <a href="LiveContext.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destroy</span></a>
5
5
  <a href="LiveContext.html#getContext" 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/>Context</span></a>
@@ -12,19 +12,19 @@
12
12
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: contextAPI"><h4 class="tsd-anchor-link"><a id="Param: contextAPI" class="tsd-anchor"></a>Param: contextAPI<a href="#Param: contextAPI" 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 Context instance to connect to</p>
13
13
  </div><div class="tsd-tag-Param: mapContext"><h4 class="tsd-anchor-link"><a id="Param: mapContext" class="tsd-anchor"></a>Param: mapContext<a href="#Param: mapContext" 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>Optional function to transform context data</p>
14
14
  </div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" 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>Function to remove the context listener</p>
15
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L58">liveContext.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" 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">connect</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">string</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Connects to target window for context synchronization</p>
15
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L58">liveContext.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" 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">connect</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">string</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Connects to target window for context synchronization</p>
16
16
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns-1" class="tsd-anchor"></a>Returns<a href="#Returns-1" 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 channel ID used for communication</p>
17
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L77">liveContext.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" 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">destroy</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>Destroys the context and cleans up all listeners</p>
18
- </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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L83">liveContext.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Context</span><a href="#getContext" 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/>Context</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><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the current context data</p>
17
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L77">liveContext.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" 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">destroy</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>Destroys the context and cleans up all listeners</p>
18
+ </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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L83">liveContext.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Context</span><a href="#getContext" 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/>Context</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><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the current context data</p>
19
19
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns-2" class="tsd-anchor"></a>Returns<a href="#Returns-2" 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 current context data</p>
20
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L26">liveContext.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code> <code class="tsd-tag">Beta</code><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">string</span></div><div class="tsd-comment tsd-typography"><p>Unique identifier for the context instance</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L19">liveContext.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="removeContextListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Context<wbr/>Listener</span><a href="#removeContextListener" 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">remove<wbr/>Context<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">idOrContextAPI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</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">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Removes a context listener</p>
20
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L26">liveContext.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code> <code class="tsd-tag">Beta</code><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">string</span></div><div class="tsd-comment tsd-typography"><p>Unique identifier for the context instance</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L19">liveContext.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="removeContextListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Context<wbr/>Listener</span><a href="#removeContextListener" 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">remove<wbr/>Context<wbr/>Listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">idOrContextAPI</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="LiveContext.html" class="tsd-signature-type tsd-kind-interface">LiveContext</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#removeContextListener.__type-10.__type-11.ContextDataToConnect-1">ContextDataToConnect</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">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Removes a context listener</p>
22
22
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: idOrContextAPI"><h4 class="tsd-anchor-link"><a id="Param: idOrContextAPI" class="tsd-anchor"></a>Param: idOrContextAPI<a href="#Param: idOrContextAPI" 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>ID or Context instance to disconnect from</p>
23
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L68">liveContext.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Context</span><a href="#setContext" 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">set<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">context</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextAPISetParams.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextAPISetParams</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Updates the context with new data</p>
23
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L68">liveContext.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Context</span><a href="#setContext" 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">set<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">context</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextAPISetParams.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextAPISetParams</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Updates the context with new data</p>
24
24
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: context"><h4 class="tsd-anchor-link"><a id="Param: context" class="tsd-anchor"></a>Param: context<a href="#Param: context" 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>New context data or function to update context</p>
25
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L33">liveContext.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="subscribeToChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>subscribe<wbr/>To<wbr/>Changes</span><a href="#subscribeToChanges" 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">subscribe<wbr/>To<wbr/>Changes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Subscribes to context changes with an automatically generated ID</p>
25
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L33">liveContext.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="subscribeToChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>subscribe<wbr/>To<wbr/>Changes</span><a href="#subscribeToChanges" 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">subscribe<wbr/>To<wbr/>Changes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveContextListener.html" class="tsd-signature-type tsd-kind-type-alias">LiveContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="LiveContext.html#ContextData">ContextData</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">string</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Subscribes to context changes with an automatically generated ID</p>
26
26
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: contextListener"><h4 class="tsd-anchor-link"><a id="Param: contextListener" class="tsd-anchor"></a>Param: contextListener<a href="#Param: contextListener" 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>Callback function triggered on context changes</p>
27
27
  </div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns-3" class="tsd-anchor"></a>Returns<a href="#Returns-3" 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>Generated subscription ID</p>
28
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L41">liveContext.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsubscribeFromChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>From<wbr/>Changes</span><a href="#unsubscribeFromChanges" 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">unsubscribe<wbr/>From<wbr/>Changes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Unsubscribes from context changes</p>
28
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L41">liveContext.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="unsubscribeFromChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>From<wbr/>Changes</span><a href="#unsubscribeFromChanges" 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">unsubscribe<wbr/>From<wbr/>Changes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Unsubscribes from context changes</p>
29
29
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: id"><h4 class="tsd-anchor-link"><a id="Param: id" class="tsd-anchor"></a>Param: id<a href="#Param: id" 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>Subscription ID to remove</p>
30
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/liveContext.ts#L49">liveContext.ts:49</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="#addContextListener" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Context<wbr/>Listener</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connect</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destroy</span></a><a href="#getContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Context</span></a><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="#removeContextListener" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Context<wbr/>Listener</span></a><a href="#setContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Context</span></a><a href="#subscribeToChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe<wbr/>To<wbr/>Changes</span></a><a href="#unsubscribeFromChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>From<wbr/>Changes</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.34</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>
30
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/liveContext.ts#L49">liveContext.ts:49</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="#addContextListener" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Context<wbr/>Listener</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connect</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>destroy</span></a><a href="#getContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Context</span></a><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="#removeContextListener" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Context<wbr/>Listener</span></a><a href="#setContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Context</span></a><a href="#subscribeToChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribe<wbr/>To<wbr/>Changes</span></a><a href="#unsubscribeFromChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>From<wbr/>Changes</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.36</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/MoveOptions.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MoveOptions | @octostar/platform-types - v0.5.34</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.34</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="MoveOptions.html">MoveOptions</a></li></ul><h1>Interface MoveOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">MoveOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="MoveOptions.html#entity_id">entity_id</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="MoveOptions.html#force">force</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="MoveOptions.html#new_name">new_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="MoveOptions.html#new_os_parent_folder">new_os_parent_folder</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="MoveOptions.html#to_path">to_path</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L27">files.ts:27</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="MoveOptions.html#entity_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>entity_<wbr/>id?</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MoveOptions | @octostar/platform-types - v0.5.36</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.36</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="MoveOptions.html">MoveOptions</a></li></ul><h1>Interface MoveOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">MoveOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="MoveOptions.html#entity_id">entity_id</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="MoveOptions.html#force">force</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="MoveOptions.html#new_name">new_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="MoveOptions.html#new_os_parent_folder">new_os_parent_folder</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="MoveOptions.html#to_path">to_path</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L27">files.ts:27</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="MoveOptions.html#entity_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>entity_<wbr/>id?</span></a>
2
2
  <a href="MoveOptions.html#force" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>force?</span></a>
3
3
  <a href="MoveOptions.html#new_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>new_<wbr/>name?</span></a>
4
4
  <a href="MoveOptions.html#new_os_parent_folder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new_<wbr/>os_<wbr/>parent_<wbr/>folder?</span></a>
5
5
  <a href="MoveOptions.html#to_path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>path?</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="entity_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>entity_<wbr/>id</span><a href="#entity_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">entity_<wbr/>id</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L29">files.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="force" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>force</span><a href="#force" 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">force</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L32">files.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="new_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>new_<wbr/>name</span><a href="#new_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">new_<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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L30">files.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="new_os_parent_folder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>new_<wbr/>os_<wbr/>parent_<wbr/>folder</span><a href="#new_os_parent_folder" 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">new_<wbr/>os_<wbr/>parent_<wbr/>folder</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L31">files.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>to_<wbr/>path</span><a href="#to_path" 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">to_<wbr/>path</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/c7fed755b5adf51157a9ac733eafc388148dbb7e/packages/octostar-platform-types/src/files.ts#L28">files.ts:28</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="#entity_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity_<wbr/>id</span></a><a href="#force" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>force</span></a><a href="#new_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new_<wbr/>name</span></a><a href="#new_os_parent_folder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new_<wbr/>os_<wbr/>parent_<wbr/>folder</span></a><a href="#to_path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>path</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.34</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>
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="entity_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>entity_<wbr/>id</span><a href="#entity_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">entity_<wbr/>id</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L29">files.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="force" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>force</span><a href="#force" 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">force</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L32">files.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="new_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>new_<wbr/>name</span><a href="#new_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">new_<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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L30">files.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="new_os_parent_folder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>new_<wbr/>os_<wbr/>parent_<wbr/>folder</span><a href="#new_os_parent_folder" 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">new_<wbr/>os_<wbr/>parent_<wbr/>folder</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L31">files.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to_path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>to_<wbr/>path</span><a href="#to_path" 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">to_<wbr/>path</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/ccf55d957af2d4d0dca9f416ae7f605952e9eddc/packages/octostar-platform-types/src/files.ts#L28">files.ts:28</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="#entity_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity_<wbr/>id</span></a><a href="#force" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>force</span></a><a href="#new_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new_<wbr/>name</span></a><a href="#new_os_parent_folder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new_<wbr/>os_<wbr/>parent_<wbr/>folder</span></a><a href="#to_path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to_<wbr/>path</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.36</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>