@octostar/platform-types 0.5.23 → 0.5.25

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 (281) hide show
  1. package/dist/docs/assets/navigation.js +1 -1
  2. package/dist/docs/assets/search.js +1 -1
  3. package/dist/docs/enums/ProcessingStatusCode.html +16 -16
  4. package/dist/docs/enums/SortOrder.html +3 -3
  5. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  6. package/dist/docs/hierarchy.html +1 -1
  7. package/dist/docs/index.html +2 -2
  8. package/dist/docs/interfaces/AIClient.html +4 -4
  9. package/dist/docs/interfaces/ActionContext.html +4 -4
  10. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  11. package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
  12. package/dist/docs/interfaces/ChatMessage.html +6 -6
  13. package/dist/docs/interfaces/Colorful.html +3 -3
  14. package/dist/docs/interfaces/Concept.html +12 -12
  15. package/dist/docs/interfaces/DeleteResponse.html +4 -0
  16. package/dist/docs/interfaces/Desktop.html +87 -87
  17. package/dist/docs/interfaces/DesktopActionContext.html +7 -7
  18. package/dist/docs/interfaces/DesktopSettings.html +5 -5
  19. package/dist/docs/interfaces/DownloadOptions.html +4 -0
  20. package/dist/docs/interfaces/FetchOptions.html +4 -4
  21. package/dist/docs/interfaces/FileListResponse.html +2 -2
  22. package/dist/docs/interfaces/Files.html +32 -7
  23. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  24. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  25. package/dist/docs/interfaces/Inheritance.html +5 -5
  26. package/dist/docs/interfaces/LiveContext.html +32 -0
  27. package/dist/docs/interfaces/MoveOptions.html +4 -0
  28. package/dist/docs/interfaces/MoveResponse.html +9 -0
  29. package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
  30. package/dist/docs/interfaces/NativeFilterScope.html +2 -2
  31. package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
  32. package/dist/docs/interfaces/Ontology.html +23 -23
  33. package/dist/docs/interfaces/OsAPIClient.html +6 -6
  34. package/dist/docs/interfaces/ProcessingStatus.html +7 -7
  35. package/dist/docs/interfaces/Property.html +5 -5
  36. package/dist/docs/interfaces/RecordData.html +5 -5
  37. package/dist/docs/interfaces/RecordProvider.html +6 -6
  38. package/dist/docs/interfaces/RefObject.html +3 -3
  39. package/dist/docs/interfaces/Relationship.html +20 -20
  40. package/dist/docs/interfaces/SavedDatasource.html +2 -2
  41. package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
  42. package/dist/docs/interfaces/SavedSearchContent.html +2 -2
  43. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  44. package/dist/docs/interfaces/SearchOptions.html +3 -3
  45. package/dist/docs/interfaces/SearchProps.html +8 -8
  46. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  47. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  48. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  49. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  50. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  51. package/dist/docs/interfaces/StylerContext.html +11 -11
  52. package/dist/docs/interfaces/TagAttributes.html +7 -7
  53. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  54. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  55. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  56. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  57. package/dist/docs/modules.html +15 -3
  58. package/dist/docs/types/ActionHandler.html +2 -2
  59. package/dist/docs/types/AddCommentParams.html +2 -2
  60. package/dist/docs/types/AddListener.html +2 -2
  61. package/dist/docs/types/ApiErrorResult.html +2 -2
  62. package/dist/docs/types/ApiResult.html +2 -2
  63. package/dist/docs/types/ApiSuccessResult.html +2 -2
  64. package/dist/docs/types/App.html +2 -2
  65. package/dist/docs/types/AppRegistry.html +2 -2
  66. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  67. package/dist/docs/types/AppServiceCallProps.html +2 -2
  68. package/dist/docs/types/AsyncFilter.html +2 -2
  69. package/dist/docs/types/AttachmentResponseType.html +2 -2
  70. package/dist/docs/types/AttachmentType.html +2 -2
  71. package/dist/docs/types/Behaviour.html +2 -2
  72. package/dist/docs/types/BinaryOperator.html +2 -2
  73. package/dist/docs/types/Callback.html +2 -2
  74. package/dist/docs/types/ChatModel.html +2 -2
  75. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  76. package/dist/docs/types/CommonOptions.html +1 -0
  77. package/dist/docs/types/Comparator.html +2 -2
  78. package/dist/docs/types/ConceptFilter.html +2 -2
  79. package/dist/docs/types/ConceptMap.html +2 -2
  80. package/dist/docs/types/ConceptName.html +1 -1
  81. package/dist/docs/types/ConceptWithParents.html +2 -2
  82. package/dist/docs/types/ConnectedEntity.html +2 -2
  83. package/dist/docs/types/ContextMenuGroup.html +2 -2
  84. package/dist/docs/types/ContextMenuLabels.html +2 -2
  85. package/dist/docs/types/ContextMenuOptions.html +2 -2
  86. package/dist/docs/types/ContextMenuParams.html +2 -2
  87. package/dist/docs/types/ContextMenuRequest.html +2 -2
  88. package/dist/docs/types/CopyOptions.html +2 -2
  89. package/dist/docs/types/CreateEntityFormProps.html +2 -2
  90. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  91. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  92. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  93. package/dist/docs/types/CustomEventListener.html +2 -2
  94. package/dist/docs/types/CustomTemplate.html +2 -2
  95. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  96. package/dist/docs/types/DataContextType.html +2 -2
  97. package/dist/docs/types/DataMask.html +1 -1
  98. package/dist/docs/types/DefaultLiveContextData.html +1 -0
  99. package/dist/docs/types/DesktopAction.html +2 -2
  100. package/dist/docs/types/DesktopActionFilter.html +2 -2
  101. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  102. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  103. package/dist/docs/types/DesktopActionOptions.html +2 -2
  104. package/dist/docs/types/DesktopOpenParams.html +2 -2
  105. package/dist/docs/types/DesktopStylerContext.html +2 -2
  106. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  107. package/dist/docs/types/DragEndParams.html +2 -2
  108. package/dist/docs/types/DragStartParams.html +2 -2
  109. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  110. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  111. package/dist/docs/types/EConnection.html +2 -2
  112. package/dist/docs/types/EdgeSpec.html +2 -2
  113. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  114. package/dist/docs/types/Entity.html +2 -2
  115. package/dist/docs/types/EntityBase.html +2 -2
  116. package/dist/docs/types/EntityEdge.html +2 -2
  117. package/dist/docs/types/EntityOTM.html +2 -2
  118. package/dist/docs/types/EntityPasteContext.html +2 -2
  119. package/dist/docs/types/EvalContext.html +1 -1
  120. package/dist/docs/types/EventContextType.html +2 -2
  121. package/dist/docs/types/EventEmitterType.html +2 -2
  122. package/dist/docs/types/EventName.html +2 -2
  123. package/dist/docs/types/EventProducer.html +2 -2
  124. package/dist/docs/types/EventPublisher.html +2 -2
  125. package/dist/docs/types/EventSubscriber.html +2 -2
  126. package/dist/docs/types/EventUnsubscriber.html +2 -2
  127. package/dist/docs/types/ExportOptions.html +2 -2
  128. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  129. package/dist/docs/types/ExtrasApi.html +1 -1
  130. package/dist/docs/types/FetchEntityOptions.html +2 -2
  131. package/dist/docs/types/FileCode.html +2 -2
  132. package/dist/docs/types/FileTreeOptions.html +2 -2
  133. package/dist/docs/types/Filter.html +1 -1
  134. package/dist/docs/types/FilterDefinition.html +2 -2
  135. package/dist/docs/types/FilterDefinitions.html +2 -2
  136. package/dist/docs/types/FilterName.html +2 -2
  137. package/dist/docs/types/FilterReference.html +2 -2
  138. package/dist/docs/types/FilterState.html +1 -1
  139. package/dist/docs/types/FocusListItem.html +2 -2
  140. package/dist/docs/types/FolderPasteOptions.html +2 -2
  141. package/dist/docs/types/GraphDataSpec.html +1 -1
  142. package/dist/docs/types/GraphSpec.html +2 -2
  143. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  144. package/dist/docs/types/Icon.html +2 -2
  145. package/dist/docs/types/IconProps.html +2 -2
  146. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  147. package/dist/docs/types/ImageInfo.html +2 -2
  148. package/dist/docs/types/ImportZipOptions.html +2 -2
  149. package/dist/docs/types/InlineCode.html +2 -2
  150. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  151. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  152. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  153. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  154. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  155. package/dist/docs/types/JavascriptType.html +2 -2
  156. package/dist/docs/types/JobManifest.html +2 -2
  157. package/dist/docs/types/KnownCounts.html +2 -2
  158. package/dist/docs/types/ListByParentFolder.html +1 -0
  159. package/dist/docs/types/ListByPath.html +1 -0
  160. package/dist/docs/types/ListFolderOptions.html +1 -0
  161. package/dist/docs/types/LiveContextAPISetParams.html +1 -0
  162. package/dist/docs/types/LiveContextListener.html +1 -0
  163. package/dist/docs/types/ManifestSecrets.html +1 -1
  164. package/dist/docs/types/MkdirResponse.html +1 -0
  165. package/dist/docs/types/ModalTemplateProps.html +2 -2
  166. package/dist/docs/types/NamedEntityGroup.html +2 -2
  167. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  168. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  169. package/dist/docs/types/NunjucksType.html +2 -2
  170. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  171. package/dist/docs/types/OntologyTags.html +2 -2
  172. package/dist/docs/types/OsAuditFields.html +2 -2
  173. package/dist/docs/types/OsConfirmProps.html +2 -2
  174. package/dist/docs/types/OsNotification.html +2 -2
  175. package/dist/docs/types/OsProgress.html +2 -2
  176. package/dist/docs/types/OsTag.html +2 -2
  177. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  178. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  179. package/dist/docs/types/PasteContextOptions.html +2 -2
  180. package/dist/docs/types/Permission.html +2 -2
  181. package/dist/docs/types/Point.html +2 -2
  182. package/dist/docs/types/PromptOptions.html +2 -2
  183. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  184. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  185. package/dist/docs/types/Query.html +2 -2
  186. package/dist/docs/types/QueryBatchResult.html +2 -2
  187. package/dist/docs/types/QueryErrorResult.html +2 -2
  188. package/dist/docs/types/QueryExecutor.html +2 -2
  189. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  190. package/dist/docs/types/QueryResponse.html +2 -2
  191. package/dist/docs/types/QueryResult.html +2 -2
  192. package/dist/docs/types/QuerySuccessResult.html +2 -2
  193. package/dist/docs/types/ReactCssProperties.html +2 -2
  194. package/dist/docs/types/ReactNode.html +2 -2
  195. package/dist/docs/types/ReactRef.html +2 -2
  196. package/dist/docs/types/ReasonedBoolean.html +2 -2
  197. package/dist/docs/types/RecordFetchOptions.html +1 -1
  198. package/dist/docs/types/RefCallback.html +2 -2
  199. package/dist/docs/types/RelationshipCountResult.html +2 -2
  200. package/dist/docs/types/RemoteAppApi.html +1 -1
  201. package/dist/docs/types/SaveAsModalProps.html +2 -2
  202. package/dist/docs/types/SaveFileOptions.html +2 -2
  203. package/dist/docs/types/SaveOptions.html +2 -2
  204. package/dist/docs/types/SavedTemplate.html +2 -2
  205. package/dist/docs/types/SearchFilter.html +2 -2
  206. package/dist/docs/types/SemanticBinding.html +2 -2
  207. package/dist/docs/types/SemanticBindingType.html +2 -2
  208. package/dist/docs/types/SemanticBindings.html +2 -2
  209. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  210. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  211. package/dist/docs/types/SendQueryOptions.html +2 -2
  212. package/dist/docs/types/ServiceDefinition.html +2 -2
  213. package/dist/docs/types/ServiceDefinitions.html +2 -2
  214. package/dist/docs/types/ServiceRole.html +2 -2
  215. package/dist/docs/types/SetTransformResultFn.html +1 -1
  216. package/dist/docs/types/ShowOntology.html +2 -2
  217. package/dist/docs/types/ShowTabProps.html +2 -2
  218. package/dist/docs/types/Styler.html +2 -2
  219. package/dist/docs/types/StylerConfig.html +2 -2
  220. package/dist/docs/types/StylerDefinition.html +2 -2
  221. package/dist/docs/types/StylerDefinitions.html +2 -2
  222. package/dist/docs/types/StylerOption.html +2 -2
  223. package/dist/docs/types/StylerProducer.html +2 -2
  224. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  225. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  226. package/dist/docs/types/Tag.html +2 -2
  227. package/dist/docs/types/TagInfo.html +2 -2
  228. package/dist/docs/types/TagWithRelationship.html +2 -2
  229. package/dist/docs/types/TaskCleanupReason.html +2 -2
  230. package/dist/docs/types/TemplateMetadata.html +2 -2
  231. package/dist/docs/types/TemplateType.html +2 -2
  232. package/dist/docs/types/TemplateVariant.html +2 -2
  233. package/dist/docs/types/TransformAction.html +2 -2
  234. package/dist/docs/types/TransformActionContext.html +2 -2
  235. package/dist/docs/types/TransformDefinition.html +2 -2
  236. package/dist/docs/types/TransformDefinitions.html +2 -2
  237. package/dist/docs/types/Unsubscribe.html +2 -2
  238. package/dist/docs/types/UnsubscribeFn.html +1 -1
  239. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  240. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  241. package/dist/docs/types/UserProfile.html +2 -2
  242. package/dist/docs/types/Watcher.html +2 -2
  243. package/dist/docs/types/Whoami.html +2 -2
  244. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  245. package/dist/docs/types/Workspace.html +2 -2
  246. package/dist/docs/types/WorkspaceConfig.html +1 -1
  247. package/dist/docs/types/WorkspaceFlags.html +2 -2
  248. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  249. package/dist/docs/types/WorkspaceItem.html +2 -2
  250. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  251. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  252. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  253. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  254. package/dist/docs/types/WorkspaceItems.html +2 -2
  255. package/dist/docs/types/WorkspacePermission.html +2 -2
  256. package/dist/docs/types/WorkspaceRecord.html +2 -2
  257. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  258. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  259. package/dist/docs/types/WorkspaceRecords.html +2 -2
  260. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  261. package/dist/docs/types/WorkspaceSettings.html +2 -2
  262. package/dist/docs/types/trigger.html +2 -2
  263. package/dist/docs/types/uuid.html +2 -2
  264. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  265. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  266. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  267. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  268. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  269. package/dist/files.d.ts +89 -7
  270. package/dist/files.d.ts.map +1 -1
  271. package/dist/index.d.ts +1 -0
  272. package/dist/index.d.ts.map +1 -1
  273. package/dist/index.js +1 -0
  274. package/dist/index.js.map +1 -1
  275. package/dist/liveContext.d.ts +69 -0
  276. package/dist/liveContext.d.ts.map +1 -0
  277. package/dist/liveContext.js +2 -0
  278. package/dist/liveContext.js.map +1 -0
  279. package/dist/platform-types.d.ts +171 -8
  280. package/package.json +1 -1
  281. package/dist/docs/interfaces/FileListOptions.html +0 -5
