@octostar/platform-types 0.5.37 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (466) hide show
  1. package/dist/action.d.ts +6 -6
  2. package/dist/action.d.ts.map +1 -1
  3. package/dist/ai.d.ts +7 -6
  4. package/dist/ai.d.ts.map +1 -1
  5. package/dist/desktop.d.ts +380 -204
  6. package/dist/desktop.d.ts.map +1 -1
  7. package/dist/desktop.js.map +1 -1
  8. package/dist/docs/assets/highlight.css +14 -14
  9. package/dist/docs/assets/navigation.js +1 -1
  10. package/dist/docs/assets/search.js +1 -1
  11. package/dist/docs/enums/ProcessingStatusCode.html +5 -27
  12. package/dist/docs/enums/SortOrder.html +3 -3
  13. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  14. package/dist/docs/functions/imageLabelCandidateAggs.html +5 -0
  15. package/dist/docs/functions/imageLabelCandidateSize.html +3 -0
  16. package/dist/docs/functions/imageLabelCountAggs.html +2 -0
  17. package/dist/docs/functions/imageLabelFamilyOfField.html +2 -0
  18. package/dist/docs/functions/imageLabelMatchClause.html +3 -0
  19. package/dist/docs/functions/imageLabelSourceIncludes.html +2 -0
  20. package/dist/docs/functions/isDefaultTemplate.html +3 -0
  21. package/dist/docs/functions/isDeletedEntity.html +2 -0
  22. package/dist/docs/functions/isWorkspaceFileItem.html +1 -1
  23. package/dist/docs/functions/isWorkspaceRoot.html +2 -0
  24. package/dist/docs/functions/ontologyLabel-1.html +4 -0
  25. package/dist/docs/functions/readImageLabelCandidates.html +2 -0
  26. package/dist/docs/functions/readImageLabelCounts.html +2 -0
  27. package/dist/docs/hierarchy.html +1 -1
  28. package/dist/docs/index.html +2 -3
  29. package/dist/docs/interfaces/AIClient.html +4 -4
  30. package/dist/docs/interfaces/ActionContext.html +4 -5
  31. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  32. package/dist/docs/interfaces/BrowseEntry.html +7 -0
  33. package/dist/docs/interfaces/BrowseRequest.html +4 -0
  34. package/dist/docs/interfaces/BrowseResponse.html +5 -0
  35. package/dist/docs/interfaces/ChatMessage.html +6 -6
  36. package/dist/docs/interfaces/Colorful.html +3 -3
  37. package/dist/docs/interfaces/Concept.html +14 -14
  38. package/dist/docs/interfaces/DeleteResponse.html +2 -2
  39. package/dist/docs/interfaces/Desktop.html +199 -122
  40. package/dist/docs/interfaces/DesktopActionContext.html +7 -8
  41. package/dist/docs/interfaces/DesktopSettings.html +6 -6
  42. package/dist/docs/interfaces/DeveloperSettings.html +3 -5
  43. package/dist/docs/interfaces/DownloadOptions.html +2 -2
  44. package/dist/docs/interfaces/EntityUiState.html +2 -2
  45. package/dist/docs/interfaces/FetchOptions.html +4 -4
  46. package/dist/docs/interfaces/FileListResponse.html +2 -2
  47. package/dist/docs/interfaces/FilesAPIClient.html +48 -24
  48. package/dist/docs/interfaces/FragmentRegion.html +6 -0
  49. package/dist/docs/interfaces/FragmentStatusEntry.html +13 -0
  50. package/dist/docs/interfaces/GeocodingResult.html +9 -0
  51. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  52. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  53. package/dist/docs/interfaces/ImageLabelCandidateOptions.html +4 -0
  54. package/dist/docs/interfaces/ImageLabelFamilyFields.html +13 -0
  55. package/dist/docs/interfaces/ImportDestination.html +3 -0
  56. package/dist/docs/interfaces/ImportItem.html +3 -0
  57. package/dist/docs/interfaces/ImportOptions.html +8 -0
  58. package/dist/docs/interfaces/ImportRequest.html +7 -0
  59. package/dist/docs/interfaces/IndexSearchHitSource.html +5 -3
  60. package/dist/docs/interfaces/Inheritance.html +5 -5
  61. package/dist/docs/interfaces/LiveContext.html +11 -11
  62. package/dist/docs/interfaces/MountAccess.html +3 -0
  63. package/dist/docs/interfaces/MountCreate.html +10 -0
  64. package/dist/docs/interfaces/MountGrantCreate.html +3 -0
  65. package/dist/docs/interfaces/MountGrantResponse.html +7 -0
  66. package/dist/docs/interfaces/MountImportCopyResponse.html +4 -0
  67. package/dist/docs/interfaces/MountImportLinkError.html +4 -0
  68. package/dist/docs/interfaces/MountImportLinkResponse.html +5 -0
  69. package/dist/docs/interfaces/MountResponse.html +20 -0
  70. package/dist/docs/interfaces/MountUpdate.html +13 -0
  71. package/dist/docs/interfaces/MoveOptions.html +2 -2
  72. package/dist/docs/interfaces/MoveResponse.html +58 -37
  73. package/dist/docs/interfaces/Ontology.html +110 -53
  74. package/dist/docs/interfaces/OntologyLabel.html +6 -0
  75. package/dist/docs/interfaces/OsAPIClient.html +8 -8
  76. package/dist/docs/interfaces/PeekSourceOptions.html +4 -0
  77. package/dist/docs/interfaces/PerUserCredentialInput.html +5 -0
  78. package/dist/docs/interfaces/PerUserCredentialStatus.html +7 -0
  79. package/dist/docs/interfaces/ProcessingRecursiveStatus.html +27 -0
  80. package/dist/docs/interfaces/ProcessingStatus.html +40 -9
  81. package/dist/docs/interfaces/Property.html +7 -5
  82. package/dist/docs/interfaces/RecordProvider.html +6 -6
  83. package/dist/docs/interfaces/RecordsSourceScope.html +8 -0
  84. package/dist/docs/interfaces/RefObject.html +3 -3
  85. package/dist/docs/interfaces/Relationship.html +22 -20
  86. package/dist/docs/interfaces/ReportApi.html +13 -0
  87. package/dist/docs/interfaces/S3Headers.html +2 -2
  88. package/dist/docs/interfaces/S3UploadResponse.html +2 -2
  89. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  90. package/dist/docs/interfaces/SearchFilter.html +29 -0
  91. package/dist/docs/interfaces/SearchHit.html +11 -0
  92. package/dist/docs/interfaces/SearchInnerHit.html +3 -0
  93. package/dist/docs/interfaces/SearchOptions.html +21 -4
  94. package/dist/docs/interfaces/SearchProps.html +11 -10
  95. package/dist/docs/interfaces/SearchQueryResult.html +5 -0
  96. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  97. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  98. package/dist/docs/interfaces/SemanticBindingOptions.html +8 -0
  99. package/dist/docs/interfaces/SemanticBindingProps.html +8 -6
  100. package/dist/docs/interfaces/SharedCredentialsInput.html +5 -0
  101. package/dist/docs/interfaces/SourceExportError.html +4 -0
  102. package/dist/docs/interfaces/SourceExportRequest.html +8 -0
  103. package/dist/docs/interfaces/SourceExportResponse.html +7 -0
  104. package/dist/docs/interfaces/SourcePeekEntry.html +12 -0
  105. package/dist/docs/interfaces/SourcePeekResponse.html +10 -0
  106. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  107. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  108. package/dist/docs/interfaces/SubscribeOptions.html +4 -0
  109. package/dist/docs/interfaces/TagAttributes.html +7 -7
  110. package/dist/docs/interfaces/TestConnectionRequest.html +12 -0
  111. package/dist/docs/interfaces/TestConnectionResponse.html +4 -0
  112. package/dist/docs/interfaces/UiStateManager.html +2 -2
  113. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  114. package/dist/docs/interfaces/UnzipOptions.html +2 -2
  115. package/dist/docs/interfaces/UploadFromUrlError.html +8 -0
  116. package/dist/docs/interfaces/UploadFromUrlRequest.html +6 -0
  117. package/dist/docs/interfaces/UploadFromUrlResponse.html +6 -0
  118. package/dist/docs/interfaces/UploadOptions.html +2 -2
  119. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +7 -7
  120. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  121. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  122. package/dist/docs/modules.html +106 -38
  123. package/dist/docs/types/ActionHandler.html +2 -2
  124. package/dist/docs/types/AddCommentParams.html +2 -2
  125. package/dist/docs/types/AddListener.html +2 -2
  126. package/dist/docs/types/AddToReportBlocksInput.html +6 -0
  127. package/dist/docs/types/AddToReportContentSelection.html +2 -0
  128. package/dist/docs/types/AddToReportEntityInput.html +5 -0
  129. package/dist/docs/types/AddToReportInput.html +2 -0
  130. package/dist/docs/types/AddToReportResult.html +2 -0
  131. package/dist/docs/types/ApiErrorResult.html +2 -2
  132. package/dist/docs/types/ApiResult.html +2 -2
  133. package/dist/docs/types/ApiSuccessResult.html +2 -2
  134. package/dist/docs/types/App.html +2 -2
  135. package/dist/docs/types/AppRegistry.html +3 -4
  136. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  137. package/dist/docs/types/AppServiceCallProps.html +2 -2
  138. package/dist/docs/types/AsyncFilter.html +2 -2
  139. package/dist/docs/types/AttachmentResponseType.html +2 -2
  140. package/dist/docs/types/AttachmentType.html +2 -2
  141. package/dist/docs/types/BinaryOperator.html +2 -2
  142. package/dist/docs/types/BrowseKind.html +1 -0
  143. package/dist/docs/types/Callback.html +2 -2
  144. package/dist/docs/types/ChatApiResponse.html +1 -1
  145. package/dist/docs/types/ChatModel.html +2 -2
  146. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  147. package/dist/docs/types/CommonOptions.html +1 -1
  148. package/dist/docs/types/Comparator.html +2 -2
  149. package/dist/docs/types/ConceptFilter.html +3 -3
  150. package/dist/docs/types/ConceptMap.html +2 -2
  151. package/dist/docs/types/ConceptName.html +1 -1
  152. package/dist/docs/types/ConceptWithParents.html +2 -2
  153. package/dist/docs/types/ConnectedEntity.html +2 -2
  154. package/dist/docs/types/ContextMenuGroup.html +2 -2
  155. package/dist/docs/types/ContextMenuLabels.html +2 -2
  156. package/dist/docs/types/ContextMenuOptions.html +2 -2
  157. package/dist/docs/types/ContextMenuParams.html +2 -2
  158. package/dist/docs/types/ContextMenuRequest.html +2 -2
  159. package/dist/docs/types/CopyOptions.html +2 -2
  160. package/dist/docs/types/CreateEntityFormProps.html +4 -2
  161. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  162. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  163. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  164. package/dist/docs/types/CredType.html +1 -0
  165. package/dist/docs/types/CredentialMode.html +1 -0
  166. package/dist/docs/types/CustomEventListener.html +2 -2
  167. package/dist/docs/types/CustomTemplate.html +9 -3
  168. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  169. package/dist/docs/types/DataContextType.html +2 -2
  170. package/dist/docs/types/DefaultLiveContextData.html +1 -1
  171. package/dist/docs/types/DefaultTemplate.html +11 -0
  172. package/dist/docs/types/DefaultTemplateProps.html +5 -0
  173. package/dist/docs/types/DeletedEntity.html +3 -0
  174. package/dist/docs/types/DesktopAction.html +2 -2
  175. package/dist/docs/types/DesktopActionFilter.html +2 -2
  176. package/dist/docs/types/DesktopActionMenuItem.html +6 -2
  177. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  178. package/dist/docs/types/DesktopActionOptions.html +17 -3
  179. package/dist/docs/types/DesktopOpenParams.html +2 -2
  180. package/dist/docs/types/DragEndParams.html +2 -2
  181. package/dist/docs/types/DragStartParams.html +2 -2
  182. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  183. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  184. package/dist/docs/types/EConnection.html +2 -2
  185. package/dist/docs/types/EdgeSpec.html +2 -2
  186. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  187. package/dist/docs/types/Entity.html +2 -2
  188. package/dist/docs/types/EntityBase.html +2 -2
  189. package/dist/docs/types/EntityEdge.html +2 -2
  190. package/dist/docs/types/EntityOTM.html +2 -2
  191. package/dist/docs/types/EntityPasteContext.html +2 -2
  192. package/dist/docs/types/EntityRelationshipCount.html +4 -0
  193. package/dist/docs/types/EvalContext.html +1 -1
  194. package/dist/docs/types/EventContextType.html +2 -2
  195. package/dist/docs/types/EventEmitterType.html +2 -2
  196. package/dist/docs/types/EventName.html +2 -2
  197. package/dist/docs/types/EventProducer.html +2 -2
  198. package/dist/docs/types/EventPublisher.html +2 -2
  199. package/dist/docs/types/EventSubscriber.html +2 -2
  200. package/dist/docs/types/EventUnsubscriber.html +2 -2
  201. package/dist/docs/types/ExportOptions.html +2 -2
  202. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  203. package/dist/docs/types/ExtrasApi.html +1 -1
  204. package/dist/docs/types/FetchEntityOptions.html +2 -2
  205. package/dist/docs/types/FileCode.html +2 -2
  206. package/dist/docs/types/FileTreeOptions.html +2 -2
  207. package/dist/docs/types/FilterDefinition.html +2 -2
  208. package/dist/docs/types/FilterDefinitions.html +2 -2
  209. package/dist/docs/types/FilterName.html +2 -2
  210. package/dist/docs/types/FilterQuery.html +2 -2
  211. package/dist/docs/types/FilterReference.html +2 -2
  212. package/dist/docs/types/FilterValue.html +2 -2
  213. package/dist/docs/types/FocusListItem.html +2 -2
  214. package/dist/docs/types/FragmentInfo.html +5 -0
  215. package/dist/docs/types/FragmentLocator.html +5 -0
  216. package/dist/docs/types/FragmentResolution.html +2 -0
  217. package/dist/docs/types/GetSystemSettingResponse.html +4 -1
  218. package/dist/docs/types/GraphDataSpec.html +1 -1
  219. package/dist/docs/types/GraphSpec.html +2 -2
  220. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  221. package/dist/docs/types/Icon.html +2 -2
  222. package/dist/docs/types/IconProps.html +2 -2
  223. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  224. package/dist/docs/types/ImageInfo.html +2 -2
  225. package/dist/docs/types/ImageLabelFamily.html +21 -0
  226. package/dist/docs/types/ImportConflictPolicy.html +1 -0
  227. package/dist/docs/types/ImportEntryKind.html +1 -0
  228. package/dist/docs/types/ImportFoldersOptions.html +2 -2
  229. package/dist/docs/types/ImportMode.html +1 -0
  230. package/dist/docs/types/InlineCode.html +2 -2
  231. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  232. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  233. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  234. package/dist/docs/types/JavascriptType.html +3 -3
  235. package/dist/docs/types/JobManifest.html +4 -4
  236. package/dist/docs/types/KnownCounts.html +2 -2
  237. package/dist/docs/types/ListByParentFolder.html +1 -1
  238. package/dist/docs/types/ListByPath.html +1 -1
  239. package/dist/docs/types/ListFolderOptions.html +1 -1
  240. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  241. package/dist/docs/types/LiveContextListener.html +1 -1
  242. package/dist/docs/types/ManifestSecrets.html +1 -1
  243. package/dist/docs/types/MapSettingKey.html +1 -0
  244. package/dist/docs/types/MkdirResponse.html +1 -1
  245. package/dist/docs/types/ModalTemplateProps.html +2 -2
  246. package/dist/docs/types/MountScheme.html +7 -0
  247. package/dist/docs/types/NamedEntityGroup.html +2 -2
  248. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  249. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  250. package/dist/docs/types/NunjucksType.html +3 -3
  251. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  252. package/dist/docs/types/OntologyTags.html +2 -2
  253. package/dist/docs/types/OpenNewAIChatOptions.html +17 -0
  254. package/dist/docs/types/OpenReportSummary.html +6 -0
  255. package/dist/docs/types/OsAuditFields.html +2 -2
  256. package/dist/docs/types/OsConfirmProps.html +2 -2
  257. package/dist/docs/types/OsNotification.html +2 -2
  258. package/dist/docs/types/OsProgress.html +11 -3
  259. package/dist/docs/types/OsTag.html +2 -2
  260. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  261. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  262. package/dist/docs/types/PeekSourceTarget.html +4 -0
  263. package/dist/docs/types/Permission.html +2 -2
  264. package/dist/docs/types/Point.html +2 -2
  265. package/dist/docs/types/PrincipalType.html +1 -0
  266. package/dist/docs/types/PromptOptions.html +6 -3
  267. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  268. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  269. package/dist/docs/types/Query.html +2 -2
  270. package/dist/docs/types/QueryBatchResult.html +2 -2
  271. package/dist/docs/types/QueryDslQueryContainer.html +6 -0
  272. package/dist/docs/types/QueryErrorResult.html +2 -2
  273. package/dist/docs/types/QueryExecutor.html +2 -2
  274. package/dist/docs/types/QueryFilesystemItemsParams.html +16 -0
  275. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  276. package/dist/docs/types/QueryResponse.html +2 -2
  277. package/dist/docs/types/QueryResult.html +2 -2
  278. package/dist/docs/types/QuerySuccessResult.html +2 -2
  279. package/dist/docs/types/ReactCssProperties.html +2 -2
  280. package/dist/docs/types/ReactNode.html +2 -2
  281. package/dist/docs/types/ReactRef.html +2 -2
  282. package/dist/docs/types/ReasonedBoolean.html +2 -2
  283. package/dist/docs/types/RefCallback.html +2 -2
  284. package/dist/docs/types/RegisteredActionInfo.html +21 -0
  285. package/dist/docs/types/RelationshipCountEntry.html +8 -0
  286. package/dist/docs/types/RelationshipCountResult.html +2 -2
  287. package/dist/docs/types/RelationshipCountState.html +2 -0
  288. package/dist/docs/types/RemoteAppApi.html +1 -1
  289. package/dist/docs/types/RenameTabProps.html +2 -2
  290. package/dist/docs/types/RenderableTemplate.html +11 -0
  291. package/dist/docs/types/ReportTiptapNode.html +4 -0
  292. package/dist/docs/types/RuntimeAppUrlEntity.html +5 -0
  293. package/dist/docs/types/RuntimeAppUrlWorkspaceItem.html +10 -0
  294. package/dist/docs/types/SaveAsModalProps.html +2 -2
  295. package/dist/docs/types/SaveFileOptions.html +2 -2
  296. package/dist/docs/types/SaveOptions.html +2 -3
  297. package/dist/docs/types/SavedTemplate.html +3 -4
  298. package/dist/docs/types/SearchScope.html +9 -0
  299. package/dist/docs/types/SemanticBinding.html +2 -2
  300. package/dist/docs/types/SemanticBindingSpec.html +3 -0
  301. package/dist/docs/types/SemanticBindingType.html +2 -2
  302. package/dist/docs/types/SemanticBindings.html +3 -2
  303. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  304. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  305. package/dist/docs/types/SendQueryOptions.html +2 -2
  306. package/dist/docs/types/ServiceDefinition.html +2 -2
  307. package/dist/docs/types/ServiceDefinitions.html +2 -2
  308. package/dist/docs/types/ServiceRole.html +2 -2
  309. package/dist/docs/types/SetTransformResultFn.html +1 -1
  310. package/dist/docs/types/SetsOptions.html +7 -16
  311. package/dist/docs/types/SetsSortBy.html +1 -0
  312. package/dist/docs/types/ShowOntology.html +2 -2
  313. package/dist/docs/types/ShowTabProps.html +2 -2
  314. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  315. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  316. package/dist/docs/types/Tag.html +2 -2
  317. package/dist/docs/types/TagInfo.html +2 -2
  318. package/dist/docs/types/TagWithRelationship.html +2 -2
  319. package/dist/docs/types/TaskCleanupReason.html +2 -2
  320. package/dist/docs/types/TemplateMetadata.html +3 -3
  321. package/dist/docs/types/TemplateType.html +2 -2
  322. package/dist/docs/types/TemplateVariant.html +2 -2
  323. package/dist/docs/types/TestOutcome.html +2 -0
  324. package/dist/docs/types/TransformAction.html +2 -2
  325. package/dist/docs/types/TransformActionContext.html +2 -2
  326. package/dist/docs/types/TransformDefinition.html +2 -2
  327. package/dist/docs/types/TransformDefinitions.html +2 -2
  328. package/dist/docs/types/Unsubscribe.html +2 -2
  329. package/dist/docs/types/UnsubscribeFn.html +1 -1
  330. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  331. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  332. package/dist/docs/types/UploadFromUrlErrorCode.html +4 -0
  333. package/dist/docs/types/UserProfile.html +2 -2
  334. package/dist/docs/types/VirtualEntity.html +2 -2
  335. package/dist/docs/types/Whoami.html +3 -3
  336. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  337. package/dist/docs/types/WorkspaceConfig.html +5 -3
  338. package/dist/docs/types/WorkspaceFlags.html +2 -2
  339. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  340. package/dist/docs/types/WorkspaceItem.html +21 -2
  341. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  342. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  343. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  344. package/dist/docs/types/WorkspaceItemModel.html +4 -12
  345. package/dist/docs/types/WorkspaceItemTitleProps.html +3 -3
  346. package/dist/docs/types/WorkspacePermission.html +2 -2
  347. package/dist/docs/types/WorkspaceRecord.html +2 -2
  348. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  349. package/dist/docs/types/WorkspaceRelationship.html +3 -2
  350. package/dist/docs/types/WorkspaceSettings.html +2 -2
  351. package/dist/docs/types/trigger.html +2 -2
  352. package/dist/docs/types/uuid.html +2 -2
  353. package/dist/docs/variables/HEAVY_ANNOTATION_FIELDS.html +17 -0
  354. package/dist/docs/variables/IMAGE_LABEL_FAMILIES.html +1 -0
  355. package/dist/docs/variables/IMAGE_LABEL_FIELDS.html +1 -0
  356. package/dist/docs/variables/IMAGE_LABEL_SOURCE_INCLUDES.html +2 -0
  357. package/dist/docs/variables/MAP_SETTINGS_KEYS.html +9 -0
  358. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  359. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  360. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  361. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  362. package/dist/docs/variables/VECTOR_SENTINEL_LABELS.html +4 -0
  363. package/dist/extras.d.ts +0 -1
  364. package/dist/extras.d.ts.map +1 -1
  365. package/dist/files.d.ts +141 -1
  366. package/dist/files.d.ts.map +1 -1
  367. package/dist/files.js.map +1 -1
  368. package/dist/fragmentLocator.d.ts +31 -0
  369. package/dist/fragmentLocator.d.ts.map +1 -0
  370. package/dist/fragmentLocator.js +2 -0
  371. package/dist/fragmentLocator.js.map +1 -0
  372. package/dist/imageLabels.d.ts +84 -0
  373. package/dist/imageLabels.d.ts.map +1 -0
  374. package/dist/imageLabels.js +148 -0
  375. package/dist/imageLabels.js.map +1 -0
  376. package/dist/index.d.ts +6 -3
  377. package/dist/index.d.ts.map +1 -1
  378. package/dist/index.js +6 -3
  379. package/dist/index.js.map +1 -1
  380. package/dist/indexSearch.d.ts +18 -0
  381. package/dist/indexSearch.d.ts.map +1 -1
  382. package/dist/jobManifestTypes.d.ts +5 -25
  383. package/dist/jobManifestTypes.d.ts.map +1 -1
  384. package/dist/mapSettings.d.ts +17 -0
  385. package/dist/mapSettings.d.ts.map +1 -0
  386. package/dist/mapSettings.js +16 -0
  387. package/dist/mapSettings.js.map +1 -0
  388. package/dist/model.d.ts +215 -71
  389. package/dist/model.d.ts.map +1 -1
  390. package/dist/model.js +44 -25
  391. package/dist/model.js.map +1 -1
  392. package/dist/mounts.d.ts +184 -0
  393. package/dist/mounts.d.ts.map +1 -0
  394. package/dist/mounts.js +11 -0
  395. package/dist/mounts.js.map +1 -0
  396. package/dist/ontology.d.ts +148 -8
  397. package/dist/ontology.d.ts.map +1 -1
  398. package/dist/platform-types.d.ts +1692 -663
  399. package/dist/report.d.ts +112 -0
  400. package/dist/report.d.ts.map +1 -0
  401. package/dist/report.js +2 -0
  402. package/dist/report.js.map +1 -0
  403. package/dist/savedSet.d.ts +5 -0
  404. package/dist/savedSet.d.ts.map +1 -0
  405. package/dist/savedSet.js +2 -0
  406. package/dist/savedSet.js.map +1 -0
  407. package/dist/search.d.ts +140 -3
  408. package/dist/search.d.ts.map +1 -1
  409. package/dist/search.js +32 -1
  410. package/dist/search.js.map +1 -1
  411. package/dist/semantic.d.ts +24 -5
  412. package/dist/semantic.d.ts.map +1 -1
  413. package/dist/templates.d.ts +63 -5
  414. package/dist/templates.d.ts.map +1 -1
  415. package/dist/templates.js +8 -1
  416. package/dist/templates.js.map +1 -1
  417. package/dist/workspace.d.ts +25 -41
  418. package/dist/workspace.d.ts.map +1 -1
  419. package/dist/workspace.js.map +1 -1
  420. package/package.json +6 -20
  421. package/dist/behaviour.d.ts +0 -45
  422. package/dist/behaviour.d.ts.map +0 -1
  423. package/dist/behaviour.js +0 -14
  424. package/dist/behaviour.js.map +0 -1
  425. package/dist/docs/interfaces/ChartDataResponseResult.html +0 -20
  426. package/dist/docs/interfaces/NativeFilterColumn.html +0 -3
  427. package/dist/docs/interfaces/NativeFilterScope.html +0 -3
  428. package/dist/docs/interfaces/NativeFilterTarget.html +0 -3
  429. package/dist/docs/interfaces/RecordData.html +0 -20
  430. package/dist/docs/interfaces/SavedDatasource.html +0 -7
  431. package/dist/docs/interfaces/SavedSearchAPIInterface.html +0 -6
  432. package/dist/docs/interfaces/SavedSearchContent.html +0 -7
  433. package/dist/docs/interfaces/StylerContext.html +0 -21
  434. package/dist/docs/types/Behaviour.html +0 -17
  435. package/dist/docs/types/DataMask.html +0 -1
  436. package/dist/docs/types/DesktopStylerContext.html +0 -4
  437. package/dist/docs/types/DraftWorkspaceItem.html +0 -3
  438. package/dist/docs/types/Filter.html +0 -1
  439. package/dist/docs/types/FilterState.html +0 -1
  440. package/dist/docs/types/FolderPasteOptions.html +0 -5
  441. package/dist/docs/types/JavascriptFileStylerDefinition.html +0 -2
  442. package/dist/docs/types/JavascriptInlineStylerDefinition.html +0 -2
  443. package/dist/docs/types/PasteContextOptions.html +0 -8
  444. package/dist/docs/types/RecordFetchOptions.html +0 -1
  445. package/dist/docs/types/SearchFilter.html +0 -2
  446. package/dist/docs/types/Styler.html +0 -19
  447. package/dist/docs/types/StylerConfig.html +0 -6
  448. package/dist/docs/types/StylerDefinition.html +0 -2
  449. package/dist/docs/types/StylerDefinitions.html +0 -2
  450. package/dist/docs/types/StylerOption.html +0 -4
  451. package/dist/docs/types/StylerProducer.html +0 -4
  452. package/dist/docs/types/Watcher.html +0 -11
  453. package/dist/docs/types/Workspace.html +0 -8
  454. package/dist/docs/types/WorkspaceItems.html +0 -2
  455. package/dist/docs/types/WorkspaceRecordInfo.html +0 -6
  456. package/dist/docs/types/WorkspaceRecords.html +0 -2
  457. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +0 -1
  458. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +0 -1
  459. package/dist/savedSearch.d.ts +0 -128
  460. package/dist/savedSearch.d.ts.map +0 -1
  461. package/dist/savedSearch.js +0 -16
  462. package/dist/savedSearch.js.map +0 -1
  463. package/dist/styling.d.ts +0 -100
  464. package/dist/styling.d.ts.map +0 -1
  465. package/dist/styling.js +0 -2
  466. package/dist/styling.js.map +0 -1
