@octostar/platform-types 0.5.35 → 0.5.37

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 +15 -16
  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 +106 -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 -3
  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/InlineCode.html +2 -2
  166. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  167. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  168. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  169. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  170. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  171. package/dist/docs/types/JavascriptType.html +2 -2
  172. package/dist/docs/types/JobManifest.html +2 -2
  173. package/dist/docs/types/KnownCounts.html +2 -2
  174. package/dist/docs/types/ListByParentFolder.html +1 -1
  175. package/dist/docs/types/ListByPath.html +1 -1
  176. package/dist/docs/types/ListFolderOptions.html +1 -1
  177. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  178. package/dist/docs/types/LiveContextListener.html +1 -1
  179. package/dist/docs/types/ManifestSecrets.html +1 -1
  180. package/dist/docs/types/MkdirResponse.html +1 -1
  181. package/dist/docs/types/ModalTemplateProps.html +2 -2
  182. package/dist/docs/types/NamedEntityGroup.html +2 -2
  183. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  184. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  185. package/dist/docs/types/NunjucksType.html +2 -2
  186. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  187. package/dist/docs/types/OntologyTags.html +2 -2
  188. package/dist/docs/types/OsAuditFields.html +2 -2
  189. package/dist/docs/types/OsConfirmProps.html +2 -2
  190. package/dist/docs/types/OsNotification.html +2 -2
  191. package/dist/docs/types/OsProgress.html +2 -2
  192. package/dist/docs/types/OsTag.html +2 -2
  193. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  194. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  195. package/dist/docs/types/PasteContextOptions.html +2 -2
  196. package/dist/docs/types/Permission.html +2 -2
  197. package/dist/docs/types/Point.html +2 -2
  198. package/dist/docs/types/PromptOptions.html +2 -2
  199. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  200. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  201. package/dist/docs/types/Query.html +2 -2
  202. package/dist/docs/types/QueryBatchResult.html +2 -2
  203. package/dist/docs/types/QueryErrorResult.html +2 -2
  204. package/dist/docs/types/QueryExecutor.html +2 -2
  205. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  206. package/dist/docs/types/QueryResponse.html +2 -2
  207. package/dist/docs/types/QueryResult.html +2 -2
  208. package/dist/docs/types/QuerySuccessResult.html +2 -2
  209. package/dist/docs/types/ReactCssProperties.html +2 -2
  210. package/dist/docs/types/ReactNode.html +2 -2
  211. package/dist/docs/types/ReactRef.html +2 -2
  212. package/dist/docs/types/ReasonedBoolean.html +2 -2
  213. package/dist/docs/types/RecordFetchOptions.html +1 -1
  214. package/dist/docs/types/RefCallback.html +2 -2
  215. package/dist/docs/types/RelationshipCountResult.html +2 -2
  216. package/dist/docs/types/RemoteAppApi.html +1 -1
  217. package/dist/docs/types/RenameTabProps.html +2 -2
  218. package/dist/docs/types/SaveAsModalProps.html +2 -2
  219. package/dist/docs/types/SaveFileOptions.html +2 -2
  220. package/dist/docs/types/SaveOptions.html +2 -2
  221. package/dist/docs/types/SavedTemplate.html +2 -2
  222. package/dist/docs/types/SearchFilter.html +2 -2
  223. package/dist/docs/types/SemanticBinding.html +2 -2
  224. package/dist/docs/types/SemanticBindingType.html +2 -2
  225. package/dist/docs/types/SemanticBindings.html +2 -2
  226. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  227. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  228. package/dist/docs/types/SendQueryOptions.html +2 -2
  229. package/dist/docs/types/ServiceDefinition.html +2 -2
  230. package/dist/docs/types/ServiceDefinitions.html +2 -2
  231. package/dist/docs/types/ServiceRole.html +2 -2
  232. package/dist/docs/types/SetTransformResultFn.html +1 -1
  233. package/dist/docs/types/SetsOptions.html +2 -2
  234. package/dist/docs/types/ShowOntology.html +2 -2
  235. package/dist/docs/types/ShowTabProps.html +2 -2
  236. package/dist/docs/types/Styler.html +2 -2
  237. package/dist/docs/types/StylerConfig.html +2 -2
  238. package/dist/docs/types/StylerDefinition.html +2 -2
  239. package/dist/docs/types/StylerDefinitions.html +2 -2
  240. package/dist/docs/types/StylerOption.html +2 -2
  241. package/dist/docs/types/StylerProducer.html +2 -2
  242. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  243. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  244. package/dist/docs/types/Tag.html +2 -2
  245. package/dist/docs/types/TagInfo.html +2 -2
  246. package/dist/docs/types/TagWithRelationship.html +2 -2
  247. package/dist/docs/types/TaskCleanupReason.html +2 -2
  248. package/dist/docs/types/TemplateMetadata.html +2 -2
  249. package/dist/docs/types/TemplateType.html +2 -2
  250. package/dist/docs/types/TemplateVariant.html +2 -2
  251. package/dist/docs/types/TransformAction.html +2 -2
  252. package/dist/docs/types/TransformActionContext.html +2 -2
  253. package/dist/docs/types/TransformDefinition.html +2 -2
  254. package/dist/docs/types/TransformDefinitions.html +2 -2
  255. package/dist/docs/types/Unsubscribe.html +2 -2
  256. package/dist/docs/types/UnsubscribeFn.html +1 -1
  257. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  258. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  259. package/dist/docs/types/UserProfile.html +2 -2
  260. package/dist/docs/types/VirtualEntity.html +2 -2
  261. package/dist/docs/types/Watcher.html +2 -2
  262. package/dist/docs/types/Whoami.html +2 -2
  263. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  264. package/dist/docs/types/Workspace.html +2 -2
  265. package/dist/docs/types/WorkspaceConfig.html +2 -2
  266. package/dist/docs/types/WorkspaceFlags.html +2 -2
  267. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  268. package/dist/docs/types/WorkspaceItem.html +2 -2
  269. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  270. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  271. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  272. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  273. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  274. package/dist/docs/types/WorkspaceItems.html +2 -2
  275. package/dist/docs/types/WorkspacePermission.html +2 -2
  276. package/dist/docs/types/WorkspaceRecord.html +2 -2
  277. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  278. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  279. package/dist/docs/types/WorkspaceRecords.html +2 -2
  280. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  281. package/dist/docs/types/WorkspaceSettings.html +2 -2
  282. package/dist/docs/types/trigger.html +2 -2
  283. package/dist/docs/types/uuid.html +2 -2
  284. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  285. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  286. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  287. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  288. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  289. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  290. package/dist/platform-types.d.ts +15 -16
  291. package/package.json +1 -1
  292. package/dist/docs/types/ImportZipOptions.html +0 -6
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.35</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.35</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/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/savedSearch.ts#L124">savedSearch.ts:124</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.35</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.37</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.37</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="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/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L124">savedSearch.ts:124</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.37</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/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.35</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.35</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/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/savedSearch.ts#L123">savedSearch.ts:123</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.35</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.37</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.37</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="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/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/savedSearch.ts#L123">savedSearch.ts:123</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.37</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/platform-types.d.ts CHANGED
@@ -904,13 +904,12 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
904
904
  */