package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html CHANGED
@@ -1,2 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OS_CONFIRM_MODAL_YES | @octostar/platform-types - v0.5.23</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.23</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="OS_CONFIRM_MODAL_YES.html">OS_CONFIRM_MODAL_YES</a></li></ul><h1>Variable OS_CONFIRM_MODAL_YES<code class="tsd-tag">Const</code> <code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">OS_<wbr/>CONFIRM_<wbr/>MODAL_<wbr/>YES</span><span class="tsd-signature-symbol"> = true</span></div><div class="tsd-comment tsd-typography"><p>Affirmative option for the confirmation modal.</p>
2
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/7e5bad6692d589244c964ea6a47437e8405e540f/packages/octostar-platform-types/src/desktop.ts#L435">desktop.ts:435</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.23</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OS_CONFIRM_MODAL_YES | @octostar/platform-types - v0.5.25</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.25</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="OS_CONFIRM_MODAL_YES.html">OS_CONFIRM_MODAL_YES</a></li></ul><h1>Variable OS_CONFIRM_MODAL_YES<code class="tsd-tag">Const</code> <code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">OS_<wbr/>CONFIRM_<wbr/>MODAL_<wbr/>YES</span><span class="tsd-signature-symbol"> = true</span></div><div class="tsd-comment tsd-typography"><p>Affirmative option for the confirmation modal.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/6b8f91ba6814a0ba6d5abe80a9ab26e0f9447059/packages/octostar-platform-types/src/desktop.ts#L435">desktop.ts:435</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.25</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_MESSAGE_TYPES | @octostar/platform-types - v0.5.23</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.23</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_MESSAGE_TYPES.html">SAVED_SEARCH_MESSAGE_TYPES</a></li></ul><h1>Variable SAVED_SEARCH_MESSAGE_TYPES<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>MESSAGE_<wbr/>TYPES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getRecords</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecords&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsCount</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsCount&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsCountQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsCountQuery&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsQuery&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getSavedSearchPasteContext</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getSavedSearchPasteContext&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/7e5bad6692d589244c964ea6a47437e8405e540f/packages/octostar-platform-types/src/savedSearch.ts#L135">savedSearch.ts:135</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.23</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_MESSAGE_TYPES | @octostar/platform-types - v0.5.25</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.25</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_MESSAGE_TYPES.html">SAVED_SEARCH_MESSAGE_TYPES</a></li></ul><h1>Variable SAVED_SEARCH_MESSAGE_TYPES<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>MESSAGE_<wbr/>TYPES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getRecords</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecords&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsCount</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsCount&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsCountQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsCountQuery&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRecordsQuery</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getRecordsQuery&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getSavedSearchPasteContext</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;octostar:savedSearch:getSavedSearchPasteContext&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/6b8f91ba6814a0ba6d5abe80a9ab26e0f9447059/packages/octostar-platform-types/src/savedSearch.ts#L135">savedSearch.ts:135</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.25</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/variables/SAVED_SEARCH_PREFIX.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_PREFIX | @octostar/platform-types - v0.5.23</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.23</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_PREFIX.html">SAVED_SEARCH_PREFIX</a></li></ul><h1>Variable SAVED_SEARCH_PREFIX<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>PREFIX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;octostar:savedSearch:&quot;</span><span class="tsd-signature-symbol"> = &#39;octostar:savedSearch:&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/7e5bad6692d589244c964ea6a47437e8405e540f/packages/octostar-platform-types/src/savedSearch.ts#L134">savedSearch.ts:134</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.23</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SAVED_SEARCH_PREFIX | @octostar/platform-types - v0.5.25</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.25</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="SAVED_SEARCH_PREFIX.html">SAVED_SEARCH_PREFIX</a></li></ul><h1>Variable SAVED_SEARCH_PREFIX<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">SAVED_<wbr/>SEARCH_<wbr/>PREFIX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;octostar:savedSearch:&quot;</span><span class="tsd-signature-symbol"> = &#39;octostar:savedSearch:&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/6b8f91ba6814a0ba6d5abe80a9ab26e0f9447059/packages/octostar-platform-types/src/savedSearch.ts#L134">savedSearch.ts:134</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.25</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/files.d.ts CHANGED
@@ -1,16 +1,56 @@
1
- import { WorkspaceItem } from './model';
1
+ import { Entity, WorkspaceItem } from './model';
2
2
  export interface FileListResponse {
3
3
  folders: WorkspaceItem[];
4
4
  files: WorkspaceItem[];
5
5
  total_folders: number;
6
6
  total_files: number;
7
7
  }