@@ -0,0 +1,112 @@
1
+ import type { Entity, WorkspaceItem } from './model';
2
+ /**
3
+ * @beta
4
+ * A report (.odoc) that is open in the app (Composer tab and/or sidebar).
5
+ */
6
+ export type OpenReportSummary = {
7
+ /** Workspace item entity uid */
8
+ os_entity_uid: string;
9
+ /** Display title (without .odoc when applicable) */
10
+ displayName: string;
11
+ /** Timestamp when the report was last updated, if known */
12
+ os_last_updated_at?: string;
13
+ surface: 'tab' | 'sidebar';
14
+ /** True when this is the document selected in the Composer sidebar */
15
+ isSidebarSelected?: boolean;
16
+ };
17
+ /**
18
+ * @beta
19
+ * Checkbox payload for "Add to report" content.
20
+ */
21
+ export type AddToReportContentSelection = {
22
+ coreData: boolean;
23
+ mainPicture: boolean;
24
+ allPictures: boolean;
25
+ relatedLinks: boolean;
26
+ };
27
+ /**
28
+ * @beta
29
+ * Minimal TipTap/ProseMirror JSON node shape used by the report append APIs.
30
+ *
31
+ * This intentionally mirrors the recursive JSON structure without depending on TipTap packages
32
+ * from the public platform-types package.
33
+ */
34
+ export type ReportTiptapNode = {
35
+ type?: string;
36
+ attrs?: Record<string, unknown>;
37
+ text?: string;
38
+ marks?: {
39
+ type: string;
40
+ attrs?: Record<string, unknown>;
41
+ }[];
42
+ content?: ReportTiptapNode[];
43
+ };
44
+ type AddToReportBaseInput = {
45
+ /** Optional: preselect a target report when the flow opens */
46
+ initialTargetUid?: string;
47
+ /** Optional: require a live in-memory insert target instead of silently appending to disk */
48
+ requireLiveInsert?: boolean;
49
+ };
50
+ /**
51
+ * @beta
52
+ * Entity-driven "Add to report" payload. The host app will build report blocks from the entity plus
53
+ * the usual checkbox selection.
54
+ */
55
+ export type AddToReportEntityInput = AddToReportBaseInput & {
56
+ mode?: 'entity';
57
+ /** Entity to snapshot into the report */
58
+ sourceEntity: Entity;
59
+ /** Optional: override default checkbox state */
60
+ initialSelection?: Partial<AddToReportContentSelection>;
61
+ };
62
+ /**
63
+ * @beta
64
+ * Arbitrary-content "Add to report" payload. The host app shows the same target-picker UI, but
65
+ * appends the supplied TipTap JSON blocks directly instead of building them from an entity.
66
+ */
67
+ export type AddToReportBlocksInput = AddToReportBaseInput & {
68
+ mode: 'blocks';
69
+ /** Arbitrary TipTap JSON blocks to append directly into the target report */
70
+ blocks: ReportTiptapNode[];
71
+ /** Optional: short label shown in the flow and suggested report name */
72
+ sourceLabel?: string;
73
+ /** Optional: explanatory text shown in the flow instead of the entity checkbox section */
74
+ sourceDescription?: string;
75
+ };
76
+ /**
77
+ * @beta
78
+ * Input for {@link ReportApi.presentAddToReportFlow}.
79
+ */
80
+ export type AddToReportInput = AddToReportEntityInput | AddToReportBlocksInput;
81
+ /**
82
+ * @beta
83
+ * Result after a successful append.
84
+ */
85
+ export type AddToReportResult = {
86
+ targetOdocUid: string;
87
+ targetDisplayName: string;
88
+ };
89
+ /**
90
+ * @beta
91
+ * Report / Composer integration API (Octostar app).
92
+ */
93
+ export interface ReportApi {
94
+ /**
95
+ * Lists .odoc reports that are currently open (tabs and/or Composer sidebar), with metadata.
96
+ */
97
+ getOpenReportSummaries: () => Promise<OpenReportSummary[]>;
98
+ /**
99
+ * Lists .odoc files in open workspaces (same discovery as Composer empty state).
100
+ */
101
+ listWorkspaceReports: () => Promise<WorkspaceItem[]>;
102
+ /**
103
+ * Opens the shared "Add to report" modal.
104
+ *
105
+ * Supported payload modes:
106
+ * - `entity`/default: pick target, choose the usual checkboxes, and append a snapshot of an entity.
107
+ * - `blocks`: pick target, then append arbitrary TipTap JSON blocks directly.
108
+ */
109
+ presentAddToReportFlow: (input: AddToReportInput) => Promise<AddToReportResult | void>;
110
+ }
111
+ export {};
112
+ //# sourceMappingURL=report.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACjC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6FAA6F;IAC7F,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,gBAAgB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;CACzD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,6EAA6E;IAC7E,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,sBAAsB,EAAE,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE3D;;OAEG;IACH,oBAAoB,EAAE,MAAM,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,sBAAsB,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;CACxF"}
package/dist/report.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=report.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export interface SavedSetContent {
2
+ lastFiredQuery: string;
3
+ uiState: Record<string, unknown>;
4
+ }
5
+ //# sourceMappingURL=savedSet.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"savedSet.d.ts","sourceRoot":"","sources":["../src/savedSet.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=savedSet.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"savedSet.js","sourceRoot":"","sources":["../src/savedSet.ts"],"names":[],"mappings":""}
package/dist/search.d.ts CHANGED
@@ -1,5 +1,13 @@
1
- import { type QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
2
1
  import { type Entity, type WorkspaceItem } from './model';
2
+ /**
3
+ * @beta
4
+ * An opaque Elasticsearch query-DSL fragment. Previously imported from
5
+ * `@elastic/elasticsearch`, but that type is an `any`-sea and pulling the whole
6
+ * ES client (with its OpenTelemetry/undici transitive advisories) into the dev
7
+ * tree to type a single field wasn't worth it — consumers treat `query`
8
+ * opaquely (see content-browser queryComposition.ts / createEmbeddingFilter.ts).
9
+ */
10
+ export type QueryDslQueryContainer = Record<string, unknown>;
3
11
  /**
4
12
  * @beta
5
13
  * Interface representing the properties for the SearchXperience component.
@@ -37,12 +45,41 @@ export interface SearchXperienceModalProps extends SearchXperienceProps {
37
45
  * @beta
38
46
  * Type representing the search filter.
39
47
  */
40
- export type SearchFilter = {
48
+ export interface SearchFilter {
41
49
  label?: string;
42
50
  entity?: Entity;
43
51
  query?: QueryDslQueryContainer;
44
52
  imageUrl?: string;
45
- };
53
+ /**
54
+ * Optional long-form descriptor for this filter. Chips in the UI use
55
+ * the short `label` on their face and surface `tooltip` in a hover
56
+ * tooltip — useful when the label alone is ambiguous (for example a
57
+ * "Folder: Reports" chip whose `tooltip` disambiguates to the full
58
+ * breadcrumb "WorkspaceName / Projects / 2025 / Reports").
59
+ */
60
+ tooltip?: string;
61
+ /**
62
+ * Optional classification of how this filter participates in the final
63
+ * Elasticsearch query. Filters tagged `'scope'` (i.e. those produced by
64
+ * "Open with the Search Engine" or by dropping items onto search-app) are
65
+ * combined with OR (`bool.should`); other kinds combine with AND
66
+ * (`bool.must`). When omitted, the filter behaves as a `bool.must` clause
67
+ * for backwards compatibility.
68
+ */
69
+ kind?: 'scope' | 'concept' | 'text' | 'image';
70
+ /**
71
+ * When `true`, this filter is a **hard browsing scope** that must survive a
72
+ * facet's self-exclusion: it represents the universe the user opened into
73
+ * (e.g. the "Files" or "Records" section they launched the Search Engine
74
+ * from), not a pivotable facet pick. Normally an AND-combined (`'concept'`)
75
+ * filter whose query references a facet's own field is dropped from that
76
+ * facet's bucket counts so the user can pivot between sibling values; a
77
+ * pinned scope is kept regardless, so the by-type facet stays constrained to
78
+ * the section you opened. No effect on OR-combined (`'scope'`) filters, which
79
+ * already survive self-exclusion. Defaults to unpinned.
80
+ */
81
+ pinned?: boolean;
82
+ }
46
83
  /**
47
84
  * @beta
48
85
  * Interface representing the properties for the Search component.
@@ -64,6 +101,7 @@ export interface SearchProps {
64
101
  * the default image to use for the search.
65
102
  */
66
103
  image?: WorkspaceItem;
104
+ selectMode?: 'single' | 'multi';
67
105
  /**
68
106
  * disable ask AI
69
107
  */
@@ -81,6 +119,15 @@ export interface SearchProps {
81
119
  */
82
120
  searchInfoDescription?: React.ReactNode;
83
121
  }
122
+ /**
123
+ * @beta
124
+ * Represents the result of a query-mode search: the raw Elasticsearch query
125
+ * plus the total number of matching documents.
126
+ */
127
+ export interface SearchQueryResult {
128
+ query: Record<string, unknown>;
129
+ numberOfResults: number;
130
+ }
84
131
  /**
85
132
  * @beta
86
133
  * Interface representing the options given to search
@@ -91,5 +138,95 @@ export interface SearchOptions {
91
138
  */
92
139
  limit?: number;
93
140
  workspace_ids?: string[];
141
+ /** Cheaper than listing everywhere-else; neither grants access. */
142
+ exclude_workspace_ids?: string[];
143
+ /**
144
+ * Entity types to exclude.
145
+ */
146
+ exclude_entity_types?: string[];
147
+ /**
148
+ * Narrow to these types. {@link limit} is applied on `_score` alone, so without
149
+ * this a broad term spends the whole result set on types the caller discards.
150
+ */
151
+ entity_types?: string[];
152
+ /**
153
+ * Look up these entities by uid, with an empty query. Treat an absent one as
154
+ * "ask again".
155
+ */
156
+ os_entity_uids?: string[];
157
+ /**
158
+ * How wide to match. See {@link SearchScope}.
159
+ */
160
+ scope?: SearchScope;
161
+ /**
162
+ * Override the response shape. The default ships every field except the heavy
163
+ * annotation blobs (extracted text, chunks, NER arrays), which is what a hit
164
+ * list needs; pass this only when a caller genuinely wants something narrower
165
+ * or one of the excluded keys.
166
+ */
167
+ source?: {
168
+ includes?: string[];
169
+ excludes?: string[];
170
+ };
94
171
  }