905
905
  saveFile: (item: WorkspaceItem, file: File | string, options?: SaveOptions) => Promise<WorkspaceItem>;
906
906
  /**
907
- * Imports items.
907
+ * Imports folders/files from a ZIP file using the v1 API.
908
+ * Use this for importing folders and files (not workspaces).
908
909
  */
909
- import: (items: any[]) => Promise<void>;
910
- /**
911
- * Imports a ZIP file with optional import options.
912
- */
913
- importZip: (file: File, options?: ImportZipOptions) => Promise<void>;
910
+ importFolders: (file: File, options: ImportFoldersOptions) => Promise<{
911
+ tracking_id: string;
912
+ }>;
914
913
  /**
915
914
  * Exports an item or items with optional export options.
916
915
  */
@@ -1078,6 +1077,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
1078
1077
  * Gets information about the current user.
1079
1078
  */
1080
1079
  whoami: () => Promise<Whoami>;
1080
+ /**
1081
+ * Pings the desktop to check connectivity. Used for remote dev mode connection verification.
1082
+ */
1083
+ ping: () => Promise<void>;
1081
1084
  /**
1082
1085
  * Gets the focus list.
1083
1086
  */
@@ -2122,26 +2125,22 @@ export declare type ImageInfo = {
2122
2125
  };
2123
2126
 
2124
2127
  /**
2125
- * Options for importing ZIP files.
2128
+ * Options for importing folders/files from a ZIP file.
2126
2129
  * @beta
2127
2130
  */
2128
- export declare type ImportZipOptions = {
2131
+ export declare type ImportFoldersOptions = {
2129
2132
  /**
2130
- * Whether to overwrite existing items.
2133
+ * Target folder or workspace for the import.
2131
2134
  */
2132
- overwrite?: boolean;
2135
+ target: string;
2133
2136
  /**
2134
- * Target location for the import.
2137
+ * Whether to overwrite existing items.
2135
2138
  */
2136
- target?: string;
2139
+ overwrite?: boolean;
2137
2140
  /**
2138
2141
  * Whether to include content in the import.
2139
2142
  */
2140
2143
  include_content?: boolean;
2141
- /**
2142
- * Whether to include dashboards in the import.
2143
- */
2144
- include_dashboards?: boolean | 'if_missing';
2145
2144
  };
2146
2145
 
2147
2146
  export declare interface IndexSearchHitSource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@octostar/platform-types",
3
- "version": "0.5.35",
3
+ "version": "0.5.37",
4
4
  "description": "Types for the API exposed by Octostar platform to third parties",
5
5
  "keywords": [
6
6
  "octostar",
package/dist/docs/types/ImportZipOptions.html DELETED
@@ -1,6 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImportZipOptions | @octostar/platform-types - v0.5.35</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.35</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="ImportZipOptions.html">ImportZipOptions</a></li></ul><h1>Type Alias ImportZipOptions<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Import<wbr/>Zip<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">include_content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">include_dashboards</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;if_missing&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">overwrite</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">target</span><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><div class="tsd-comment tsd-typography"><p>Options for importing ZIP files.</p>
2
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">include_<wbr/>content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to include content in the import.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">include_<wbr/>dashboards</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;if_missing&quot;</span></h5><div class="tsd-comment tsd-typography"><p>Whether to include dashboards in the import.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">overwrite</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to overwrite existing items.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">target</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Target location for the import.</p>
6
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/41227f5f32a3ee9b1be75202fc3ee7039e4781d8/packages/octostar-platform-types/src/desktop.ts#L784">desktop.ts:784</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.35</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>