8
- export interface FileListOptions {
9
- maxFolders?: number;
10
- maxFiles?: number;
11
- folderOffset?: number;
12
- fileOffset?: number;
8
+ export interface MoveOptions {
9
+ to_path: string;
10
+ force?: boolean;
11
+ redirect?: boolean;
13
12
  }
13
+ export interface MoveResponse extends Entity {
14
+ new_path: string;
15
+ }
16
+ export type MkdirResponse = Entity;
17
+ export interface DeleteResponse {
18
+ tracking_id?: string;
19
+ status_url?: string;
20
+ message?: string;
21
+ }
22
+ export interface DownloadOptions {
23
+ content_type?: string;
24
+ content_disposition?: 'inline' | 'attachment';
25
+ redirect?: boolean;
26
+ }
27
+ export type ListByPath = {
28
+ path: string;
29
+ os_parent_folder?: never;
30
+ };
31
+ export type ListByParentFolder = {
32
+ path?: never;
33
+ os_parent_folder: string;
34
+ };
35
+ export type CommonOptions = {
36
+ max_folders?: number;
37
+ max_files?: number;
38
+ folder_offset?: number;
39
+ file_offset?: number;
40
+ };
41
+ type PathOption = {
42
+ path: string;
43
+ os_parent_folder?: never;
44
+ };
45
+ type ParentFolderOption = {
46
+ path?: never;
47
+ os_parent_folder: string;
48
+ };
49
+ type RootOption = {
50
+ path?: never;
51
+ os_parent_folder?: never;
52
+ };
53
+ export type ListFolderOptions = (PathOption & CommonOptions) | (ParentFolderOption & CommonOptions) | (RootOption & CommonOptions);
14
54
  /**
15
55
  * Files service for interacting with the file system
16
56
  */
@@ -31,6 +71,48 @@ export interface Files {
31
71
  * @param options - Optional parameters for pagination
32
72
  * @returns Object containing arrays of folders and files with pagination info
33
73
  */
34
- list_folder(os_workspace: string, path?: string, options?: FileListOptions): Promise<FileListResponse>;
74
+ list_folder(os_workspace: string, options: ListFolderOptions): Promise<FileListResponse>;
75
+ /**
76
+ * Move a file or folder to a new path
77
+ *
78
+ * @param os_workspace - The workspace ID
79
+ * @param path - The path to move
80
+ * @param options - Optional parameters for the move
81
+ * @returns The moved entity
82
+ */
83
+ move(os_workspace: string, path: string, options: MoveOptions): Promise<MoveResponse>;
84
+ /**
85
+ * Create a new directory
86
+ *
87
+ * @param os_workspace - The workspace ID
88
+ * @param path - The path to create
89
+ * @returns The created entity
90
+ */
91
+ mkdir(os_workspace: string, path: string): Promise<MkdirResponse>;
92
+ /**
93
+ * Delete a file or directory
94
+ *
95
+ * @param os_workspace - The workspace ID
96
+ * @param path - The path to delete
97
+ * @returns The deleted entity
98
+ */
99
+ deleteFile(os_workspace: string, path: string): Promise<DeleteResponse>;
100
+ /**
101
+ * Delete a file or directory recursively
102
+ *
103
+ * @param os_workspace - The workspace ID
104
+ * @param path - The path to delete
105
+ */
106
+ deleteRecursive(os_workspace: string, path: string): Promise<DeleteResponse>;
107
+ /**
108
+ * Get a download URL for a file
109
+ *
110
+ * @param os_workspace - The workspace ID
111
+ * @param path - The path to get the download URL for
112
+ * @param options - Optional parameters for the download
113
+ * @returns The download URL
114
+ */
115
+ getDownloadUrl(os_workspace: string, path: string, options?: DownloadOptions): Promise<string>;
35
116
  }
117
+ export {};
36
118
  //# sourceMappingURL=files.d.ts.map
package/dist/files.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;;OAMG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,WAAW,CACT,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC9B"}
1
+ {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEhD,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AACD,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,CAAC,EAAE,KAAK,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,CAAC,EAAE,KAAK,CAAC;CAC1B,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,gBAAgB,CAAC,EAAE,KAAK,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GACzB,CAAC,UAAU,GAAG,aAAa,CAAC,GAC5B,CAAC,kBAAkB,GAAG,aAAa,CAAC,GACpC,CAAC,UAAU,GAAG,aAAa,CAAC,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;;OAMG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,WAAW,CACT,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;OAOG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAElE;;;;;;OAMG;IACH,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAExE;;;;;OAKG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7E;;;;;;;OAOG;IACH,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB"}
package/dist/index.d.ts CHANGED
@@ -24,4 +24,5 @@ export * from './extras';
24
24
  export * from './remoteApp';
25
25
  export * from './savedSearch';
26
26
  export * from './files';
27
+ export * from './liveContext';
27
28
  //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}
package/dist/index.js CHANGED
@@ -24,4 +24,5 @@ export * from './extras';
24
24
  export * from './remoteApp';
25
25
  export * from './savedSearch';
26
26
  export * from './files';
27
+ export * from './liveContext';
27
28
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}
package/dist/liveContext.d.ts ADDED
@@ -0,0 +1,69 @@
1
+ type LiveContextListener<ContextData extends Record<string, any> = Record<string, any>> = (context: ContextData) => void;
2
+ type LiveContextAPISetParams<ContextData extends Record<string, any> = Record<string, any>> = ContextData | ((currentContext: ContextData) => ContextData);
3
+ type DefaultLiveContextData = Record<string, any>;
4
+ /**
5
+ * @beta
6
+ * Represents a context management interface for handling state across components
7
+ */
8
+ export interface LiveContext<ContextData extends DefaultLiveContextData = DefaultLiveContextData> {
9
+ /**
10
+ * @beta
11
+ * Retrieves the current context data
12
+ * @returns The current context data
13
+ */
14
+ getContext(): ContextData;
15
+ /**
16
+ * @beta
17
+ * Updates the context with new data
18
+ * @param context - New context data or function to update context
19
+ */
20
+ setContext(context: LiveContextAPISetParams<ContextData>): Promise<void>;
21
+ /**
22
+ * @beta
23
+ * Subscribes to context changes with an automatically generated ID
24
+ * @param contextListener - Callback function triggered on context changes
25
+ * @returns Generated subscription ID
26
+ */
27
+ subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
28
+ /**
29
+ * @beta
30
+ * Subscribes to context changes with a custom ID
31
+ * @param id - Custom subscription ID
32
+ * @param contextListener - Callback function triggered on context changes
33
+ * @returns The subscription ID
34
+ */
35
+ subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
36
+ /**
37
+ * @beta
38
+ * Unsubscribes from context changes
39
+ * @param id - Subscription ID to remove
40
+ */
41
+ unsubscribeFromChanges(id: string): void;
42
+ /**
43
+ * @beta
44
+ * Adds a context listener to another Context instance
45
+ * @param contextAPI - The Context instance to connect to
46
+ * @param mapContext - Optional function to transform context data
47
+ * @returns Function to remove the context listener
48
+ */
49
+ addContextListener<ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData): () => void;
50
+ /**
51
+ * @beta
52
+ * Removes a context listener
53
+ * @param idOrContextAPI - ID or Context instance to disconnect from
54
+ */
55
+ removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string): void;
56
+ /**
57
+ * @beta
58
+ * Connects to target window for context synchronization
59
+ * @returns The channel ID used for communication
60
+ */
61
+ connect(): string;
62
+ /**
63
+ * @beta
64
+ * Destroys the context and cleans up all listeners
65
+ */
66
+ destroy(): void;
67
+ }
68
+ export type { LiveContextListener, LiveContextAPISetParams, DefaultLiveContextData };
69
+ //# sourceMappingURL=liveContext.d.ts.map
package/dist/liveContext.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"liveContext.d.ts","sourceRoot":"","sources":["../src/liveContext.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;AAEzH,KAAK,uBAAuB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACtF,WAAW,GACT,CAAC,CAAC,cAAc,EAAE,WAAW,KAAK,WAAW,CAAC,CAAC;AAIrD,KAAK,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAGlD;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,SAAS,sBAAsB,GAAG,sBAAsB;IAC9F;;;;OAIG;IACH,UAAU,IAAI,WAAW,CAAC;IAE1B;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;;;OAKG;IACH,kBAAkB,CAAC,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAE9E;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAE1F;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;;;OAMG;IACH,kBAAkB,CAAC,oBAAoB,SAAS,sBAAsB,EAAE,UAAU,EAAE,WAAW,CAAC,oBAAoB,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,WAAW,GAAG,MAAM,IAAI,CAAC;IAEhM;;;;OAIG;IACH,qBAAqB,CAAC,oBAAoB,SAAS,sBAAsB,EAAE,cAAc,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IAE7I;;;;OAIG;IACH,OAAO,IAAI,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,EACvB,CAAC"}
package/dist/liveContext.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=liveContext.js.map
package/dist/liveContext.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"liveContext.js","sourceRoot":"","sources":["../src/liveContext.ts"],"names":[],"mappings":""}
package/dist/platform-types.d.ts CHANGED
@@ -356,6 +356,13 @@ export declare type CommentWorkspaceItem = WorkspaceItemBase & OsAuditFields & E
356
356
  os_parent_uid?: string;