172
+ /**
173
+ * How wide a text search matches — THE declaration; every other scope type
174
+ * derives from it (`FinderSearchScope` adds an `'off'` rung on top).
175
+ *
176
+ * `names` is a filter-a-list surface: the name only, and also *inside* it
177
+ * (`atch` → `match.pdf`), which the analyzed tiers cannot do — a hit whose
178
+ * text mentions the term but whose name does not reads as wrong there.
179
+ * `names+contents` is the full relevance ladder, extracted text included.
180
+ *
181
+ * One value rather than two flags: they were only ever set together, and a
182
+ * caller asking for substring matching without names-only meant nothing.
183
+ */
184
+ export type SearchScope = 'names' | 'names+contents';
185
+ export interface SearchInnerHit {
186
+ _score?: number | null;
187
+ _source?: Record<string, unknown>;
188
+ }
189
+ /**
190
+ * One raw engine hit, the subset of the ES/OpenSearch hit shape Octostar
191
+ * reads. Lives here — not in a UI package — because both the Content
192
+ * Browser and the app's search layer consume the same hits; the UI
193
+ * package re-exports it for back-compat.
194
+ */
195
+ export interface SearchHit {
196
+ _id: string;
197
+ _index?: string;
198
+ _score?: number;
199
+ _source: Record<string, unknown>;
200
+ highlight?: Record<string, string[]>;
201
+ inner_hits?: Record<string, {
202
+ hits: {
203
+ total?: {
204
+ value: number;
205
+ relation: 'eq' | 'gte';
206
+ } | number;
207
+ hits: SearchInnerHit[];
208
+ };
209
+ }>;
210
+ }
211
+ /**
212
+ * Annotation keys never worth shipping with a hit list: `rag:fulltext` and
213
+ * `rag:chunks` carry every document's extracted text (a 200-hit search shipped
214
+ * ~10 MB of it to draw a list of names), `ner:entities` is a long array nothing
215
+ * renders, and the heavy `materialized` children are the detection copies with
216
+ * their vectors and the NER and geo rollups. The small
217
+ * `materialized.image:labels*` arrays ride along: they are how a card learns
218
+ * that a document holds a flagged image on one of its pages.
219
+ *
220
+ * An exclude list rather than an allowlist, deliberately: the small card-shaped
221
+ * annotations (`summary:txt`, `image:annotations-*`) have to ride along, and a
222
+ * field nobody thought of must arrive rather than vanish. Exported so any caller
223
+ * that shapes its own `_source` trims the same things — two lists would drift,
224
+ * and the drift shows up as a blank cell nobody can explain.
225
+ *
226
+ * Lives here with the rest of the wire contract — not in a UI package, and not
227
+ * in platform-api (whose barrel several test suites blanket-mock; a constant
228
+ * read at module scope must survive that). The Content Browser re-exports it
229
+ * for back-compat.
230
+ */
231
+ export declare const HEAVY_ANNOTATION_FIELDS: readonly string[];
95
232
  //# sourceMappingURL=search.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;IAC9C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,UAAU,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,mEAAmE;IACnE,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;;;;OAKG;IACH,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACvD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,gBAAgB,CAAC;AAErD,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN;QAAE,IAAI,EAAE;YAAE,KAAK,CAAC,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,IAAI,GAAG,KAAK,CAAA;aAAE,GAAG,MAAM,CAAC;YAAC,IAAI,EAAE,cAAc,EAAE,CAAA;SAAE,CAAA;KAAE,CACjG,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,MAAM,EAWpD,CAAC"}
package/dist/search.js CHANGED
@@ -1,2 +1,33 @@
1
- export {};
1
+ /**
2
+ * Annotation keys never worth shipping with a hit list: `rag:fulltext` and
3
+ * `rag:chunks` carry every document's extracted text (a 200-hit search shipped
4
+ * ~10 MB of it to draw a list of names), `ner:entities` is a long array nothing
5
+ * renders, and the heavy `materialized` children are the detection copies with
6
+ * their vectors and the NER and geo rollups. The small
7
+ * `materialized.image:labels*` arrays ride along: they are how a card learns
8
+ * that a document holds a flagged image on one of its pages.
9
+ *
10
+ * An exclude list rather than an allowlist, deliberately: the small card-shaped
11
+ * annotations (`summary:txt`, `image:annotations-*`) have to ride along, and a
12
+ * field nobody thought of must arrive rather than vanish. Exported so any caller
13
+ * that shapes its own `_source` trims the same things — two lists would drift,
14
+ * and the drift shows up as a blank cell nobody can explain.
15
+ *
16
+ * Lives here with the rest of the wire contract — not in a UI package, and not
17
+ * in platform-api (whose barrel several test suites blanket-mock; a constant
18
+ * read at module scope must survive that). The Content Browser re-exports it
19
+ * for back-compat.
20
+ */
21
+ export const HEAVY_ANNOTATION_FIELDS = [
22
+ 'annotations.rag:fulltext',
23
+ 'annotations.rag:chunks',
24
+ 'annotations.extract:metadata',
25
+ 'annotations.extract:src',
26
+ 'annotations.extract:txtLang',
27
+ 'annotations.ner:entities',
28
+ 'annotations.materialized.image:annotations*',
29
+ 'annotations.materialized.ner:*',
30
+ 'annotations.materialized.exif:*',
31
+ 'annotations.extract:txt',
32
+ ];
2
33
  //# sourceMappingURL=search.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAkNA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAsB;IACxD,0BAA0B;IAC1B,wBAAwB;IACxB,8BAA8B;IAC9B,yBAAyB;IACzB,6BAA6B;IAC7B,0BAA0B;IAC1B,6CAA6C;IAC7C,gCAAgC;IAChC,iCAAiC;IACjC,yBAAyB;CAC1B,CAAC"}