357
357
  };
358
358
 
359
+ export declare type CommonOptions = {
360
+ max_folders?: number;
361
+ max_files?: number;
362
+ folder_offset?: number;
363
+ file_offset?: number;
364
+ };
365
+
359
366
  /**
360
367
  * @beta
361
368
  * Type representing a comparator for a filter clause in a query object.
@@ -669,6 +676,14 @@ export declare type DataMask = {
669
676
  ownState?: Record<string, any>;
670
677
  };
671
678
 
679
+ export declare type DefaultLiveContextData = Record<string, any>;
680
+
681
+ export declare interface DeleteResponse {
682
+ tracking_id?: string;
683
+ status_url?: string;
684
+ message?: string;
685
+ }
686
+
672
687
  /**
673
688
  * Interface for desktop actions.
674
689
  * @beta
@@ -1215,6 +1230,12 @@ export declare type DesktopStylerContext = {
1215
1230
  selected?: GraphSpec;
1216
1231
  };
1217
1232
 
1233
+ export declare interface DownloadOptions {
1234
+ content_type?: string;
1235
+ content_disposition?: 'inline' | 'attachment';
1236
+ redirect?: boolean;
1237
+ }
1238
+
1218
1239
  /**
1219
1240
  * Represents a draft workspace item.
1220
1241
  * @beta
@@ -1535,13 +1556,6 @@ export declare type FileCode = {
1535
1556
  file: string;
1536
1557
  };
1537
1558
 
1538
- export declare interface FileListOptions {
1539
- maxFolders?: number;
1540
- maxFiles?: number;
1541
- folderOffset?: number;
1542
- fileOffset?: number;
1543
- }
1544
-
1545
1559
  export declare interface FileListResponse {
1546
1560
  folders: WorkspaceItem[];
1547
1561
  files: WorkspaceItem[];
@@ -1569,7 +1583,48 @@ export declare interface Files {
1569
1583
  * @param options - Optional parameters for pagination
1570
1584
  * @returns Object containing arrays of folders and files with pagination info
1571
1585
  */