@@ -1,4 +1,4 @@
1
- import { ConceptName } from './model';
1
+ import { type ConceptName } from './model';
2
2
  /**
3
3
  * @beta
4
4
  * Type representing the properties for a template binding.
@@ -10,6 +10,8 @@ export interface SemanticBindingProps {
10
10
  priority?: number;
11
11
  /** Whether the result should be shown in large mode by default */
12
12
  maximized?: boolean;
13
+ /** Sift-compatible query evaluated against the entity. When present, the binding only matches if the filter passes. */
14
+ filter?: Record<string, any>;
13
15
  /** Other properties */
14
16
  [key: string]: any;
15
17
  }
@@ -32,9 +34,26 @@ export type SemanticBinding = {
32
34
  };
33
35
  /**
34
36
  * @beta
35
- * Type representing multiple semantic bindings.
37
+ * Options of one concept in an app manifest's `semantic_bindings`.
36
38
  */
37
- export type SemanticBindings = {
38
- [k in SemanticBindingType]: (ConceptName | SemanticBinding)[];
39
- };
39
+ export interface SemanticBindingOptions {
40
+ /** Order among the bindings for an entity. Lower comes first. */
41
+ priority?: number;
42
+ /** `record_viewer` only: open the tab full screen. */
43
+ maximized?: boolean;
44
+ /** Sift-compatible query evaluated against the entity. The binding applies only when it matches. */
45
+ filter?: Record<string, unknown>;
46
+ }
47
+ /**
48
+ * @beta
49
+ * The bindings of one role: a concept name, a list of concept names and one-key maps of concept to options,
50
+ * or a map of concept to options.
51
+ */
52
+ export type SemanticBindingSpec = ConceptName | (ConceptName | Record<ConceptName, SemanticBindingOptions | null>)[] | Record<ConceptName, SemanticBindingOptions | null>;
53
+ /**
54
+ * @beta
55
+ * An app manifest's `semantic_bindings`: the bindings per role. The platform reads `opener`
56
+ * (a double-click on a matching entity opens the app) and `record_viewer` (the app is a Record Viewer tab).
57
+ */
58
+ export type SemanticBindings = Partial<Record<SemanticBindingType, SemanticBindingSpec>>;
40
59
  //# sourceMappingURL=semantic.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"semantic.d.ts","sourceRoot":"","sources":["../src/semantic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uBAAuB;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,MAAM,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,+CAA+C;IAC/C,OAAO,EAAE,WAAW,CAAC;IACrB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,oCAAoC;IACpC,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAC5B,CAAC,IAAI,mBAAmB,GAAG,CAAC,WAAW,GAAG,eAAe,CAAC,EAAE;CAC9D,CAAC"}