1572
- list_folder(os_workspace: string, path?: string, options?: FileListOptions): Promise<FileListResponse>;
1586
+ list_folder(os_workspace: string, options: ListFolderOptions): Promise<FileListResponse>;
1587
+ /**
1588
+ * Move a file or folder to a new path
1589
+ *
1590
+ * @param os_workspace - The workspace ID
1591
+ * @param path - The path to move
1592
+ * @param options - Optional parameters for the move
1593
+ * @returns The moved entity
1594
+ */
1595
+ move(os_workspace: string, path: string, options: MoveOptions): Promise<MoveResponse>;
1596
+ /**
1597
+ * Create a new directory
1598
+ *
1599
+ * @param os_workspace - The workspace ID
1600
+ * @param path - The path to create
1601
+ * @returns The created entity
1602
+ */
1603
+ mkdir(os_workspace: string, path: string): Promise<MkdirResponse>;
1604
+ /**
1605
+ * Delete a file or directory
1606
+ *
1607
+ * @param os_workspace - The workspace ID
1608
+ * @param path - The path to delete
1609
+ * @returns The deleted entity
1610
+ */
1611
+ deleteFile(os_workspace: string, path: string): Promise<DeleteResponse>;
1612
+ /**
1613
+ * Delete a file or directory recursively
1614
+ *
1615
+ * @param os_workspace - The workspace ID
1616
+ * @param path - The path to delete
1617
+ */
1618
+ deleteRecursive(os_workspace: string, path: string): Promise<DeleteResponse>;
1619
+ /**
1620
+ * Get a download URL for a file
1621
+ *
1622
+ * @param os_workspace - The workspace ID
1623
+ * @param path - The path to get the download URL for
1624
+ * @param options - Optional parameters for the download
1625
+ * @returns The download URL
1626
+ */
1627
+ getDownloadUrl(os_workspace: string, path: string, options?: DownloadOptions): Promise<string>;
1573
1628
  }