1
+ {"version":3,"file":"semantic.d.ts","sourceRoot":"","sources":["../src/semantic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uHAAuH;IACvH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,uBAAuB;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,MAAM,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,+CAA+C;IAC/C,OAAO,EAAE,WAAW,CAAC;IACrB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,oCAAoC;IACpC,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,sBAAsB,GAAG,IAAI,CAAC,CAAC,EAAE,GACpE,MAAM,CAAC,WAAW,EAAE,sBAAsB,GAAG,IAAI,CAAC,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,CAAC"}
@@ -1,6 +1,7 @@
1
1
  import { type ModalProps } from 'antd';
2
- import { type ReactCssProperties } from './react-types';
2
+ import { type ReactCssProperties, type ReactNode } from './react-types';
3
3
  import { type SemanticBinding } from './semantic';
4
+ import { type WorkspaceItem } from './model';
4
5
  /**
5
6
  * @beta
6
7
  * Type representing the possible template types.
@@ -38,18 +39,27 @@ export type TemplateMetadata = {
38
39
  style?: ReactCssProperties;
39
40
  /** Whether the template renders multiple records. */
40
41
  rendersMultipleRecords?: boolean;
41
- /** Whether the template is an app. */
42
- isApp?: boolean;
43
42
  /** details for semantic bindings. These can be app-specific */
44
43
  bindings?: SemanticBinding[];
44
+ /** Optional CSS injected when the template renders. */
45
+ css_content?: string;
45
46
  };