1574
1629
 
1575
1630
  /**
@@ -2012,6 +2067,87 @@ export declare type KnownCounts = {
2012
2067
  [relationship_name: string]: number;
2013
2068
  };
2014
2069
 
2070
+ export declare type ListByParentFolder = {
2071
+ path?: never;
2072
+ os_parent_folder: string;
2073
+ };
2074
+
2075
+ export declare type ListByPath = {
2076
+ path: string;
2077
+ os_parent_folder?: never;
2078
+ };
2079
+
2080
+ export declare type ListFolderOptions = (PathOption & CommonOptions) | (ParentFolderOption & CommonOptions) | (RootOption & CommonOptions);
2081
+
2082
+ /**
2083
+ * @beta
2084
+ * Represents a context management interface for handling state across components
2085
+ */
2086
+ export declare interface LiveContext<ContextData extends DefaultLiveContextData = DefaultLiveContextData> {
2087
+ /**
2088
+ * @beta
2089
+ * Retrieves the current context data
2090
+ * @returns The current context data
2091
+ */
2092
+ getContext(): ContextData;
2093
+ /**
2094
+ * @beta
2095
+ * Updates the context with new data
2096
+ * @param context - New context data or function to update context
2097
+ */
2098
+ setContext(context: LiveContextAPISetParams<ContextData>): Promise<void>;
2099
+ /**
2100
+ * @beta
2101
+ * Subscribes to context changes with an automatically generated ID
2102
+ * @param contextListener - Callback function triggered on context changes
2103
+ * @returns Generated subscription ID
2104
+ */
2105
+ subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
2106
+ /**
2107
+ * @beta
2108
+ * Subscribes to context changes with a custom ID
2109
+ * @param id - Custom subscription ID
2110
+ * @param contextListener - Callback function triggered on context changes
2111
+ * @returns The subscription ID
2112
+ */
2113
+ subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
2114
+ /**
2115
+ * @beta
2116
+ * Unsubscribes from context changes
2117
+ * @param id - Subscription ID to remove
2118
+ */
2119
+ unsubscribeFromChanges(id: string): void;
2120
+ /**
2121
+ * @beta
2122
+ * Adds a context listener to another Context instance
2123
+ * @param contextAPI - The Context instance to connect to
2124
+ * @param mapContext - Optional function to transform context data
2125
+ * @returns Function to remove the context listener
2126
+ */
2127
+ addContextListener<ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData): () => void;
2128
+ /**
2129
+ * @beta
2130
+ * Removes a context listener
2131
+ * @param idOrContextAPI - ID or Context instance to disconnect from
2132
+ */
2133
+ removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string): void;
2134
+ /**
2135
+ * @beta
2136
+ * Connects to target window for context synchronization
2137
+ * @returns The channel ID used for communication
2138
+ */
2139
+ connect(): string;
2140
+ /**
2141
+ * @beta
2142
+ * Destroys the context and cleans up all listeners
2143
+ */
2144
+ destroy(): void;
2145
+ }
2146
+
2147
+ export declare type LiveContextAPISetParams<ContextData extends Record<string, any> = Record<string, any>> = ContextData | ((currentContext: ContextData) => ContextData);
2148
+
2149
+ export declare type LiveContextListener<ContextData extends Record<string, any> = Record<string, any>> = (context: ContextData) => void;
2150
+
2015
2151
  export declare type ManifestSecrets = {
2016
2152
  [key: string]: {
2017
2153
  description: string;
@@ -2020,6 +2156,8 @@ export declare type ManifestSecrets = {
2020
2156
  };
2021
2157
  };
2022
2158
 
2159
+ export declare type MkdirResponse = Entity;
2160
+
2023
2161
  /**
2024
2162
  * @beta
2025
2163
  * Type representing the properties for a modal template, extending CustomTemplateIframeProps.
@@ -2042,6 +2180,16 @@ export declare type ModalTemplateProps = CustomTemplateIframeProps & {
2042
2180
  taskID?: string;
2043
2181
  };
2044
2182
 
2183
+ export declare interface MoveOptions {
2184
+ to_path: string;
2185
+ force?: boolean;
2186
+ redirect?: boolean;
2187
+ }
2188
+
2189
+ export declare interface MoveResponse extends Entity {
2190
+ new_path: string;
2191
+ }
2192
+
2045
2193
  /**
2046
2194
  * Represents a named group (set?) entities.
2047
2195
  * @beta
@@ -2477,6 +2625,11 @@ export declare type OsWorkspacePickerProps = {
2477
2625
  }[];
2478
2626
  };
2479
2627
 
2628
+ declare type ParentFolderOption = {
2629
+ path?: never;
2630
+ os_parent_folder: string;
2631
+ };
2632
+
2480
2633
  /**
2481
2634
  * Options for pasting context.
2482
2635
  * @beta
@@ -2508,6 +2661,11 @@ export declare type PasteContextOptions = {
2508
2661
  preferSavedSet?: boolean;
2509
2662
  };
2510
2663
 
2664
+ declare type PathOption = {
2665
+ path: string;
2666
+ os_parent_folder?: never;
2667
+ };
2668
+
2511
2669
  /**
2512
2670
  * @beta
2513
2671
  * Type representing a permission for a workspace item.
@@ -2905,6 +3063,11 @@ export declare type RemoteAppApi = {
2905
3063
  setTransformResult: SetTransformResultFn;
2906
3064
  };
2907
3065
 
3066
+ declare type RootOption = {
3067
+ path?: never;
3068
+ os_parent_folder?: never;
3069
+ };
3070
+
2908
3071
  /**
2909
3072
  * Properties for saving as modal.
2910
3073
  * @beta
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@octostar/platform-types",
3
- "version": "0.5.23",
3
+ "version": "0.5.25",
4
4
  "description": "Types for the API exposed by Octostar platform to third parties",
5
5
  "keywords": [
6
6
  "octostar",