46
47
  /**
47
48
  * @beta
48
49
  * Type representing a custom template, extending TemplateMetadata.
50
+ *
51
+ * `os_entity_uid` and `os_workspace` are optional here so an in-memory
52
+ * template built via `newCustomTemplate()` can still flow through
53
+ * `RenderableTemplate`-typed code paths. `SavedTemplate` narrows both
54
+ * to required strings.
49
55
  */
50
56
  export type CustomTemplate = TemplateMetadata & {
51
57
  /** The template content. */
52
58
  template: string;
59
+ /** Set once the template is persisted as a workspace item. */
60
+ os_entity_uid?: string;
61
+ /** Set once the template is persisted as a workspace item. */
62
+ os_workspace?: string;
53
63
  };
54
64
  /**
55
65
  * @beta
@@ -60,9 +70,57 @@ export type SavedTemplate = CustomTemplate & {
60
70
  os_entity_uid: string;
61
71
  /** The workspace to which the template belongs. */
62
72
  os_workspace: string;
63
- /** The CSS content of the template. */
64
- css_content?: string;
65
73
  };
74
+ /**
75
+ * @beta
76
+ * Props passed to a code-resident default template's React component.
77
+ */
78
+ export type DefaultTemplateProps = {
79
+ /** The record this template is rendering for, if any. */
80
+ record?: WorkspaceItem;
81
+ /** The same context object passed to react-live templates. */
82
+ context?: any;
83
+ /** Optional extra scope variables forwarded from `<OsTemplate extraScope>`. */
84
+ extraScope?: Record<string, unknown>;
85
+ };
86
+ /**
87
+ * @beta
88
+ * A code-resident default template. Carries the same metadata as a
89
+ * `SavedTemplate` so it can flow through the existing template lookup
90
+ * pipeline, but renders via a real React component rather than a
91
+ * `react-live` string.
92
+ *
93
+ * Defaults always have `os_workspace === ''` — that's the marker
94
+ * `isDefaultTemplate` looks for and disambiguates them from workspace
95
+ * templates whose `os_workspace` is always a real UUID.
96
+ */
97
+ export type DefaultTemplate = TemplateMetadata & {
98
+ /** Synthetic identifier, e.g. `default-template-PersonInfo`. */
99
+ os_entity_uid: string;
100
+ /** Empty string marks this as a code-resident default. */
101
+ os_workspace: '';
102
+ /** The React component that renders this template. */
103
+ component: (props: DefaultTemplateProps) => ReactNode;
104
+ };
105
+ /**
106
+ * @beta
107
+ * Union of every shape a template lookup may return:
108
+ * - workspace-stored `SavedTemplate` (rendered via `react-live`),
109
+ * - code-resident `DefaultTemplate` (rendered as a real React component),
110
+ * - in-memory `CustomTemplate` produced by `newCustomTemplate()` before
111
+ * it has been persisted.
112
+ *
113
+ * `SavedTemplate ⊂ CustomTemplate`, so this is structurally equivalent
114
+ * to `CustomTemplate | DefaultTemplate`; the explicit list is kept for
115
+ * readability.
116
+ */
117
+ export type RenderableTemplate = SavedTemplate | DefaultTemplate | CustomTemplate;
118
+ /**
119
+ * @beta
120
+ * Type guard distinguishing code-resident default templates from
121
+ * workspace-stored ones.
122
+ */
123
+ export declare function isDefaultTemplate(t: RenderableTemplate | undefined | null): t is DefaultTemplate;
66
124
  /**
67
125
  * @beta
68
126
  * Type representing the properties for a custom template iframe.
@@ -1 +1 @@
1
- {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,4CAA4C;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,4CAA4C;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,yDAAyD;IACzD,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAC/C,gEAAgE;IAChE,aAAa,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,YAAY,EAAE,EAAE,CAAC;IACjB,sDAAsD;IACtD,SAAS,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,SAAS,CAAC;CACvD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG,eAAe,GAAG,cAAc,CAAC;AAElF;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,GAAG,CAAC,IAAI,eAAe,CAIhG;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
package/dist/templates.js CHANGED
@@ -1,2 +1,9 @@
1
- export {};
1
+ /**
2
+ * @beta
3
+ * Type guard distinguishing code-resident default templates from
4
+ * workspace-stored ones.
5
+ */
6
+ export function isDefaultTemplate(t) {
7
+ return (Boolean(t) && t.os_workspace === '' && typeof t.component === 'function');
8
+ }
2
9
  //# sourceMappingURL=templates.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AA8HA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,CAAwC;IACxE,OAAO,CACL,OAAO,CAAC,CAAC,CAAC,IAAK,CAAqB,CAAC,YAAY,KAAK,EAAE,IAAI,OAAQ,CAAqB,CAAC,SAAS,KAAK,UAAU,CACnH,CAAC;AACJ,CAAC"}
@@ -1,5 +1,27 @@
1
1
  import type { AddListener, Callback, Unsubscribe } from './callback';
2
- import type { Entity, OsTag, WorkspaceItem, WorkspaceItems, WorkspaceRelationship } from './model';
2
+ import type { Entity, OsTag, WorkspaceItem, WorkspaceRelationship } from './model';
3
+ /**
4
+ * A `WorkspaceItem` carrying the app's resolved iframe URL on the runtime-only
5
+ * `#appUrl` field.
6
+ *
7
+ * IMPORTANT: `#appUrl` is **runtime-only and never persisted**. It is hydrated
8
+ * in-memory from the K8s apps API (e.g. by `DesktopAPI.getApp` /
9
+ * `hydrateWithK8sState`) and is **stripped on any JSON round-trip** — notably
10
+ * the flexlayout tab-config serialization. Never read `#appUrl` off an item
11
+ * that was restored or deserialized; resolve the live URL via
12
+ * `useAppDeploymentState` instead. `os_item_content.app_url` no longer carries
13
+ * the URL — it is gone.
14
+ */
15
+ export type RuntimeAppUrlWorkspaceItem = WorkspaceItem & {
16
+ '#appUrl'?: string;
17
+ };
18
+ /** {@link RuntimeAppUrlWorkspaceItem} for the raw `Entity` shape (e.g. the
19
+ * synthetic iframe-transform items built in the job services). Same
20
+ * runtime-only `#appUrl` contract — never persisted, never read off a
21
+ * restored item. */
22
+ export type RuntimeAppUrlEntity = Entity & {
23
+ '#appUrl'?: string;
24
+ };
3
25
  /**
4
26
  * @beta
5
27
  * Type representing information about a tag.
@@ -69,44 +91,6 @@ export type WorkspaceFlags = {
69
91
  autoOpen?: boolean;
70
92
  isHidden?: boolean;
71
93
  };
72
- /**
73
- * @beta
74
- * Type representing information about records in a workspace.
75
- */
76
- export type WorkspaceRecordInfo = {
77
- /** The concept associated with the records. */
78
- concept: string;
79
- /** The count of records. */
80
- count: number;
81
- /** The last updated timestamp for the records. */
82
- max_last_updated: string;
83
- /** The entities associated with the records. */
84
- entities: Entity[];
85
- };
86
- /**
87
- * @beta
88
- * Type representing a collection of workspace records.
89
- */
90
- export type WorkspaceRecords = Record<string, WorkspaceRecordInfo>;
91
- /**
92
- * @beta
93
- * Type representing a workspace.
94
- */
95
- export type Workspace = {
96
- /** The workspace item. */
97
- workspace: WorkspaceItem;
98
- /** The items in the workspace. */
99
- items: WorkspaceItems;
100
- /** Optional records in the workspace. */
101
- workspace_records?: WorkspaceRecords;
102
- /** Optional tags in the workspace. */
103
- tags?: TagInfo[];
104
- /** Optional permission for the workspace. */
105
- permission?: WorkspacePermission;
106
- /** Whether the workspace is active. */
107
- isActive?: boolean;
108
- os_flags?: number;
109
- };
110
94
  /**
111
95
  * @beta
112
96
  * Type representing a UUID.
@@ -147,7 +131,7 @@ export interface WorkspaceChangeEmitter {
147
131
  * @param callback - The callback to invoke on changes.
148
132
  * @returns A promise that resolves to an unsubscribe function.
149
133
  */
150
- onWorkspaceChanged: (ws: WorkspaceIdentifier, callback: Callback<Workspace>) => Promise<Unsubscribe>;
134
+ onWorkspaceChanged: (ws: WorkspaceIdentifier, callback: Callback<WorkspaceItem>) => Promise<Unsubscribe>;
151
135
  /**
152
136
  * Subscribes to changes for a given workspace item.
153
137
  * @param item - The workspace item identifier.
@@ -160,7 +144,7 @@ export interface WorkspaceChangeEmitter {
160
144
  * @param callback - The callback to invoke with the current open workspaces.
161
145
  * @returns A promise that resolves to an unsubscribe function.
162
146
  */
163
- onOpenWorkspacesChanged: AddListener<Workspace[]>;
147
+ onOpenWorkspacesChanged: AddListener<WorkspaceItem[]>;
164
148
  }
165
149
  /**
166
150
  * @beta