@octostar/platform-types 0.5.37 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (466) hide show
  1. package/dist/action.d.ts +6 -6
  2. package/dist/action.d.ts.map +1 -1
  3. package/dist/ai.d.ts +7 -6
  4. package/dist/ai.d.ts.map +1 -1
  5. package/dist/desktop.d.ts +380 -204
  6. package/dist/desktop.d.ts.map +1 -1
  7. package/dist/desktop.js.map +1 -1
  8. package/dist/docs/assets/highlight.css +14 -14
  9. package/dist/docs/assets/navigation.js +1 -1
  10. package/dist/docs/assets/search.js +1 -1
  11. package/dist/docs/enums/ProcessingStatusCode.html +5 -27
  12. package/dist/docs/enums/SortOrder.html +3 -3
  13. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  14. package/dist/docs/functions/imageLabelCandidateAggs.html +5 -0
  15. package/dist/docs/functions/imageLabelCandidateSize.html +3 -0
  16. package/dist/docs/functions/imageLabelCountAggs.html +2 -0
  17. package/dist/docs/functions/imageLabelFamilyOfField.html +2 -0
  18. package/dist/docs/functions/imageLabelMatchClause.html +3 -0
  19. package/dist/docs/functions/imageLabelSourceIncludes.html +2 -0
  20. package/dist/docs/functions/isDefaultTemplate.html +3 -0
  21. package/dist/docs/functions/isDeletedEntity.html +2 -0
  22. package/dist/docs/functions/isWorkspaceFileItem.html +1 -1
  23. package/dist/docs/functions/isWorkspaceRoot.html +2 -0
  24. package/dist/docs/functions/ontologyLabel-1.html +4 -0
  25. package/dist/docs/functions/readImageLabelCandidates.html +2 -0
  26. package/dist/docs/functions/readImageLabelCounts.html +2 -0
  27. package/dist/docs/hierarchy.html +1 -1
  28. package/dist/docs/index.html +2 -3
  29. package/dist/docs/interfaces/AIClient.html +4 -4
  30. package/dist/docs/interfaces/ActionContext.html +4 -5
  31. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  32. package/dist/docs/interfaces/BrowseEntry.html +7 -0
  33. package/dist/docs/interfaces/BrowseRequest.html +4 -0
  34. package/dist/docs/interfaces/BrowseResponse.html +5 -0
  35. package/dist/docs/interfaces/ChatMessage.html +6 -6
  36. package/dist/docs/interfaces/Colorful.html +3 -3
  37. package/dist/docs/interfaces/Concept.html +14 -14
  38. package/dist/docs/interfaces/DeleteResponse.html +2 -2
  39. package/dist/docs/interfaces/Desktop.html +199 -122
  40. package/dist/docs/interfaces/DesktopActionContext.html +7 -8
  41. package/dist/docs/interfaces/DesktopSettings.html +6 -6
  42. package/dist/docs/interfaces/DeveloperSettings.html +3 -5
  43. package/dist/docs/interfaces/DownloadOptions.html +2 -2
  44. package/dist/docs/interfaces/EntityUiState.html +2 -2
  45. package/dist/docs/interfaces/FetchOptions.html +4 -4
  46. package/dist/docs/interfaces/FileListResponse.html +2 -2
  47. package/dist/docs/interfaces/FilesAPIClient.html +48 -24
  48. package/dist/docs/interfaces/FragmentRegion.html +6 -0
  49. package/dist/docs/interfaces/FragmentStatusEntry.html +13 -0
  50. package/dist/docs/interfaces/GeocodingResult.html +9 -0
  51. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  52. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  53. package/dist/docs/interfaces/ImageLabelCandidateOptions.html +4 -0
  54. package/dist/docs/interfaces/ImageLabelFamilyFields.html +13 -0
  55. package/dist/docs/interfaces/ImportDestination.html +3 -0
  56. package/dist/docs/interfaces/ImportItem.html +3 -0
  57. package/dist/docs/interfaces/ImportOptions.html +8 -0
  58. package/dist/docs/interfaces/ImportRequest.html +7 -0
  59. package/dist/docs/interfaces/IndexSearchHitSource.html +5 -3
  60. package/dist/docs/interfaces/Inheritance.html +5 -5
  61. package/dist/docs/interfaces/LiveContext.html +11 -11
  62. package/dist/docs/interfaces/MountAccess.html +3 -0
  63. package/dist/docs/interfaces/MountCreate.html +10 -0
  64. package/dist/docs/interfaces/MountGrantCreate.html +3 -0
  65. package/dist/docs/interfaces/MountGrantResponse.html +7 -0
  66. package/dist/docs/interfaces/MountImportCopyResponse.html +4 -0
  67. package/dist/docs/interfaces/MountImportLinkError.html +4 -0
  68. package/dist/docs/interfaces/MountImportLinkResponse.html +5 -0
  69. package/dist/docs/interfaces/MountResponse.html +20 -0
  70. package/dist/docs/interfaces/MountUpdate.html +13 -0
  71. package/dist/docs/interfaces/MoveOptions.html +2 -2
  72. package/dist/docs/interfaces/MoveResponse.html +58 -37
  73. package/dist/docs/interfaces/Ontology.html +110 -53
  74. package/dist/docs/interfaces/OntologyLabel.html +6 -0
  75. package/dist/docs/interfaces/OsAPIClient.html +8 -8
  76. package/dist/docs/interfaces/PeekSourceOptions.html +4 -0
  77. package/dist/docs/interfaces/PerUserCredentialInput.html +5 -0
  78. package/dist/docs/interfaces/PerUserCredentialStatus.html +7 -0
  79. package/dist/docs/interfaces/ProcessingRecursiveStatus.html +27 -0
  80. package/dist/docs/interfaces/ProcessingStatus.html +40 -9
  81. package/dist/docs/interfaces/Property.html +7 -5
  82. package/dist/docs/interfaces/RecordProvider.html +6 -6
  83. package/dist/docs/interfaces/RecordsSourceScope.html +8 -0
  84. package/dist/docs/interfaces/RefObject.html +3 -3
  85. package/dist/docs/interfaces/Relationship.html +22 -20
  86. package/dist/docs/interfaces/ReportApi.html +13 -0
  87. package/dist/docs/interfaces/S3Headers.html +2 -2
  88. package/dist/docs/interfaces/S3UploadResponse.html +2 -2
  89. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  90. package/dist/docs/interfaces/SearchFilter.html +29 -0
  91. package/dist/docs/interfaces/SearchHit.html +11 -0
  92. package/dist/docs/interfaces/SearchInnerHit.html +3 -0
  93. package/dist/docs/interfaces/SearchOptions.html +21 -4
  94. package/dist/docs/interfaces/SearchProps.html +11 -10
  95. package/dist/docs/interfaces/SearchQueryResult.html +5 -0
  96. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  97. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  98. package/dist/docs/interfaces/SemanticBindingOptions.html +8 -0
  99. package/dist/docs/interfaces/SemanticBindingProps.html +8 -6
  100. package/dist/docs/interfaces/SharedCredentialsInput.html +5 -0
  101. package/dist/docs/interfaces/SourceExportError.html +4 -0
  102. package/dist/docs/interfaces/SourceExportRequest.html +8 -0
  103. package/dist/docs/interfaces/SourceExportResponse.html +7 -0
  104. package/dist/docs/interfaces/SourcePeekEntry.html +12 -0
  105. package/dist/docs/interfaces/SourcePeekResponse.html +10 -0
  106. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  107. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  108. package/dist/docs/interfaces/SubscribeOptions.html +4 -0
  109. package/dist/docs/interfaces/TagAttributes.html +7 -7
  110. package/dist/docs/interfaces/TestConnectionRequest.html +12 -0
  111. package/dist/docs/interfaces/TestConnectionResponse.html +4 -0
  112. package/dist/docs/interfaces/UiStateManager.html +2 -2
  113. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  114. package/dist/docs/interfaces/UnzipOptions.html +2 -2
  115. package/dist/docs/interfaces/UploadFromUrlError.html +8 -0
  116. package/dist/docs/interfaces/UploadFromUrlRequest.html +6 -0
  117. package/dist/docs/interfaces/UploadFromUrlResponse.html +6 -0
  118. package/dist/docs/interfaces/UploadOptions.html +2 -2
  119. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +7 -7
  120. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  121. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  122. package/dist/docs/modules.html +106 -38
  123. package/dist/docs/types/ActionHandler.html +2 -2
  124. package/dist/docs/types/AddCommentParams.html +2 -2
  125. package/dist/docs/types/AddListener.html +2 -2
  126. package/dist/docs/types/AddToReportBlocksInput.html +6 -0
  127. package/dist/docs/types/AddToReportContentSelection.html +2 -0
  128. package/dist/docs/types/AddToReportEntityInput.html +5 -0
  129. package/dist/docs/types/AddToReportInput.html +2 -0
  130. package/dist/docs/types/AddToReportResult.html +2 -0
  131. package/dist/docs/types/ApiErrorResult.html +2 -2
  132. package/dist/docs/types/ApiResult.html +2 -2
  133. package/dist/docs/types/ApiSuccessResult.html +2 -2
  134. package/dist/docs/types/App.html +2 -2
  135. package/dist/docs/types/AppRegistry.html +3 -4
  136. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  137. package/dist/docs/types/AppServiceCallProps.html +2 -2
  138. package/dist/docs/types/AsyncFilter.html +2 -2
  139. package/dist/docs/types/AttachmentResponseType.html +2 -2
  140. package/dist/docs/types/AttachmentType.html +2 -2
  141. package/dist/docs/types/BinaryOperator.html +2 -2
  142. package/dist/docs/types/BrowseKind.html +1 -0
  143. package/dist/docs/types/Callback.html +2 -2
  144. package/dist/docs/types/ChatApiResponse.html +1 -1
  145. package/dist/docs/types/ChatModel.html +2 -2
  146. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  147. package/dist/docs/types/CommonOptions.html +1 -1
  148. package/dist/docs/types/Comparator.html +2 -2
  149. package/dist/docs/types/ConceptFilter.html +3 -3
  150. package/dist/docs/types/ConceptMap.html +2 -2
  151. package/dist/docs/types/ConceptName.html +1 -1
  152. package/dist/docs/types/ConceptWithParents.html +2 -2
  153. package/dist/docs/types/ConnectedEntity.html +2 -2
  154. package/dist/docs/types/ContextMenuGroup.html +2 -2
  155. package/dist/docs/types/ContextMenuLabels.html +2 -2
  156. package/dist/docs/types/ContextMenuOptions.html +2 -2
  157. package/dist/docs/types/ContextMenuParams.html +2 -2
  158. package/dist/docs/types/ContextMenuRequest.html +2 -2
  159. package/dist/docs/types/CopyOptions.html +2 -2
  160. package/dist/docs/types/CreateEntityFormProps.html +4 -2
  161. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  162. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  163. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  164. package/dist/docs/types/CredType.html +1 -0
  165. package/dist/docs/types/CredentialMode.html +1 -0
  166. package/dist/docs/types/CustomEventListener.html +2 -2
  167. package/dist/docs/types/CustomTemplate.html +9 -3
  168. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  169. package/dist/docs/types/DataContextType.html +2 -2
  170. package/dist/docs/types/DefaultLiveContextData.html +1 -1
  171. package/dist/docs/types/DefaultTemplate.html +11 -0
  172. package/dist/docs/types/DefaultTemplateProps.html +5 -0
  173. package/dist/docs/types/DeletedEntity.html +3 -0
  174. package/dist/docs/types/DesktopAction.html +2 -2
  175. package/dist/docs/types/DesktopActionFilter.html +2 -2
  176. package/dist/docs/types/DesktopActionMenuItem.html +6 -2
  177. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  178. package/dist/docs/types/DesktopActionOptions.html +17 -3
  179. package/dist/docs/types/DesktopOpenParams.html +2 -2
  180. package/dist/docs/types/DragEndParams.html +2 -2
  181. package/dist/docs/types/DragStartParams.html +2 -2
  182. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  183. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  184. package/dist/docs/types/EConnection.html +2 -2
  185. package/dist/docs/types/EdgeSpec.html +2 -2
  186. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  187. package/dist/docs/types/Entity.html +2 -2
  188. package/dist/docs/types/EntityBase.html +2 -2
  189. package/dist/docs/types/EntityEdge.html +2 -2
  190. package/dist/docs/types/EntityOTM.html +2 -2
  191. package/dist/docs/types/EntityPasteContext.html +2 -2
  192. package/dist/docs/types/EntityRelationshipCount.html +4 -0
  193. package/dist/docs/types/EvalContext.html +1 -1
  194. package/dist/docs/types/EventContextType.html +2 -2
  195. package/dist/docs/types/EventEmitterType.html +2 -2
  196. package/dist/docs/types/EventName.html +2 -2
  197. package/dist/docs/types/EventProducer.html +2 -2
  198. package/dist/docs/types/EventPublisher.html +2 -2
  199. package/dist/docs/types/EventSubscriber.html +2 -2
  200. package/dist/docs/types/EventUnsubscriber.html +2 -2
  201. package/dist/docs/types/ExportOptions.html +2 -2
  202. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  203. package/dist/docs/types/ExtrasApi.html +1 -1
  204. package/dist/docs/types/FetchEntityOptions.html +2 -2
  205. package/dist/docs/types/FileCode.html +2 -2
  206. package/dist/docs/types/FileTreeOptions.html +2 -2
  207. package/dist/docs/types/FilterDefinition.html +2 -2
  208. package/dist/docs/types/FilterDefinitions.html +2 -2
  209. package/dist/docs/types/FilterName.html +2 -2
  210. package/dist/docs/types/FilterQuery.html +2 -2
  211. package/dist/docs/types/FilterReference.html +2 -2
  212. package/dist/docs/types/FilterValue.html +2 -2
  213. package/dist/docs/types/FocusListItem.html +2 -2
  214. package/dist/docs/types/FragmentInfo.html +5 -0
  215. package/dist/docs/types/FragmentLocator.html +5 -0
  216. package/dist/docs/types/FragmentResolution.html +2 -0
  217. package/dist/docs/types/GetSystemSettingResponse.html +4 -1
  218. package/dist/docs/types/GraphDataSpec.html +1 -1
  219. package/dist/docs/types/GraphSpec.html +2 -2
  220. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  221. package/dist/docs/types/Icon.html +2 -2
  222. package/dist/docs/types/IconProps.html +2 -2
  223. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  224. package/dist/docs/types/ImageInfo.html +2 -2
  225. package/dist/docs/types/ImageLabelFamily.html +21 -0
  226. package/dist/docs/types/ImportConflictPolicy.html +1 -0
  227. package/dist/docs/types/ImportEntryKind.html +1 -0
  228. package/dist/docs/types/ImportFoldersOptions.html +2 -2
  229. package/dist/docs/types/ImportMode.html +1 -0
  230. package/dist/docs/types/InlineCode.html +2 -2
  231. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  232. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  233. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  234. package/dist/docs/types/JavascriptType.html +3 -3
  235. package/dist/docs/types/JobManifest.html +4 -4
  236. package/dist/docs/types/KnownCounts.html +2 -2
  237. package/dist/docs/types/ListByParentFolder.html +1 -1
  238. package/dist/docs/types/ListByPath.html +1 -1
  239. package/dist/docs/types/ListFolderOptions.html +1 -1
  240. package/dist/docs/types/LiveContextAPISetParams.html +1 -1
  241. package/dist/docs/types/LiveContextListener.html +1 -1
  242. package/dist/docs/types/ManifestSecrets.html +1 -1
  243. package/dist/docs/types/MapSettingKey.html +1 -0
  244. package/dist/docs/types/MkdirResponse.html +1 -1
  245. package/dist/docs/types/ModalTemplateProps.html +2 -2
  246. package/dist/docs/types/MountScheme.html +7 -0
  247. package/dist/docs/types/NamedEntityGroup.html +2 -2
  248. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  249. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  250. package/dist/docs/types/NunjucksType.html +3 -3
  251. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  252. package/dist/docs/types/OntologyTags.html +2 -2
  253. package/dist/docs/types/OpenNewAIChatOptions.html +17 -0
  254. package/dist/docs/types/OpenReportSummary.html +6 -0
  255. package/dist/docs/types/OsAuditFields.html +2 -2
  256. package/dist/docs/types/OsConfirmProps.html +2 -2
  257. package/dist/docs/types/OsNotification.html +2 -2
  258. package/dist/docs/types/OsProgress.html +11 -3
  259. package/dist/docs/types/OsTag.html +2 -2
  260. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  261. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  262. package/dist/docs/types/PeekSourceTarget.html +4 -0
  263. package/dist/docs/types/Permission.html +2 -2
  264. package/dist/docs/types/Point.html +2 -2
  265. package/dist/docs/types/PrincipalType.html +1 -0
  266. package/dist/docs/types/PromptOptions.html +6 -3
  267. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  268. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  269. package/dist/docs/types/Query.html +2 -2
  270. package/dist/docs/types/QueryBatchResult.html +2 -2
  271. package/dist/docs/types/QueryDslQueryContainer.html +6 -0
  272. package/dist/docs/types/QueryErrorResult.html +2 -2
  273. package/dist/docs/types/QueryExecutor.html +2 -2
  274. package/dist/docs/types/QueryFilesystemItemsParams.html +16 -0
  275. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  276. package/dist/docs/types/QueryResponse.html +2 -2
  277. package/dist/docs/types/QueryResult.html +2 -2
  278. package/dist/docs/types/QuerySuccessResult.html +2 -2
  279. package/dist/docs/types/ReactCssProperties.html +2 -2
  280. package/dist/docs/types/ReactNode.html +2 -2
  281. package/dist/docs/types/ReactRef.html +2 -2
  282. package/dist/docs/types/ReasonedBoolean.html +2 -2
  283. package/dist/docs/types/RefCallback.html +2 -2
  284. package/dist/docs/types/RegisteredActionInfo.html +21 -0
  285. package/dist/docs/types/RelationshipCountEntry.html +8 -0
  286. package/dist/docs/types/RelationshipCountResult.html +2 -2
  287. package/dist/docs/types/RelationshipCountState.html +2 -0
  288. package/dist/docs/types/RemoteAppApi.html +1 -1
  289. package/dist/docs/types/RenameTabProps.html +2 -2
  290. package/dist/docs/types/RenderableTemplate.html +11 -0
  291. package/dist/docs/types/ReportTiptapNode.html +4 -0
  292. package/dist/docs/types/RuntimeAppUrlEntity.html +5 -0
  293. package/dist/docs/types/RuntimeAppUrlWorkspaceItem.html +10 -0
  294. package/dist/docs/types/SaveAsModalProps.html +2 -2
  295. package/dist/docs/types/SaveFileOptions.html +2 -2
  296. package/dist/docs/types/SaveOptions.html +2 -3
  297. package/dist/docs/types/SavedTemplate.html +3 -4
  298. package/dist/docs/types/SearchScope.html +9 -0
  299. package/dist/docs/types/SemanticBinding.html +2 -2
  300. package/dist/docs/types/SemanticBindingSpec.html +3 -0
  301. package/dist/docs/types/SemanticBindingType.html +2 -2
  302. package/dist/docs/types/SemanticBindings.html +3 -2
  303. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  304. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  305. package/dist/docs/types/SendQueryOptions.html +2 -2
  306. package/dist/docs/types/ServiceDefinition.html +2 -2
  307. package/dist/docs/types/ServiceDefinitions.html +2 -2
  308. package/dist/docs/types/ServiceRole.html +2 -2
  309. package/dist/docs/types/SetTransformResultFn.html +1 -1
  310. package/dist/docs/types/SetsOptions.html +7 -16
  311. package/dist/docs/types/SetsSortBy.html +1 -0
  312. package/dist/docs/types/ShowOntology.html +2 -2
  313. package/dist/docs/types/ShowTabProps.html +2 -2
  314. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  315. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  316. package/dist/docs/types/Tag.html +2 -2
  317. package/dist/docs/types/TagInfo.html +2 -2
  318. package/dist/docs/types/TagWithRelationship.html +2 -2
  319. package/dist/docs/types/TaskCleanupReason.html +2 -2
  320. package/dist/docs/types/TemplateMetadata.html +3 -3
  321. package/dist/docs/types/TemplateType.html +2 -2
  322. package/dist/docs/types/TemplateVariant.html +2 -2
  323. package/dist/docs/types/TestOutcome.html +2 -0
  324. package/dist/docs/types/TransformAction.html +2 -2
  325. package/dist/docs/types/TransformActionContext.html +2 -2
  326. package/dist/docs/types/TransformDefinition.html +2 -2
  327. package/dist/docs/types/TransformDefinitions.html +2 -2
  328. package/dist/docs/types/Unsubscribe.html +2 -2
  329. package/dist/docs/types/UnsubscribeFn.html +1 -1
  330. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  331. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  332. package/dist/docs/types/UploadFromUrlErrorCode.html +4 -0
  333. package/dist/docs/types/UserProfile.html +2 -2
  334. package/dist/docs/types/VirtualEntity.html +2 -2
  335. package/dist/docs/types/Whoami.html +3 -3
  336. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  337. package/dist/docs/types/WorkspaceConfig.html +5 -3
  338. package/dist/docs/types/WorkspaceFlags.html +2 -2
  339. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  340. package/dist/docs/types/WorkspaceItem.html +21 -2
  341. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  342. package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -1
  343. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  344. package/dist/docs/types/WorkspaceItemModel.html +4 -12
  345. package/dist/docs/types/WorkspaceItemTitleProps.html +3 -3
  346. package/dist/docs/types/WorkspacePermission.html +2 -2
  347. package/dist/docs/types/WorkspaceRecord.html +2 -2
  348. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  349. package/dist/docs/types/WorkspaceRelationship.html +3 -2
  350. package/dist/docs/types/WorkspaceSettings.html +2 -2
  351. package/dist/docs/types/trigger.html +2 -2
  352. package/dist/docs/types/uuid.html +2 -2
  353. package/dist/docs/variables/HEAVY_ANNOTATION_FIELDS.html +17 -0
  354. package/dist/docs/variables/IMAGE_LABEL_FAMILIES.html +1 -0
  355. package/dist/docs/variables/IMAGE_LABEL_FIELDS.html +1 -0
  356. package/dist/docs/variables/IMAGE_LABEL_SOURCE_INCLUDES.html +2 -0
  357. package/dist/docs/variables/MAP_SETTINGS_KEYS.html +9 -0
  358. package/dist/docs/variables/ORIGINAL_OS_PARENT_FOLDER.html +1 -1
  359. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  360. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  361. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  362. package/dist/docs/variables/VECTOR_SENTINEL_LABELS.html +4 -0
  363. package/dist/extras.d.ts +0 -1
  364. package/dist/extras.d.ts.map +1 -1
  365. package/dist/files.d.ts +141 -1
  366. package/dist/files.d.ts.map +1 -1
  367. package/dist/files.js.map +1 -1
  368. package/dist/fragmentLocator.d.ts +31 -0
  369. package/dist/fragmentLocator.d.ts.map +1 -0
  370. package/dist/fragmentLocator.js +2 -0
  371. package/dist/fragmentLocator.js.map +1 -0
  372. package/dist/imageLabels.d.ts +84 -0
  373. package/dist/imageLabels.d.ts.map +1 -0
  374. package/dist/imageLabels.js +148 -0
  375. package/dist/imageLabels.js.map +1 -0
  376. package/dist/index.d.ts +6 -3
  377. package/dist/index.d.ts.map +1 -1
  378. package/dist/index.js +6 -3
  379. package/dist/index.js.map +1 -1
  380. package/dist/indexSearch.d.ts +18 -0
  381. package/dist/indexSearch.d.ts.map +1 -1
  382. package/dist/jobManifestTypes.d.ts +5 -25
  383. package/dist/jobManifestTypes.d.ts.map +1 -1
  384. package/dist/mapSettings.d.ts +17 -0
  385. package/dist/mapSettings.d.ts.map +1 -0
  386. package/dist/mapSettings.js +16 -0
  387. package/dist/mapSettings.js.map +1 -0
  388. package/dist/model.d.ts +215 -71
  389. package/dist/model.d.ts.map +1 -1
  390. package/dist/model.js +44 -25
  391. package/dist/model.js.map +1 -1
  392. package/dist/mounts.d.ts +184 -0
  393. package/dist/mounts.d.ts.map +1 -0
  394. package/dist/mounts.js +11 -0
  395. package/dist/mounts.js.map +1 -0
  396. package/dist/ontology.d.ts +148 -8
  397. package/dist/ontology.d.ts.map +1 -1
  398. package/dist/platform-types.d.ts +1692 -663
  399. package/dist/report.d.ts +112 -0
  400. package/dist/report.d.ts.map +1 -0
  401. package/dist/report.js +2 -0
  402. package/dist/report.js.map +1 -0
  403. package/dist/savedSet.d.ts +5 -0
  404. package/dist/savedSet.d.ts.map +1 -0
  405. package/dist/savedSet.js +2 -0
  406. package/dist/savedSet.js.map +1 -0
  407. package/dist/search.d.ts +140 -3
  408. package/dist/search.d.ts.map +1 -1
  409. package/dist/search.js +32 -1
  410. package/dist/search.js.map +1 -1
  411. package/dist/semantic.d.ts +24 -5
  412. package/dist/semantic.d.ts.map +1 -1
  413. package/dist/templates.d.ts +63 -5
  414. package/dist/templates.d.ts.map +1 -1
  415. package/dist/templates.js +8 -1
  416. package/dist/templates.js.map +1 -1
  417. package/dist/workspace.d.ts +25 -41
  418. package/dist/workspace.d.ts.map +1 -1
  419. package/dist/workspace.js.map +1 -1
  420. package/package.json +6 -20
  421. package/dist/behaviour.d.ts +0 -45
  422. package/dist/behaviour.d.ts.map +0 -1
  423. package/dist/behaviour.js +0 -14
  424. package/dist/behaviour.js.map +0 -1
  425. package/dist/docs/interfaces/ChartDataResponseResult.html +0 -20
  426. package/dist/docs/interfaces/NativeFilterColumn.html +0 -3
  427. package/dist/docs/interfaces/NativeFilterScope.html +0 -3
  428. package/dist/docs/interfaces/NativeFilterTarget.html +0 -3
  429. package/dist/docs/interfaces/RecordData.html +0 -20
  430. package/dist/docs/interfaces/SavedDatasource.html +0 -7
  431. package/dist/docs/interfaces/SavedSearchAPIInterface.html +0 -6
  432. package/dist/docs/interfaces/SavedSearchContent.html +0 -7
  433. package/dist/docs/interfaces/StylerContext.html +0 -21
  434. package/dist/docs/types/Behaviour.html +0 -17
  435. package/dist/docs/types/DataMask.html +0 -1
  436. package/dist/docs/types/DesktopStylerContext.html +0 -4
  437. package/dist/docs/types/DraftWorkspaceItem.html +0 -3
  438. package/dist/docs/types/Filter.html +0 -1
  439. package/dist/docs/types/FilterState.html +0 -1
  440. package/dist/docs/types/FolderPasteOptions.html +0 -5
  441. package/dist/docs/types/JavascriptFileStylerDefinition.html +0 -2
  442. package/dist/docs/types/JavascriptInlineStylerDefinition.html +0 -2
  443. package/dist/docs/types/PasteContextOptions.html +0 -8
  444. package/dist/docs/types/RecordFetchOptions.html +0 -1
  445. package/dist/docs/types/SearchFilter.html +0 -2
  446. package/dist/docs/types/Styler.html +0 -19
  447. package/dist/docs/types/StylerConfig.html +0 -6
  448. package/dist/docs/types/StylerDefinition.html +0 -2
  449. package/dist/docs/types/StylerDefinitions.html +0 -2
  450. package/dist/docs/types/StylerOption.html +0 -4
  451. package/dist/docs/types/StylerProducer.html +0 -4
  452. package/dist/docs/types/Watcher.html +0 -11
  453. package/dist/docs/types/Workspace.html +0 -8
  454. package/dist/docs/types/WorkspaceItems.html +0 -2
  455. package/dist/docs/types/WorkspaceRecordInfo.html +0 -6
  456. package/dist/docs/types/WorkspaceRecords.html +0 -2
  457. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +0 -1
  458. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +0 -1
  459. package/dist/savedSearch.d.ts +0 -128
  460. package/dist/savedSearch.d.ts.map +0 -1
  461. package/dist/savedSearch.js +0 -16
  462. package/dist/savedSearch.js.map +0 -1
  463. package/dist/styling.d.ts +0 -100
  464. package/dist/styling.d.ts.map +0 -1
  465. package/dist/styling.js +0 -2
  466. package/dist/styling.js.map +0 -1
package/dist/docs/interfaces/OntologyLabel.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OntologyLabel | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="OntologyLabel.html">OntologyLabel</a></li></ul><h1>Interface OntologyLabel<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The display label the ontology schema resolves for a concept, property or relationship.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">OntologyLabel</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="OntologyLabel.html#plural">plural</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="OntologyLabel.html#text">text</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in model.ts:45</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="OntologyLabel.html#plural" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>plural?</span></a>
3
+ <a href="OntologyLabel.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="plural" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>plural</span><a href="#plural" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">plural</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>One form per CLDR plural category; sent for concepts only.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The label in the session language.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:49</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#plural" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>plural</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/OsAPIClient.html CHANGED
@@ -1,5 +1,5 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OsAPIClient | @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="OsAPIClient.html">OsAPIClient</a></li></ul><h1>Interface OsAPIClient<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface representing a client for interacting with the OctoStar API.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">OsAPIClient</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#fetch.fetch-1">fetch</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</span>, <span class="tsd-kind-parameter">init</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#fetchData.fetchData-1">fetchData</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#getBaseUrl.getBaseUrl-1">getBaseUrl</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamData.streamData-1">streamData</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamJson.streamJson-1">streamJson</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="StreamJsonOptions.html" class="tsd-signature-type tsd-kind-interface">StreamJsonOptions</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamText.streamText-1">streamText</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="StreamTextOptions.html" class="tsd-signature-type tsd-kind-interface">StreamTextOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L18">client.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="OsAPIClient.html#fetch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OsAPIClient | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="OsAPIClient.html">OsAPIClient</a></li></ul><h1>Interface OsAPIClient<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface representing a client for interacting with the OctoStar API.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">OsAPIClient</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#fetch.fetch-1">fetch</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</span>, <span class="tsd-kind-parameter">init</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#fetchData.fetchData-1">fetchData</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#getBaseUrl.getBaseUrl-1">getBaseUrl</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamData.streamData-1">streamData</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamJson.streamJson-1">streamJson</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="StreamJsonOptions.html" class="tsd-signature-type tsd-kind-interface">StreamJsonOptions</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="OsAPIClient.html#streamText.streamText-1">streamText</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="StreamTextOptions.html" class="tsd-signature-type tsd-kind-interface">StreamTextOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in client.ts:18</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="OsAPIClient.html#fetch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a>
3
3
  <a href="OsAPIClient.html#fetchData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a>
4
4
  <a href="OsAPIClient.html#getBaseUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Url</span></a>
5
5
  <a href="OsAPIClient.html#streamData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Data</span></a>
@@ -9,18 +9,18 @@
9
9
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <span class="tsd-signature-type">RequestInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>The resource to fetch (RequestInfo | URL).</p>
10
10
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">init</span>: <span class="tsd-signature-type">RequestInit</span></span><div class="tsd-comment tsd-typography"><p>Optional request initialization options.</p>
11
11
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the Response object.</p>
12
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L59">client.ts:59</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Data</span><a href="#fetchData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchData.fetchData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Data</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#fetchData.fetchData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Fetch data from the API.</p>
12
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:59</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Data</span><a href="#fetchData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fetchData.fetchData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Data</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#fetchData.fetchData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Fetch data from the API.</p>
13
13
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="fetchData.fetchData-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a></span><div class="tsd-comment tsd-typography"><p>Configuration options for the fetch request.</p>
14
14
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#fetchData.fetchData-1.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the fetched data of type T.</p>
15
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L24">client.ts:24</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBaseUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Base<wbr/>Url</span><a href="#getBaseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBaseUrl.getBaseUrl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Base<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getBaseUrl.getBaseUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Gets the configured base URL</p>
15
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:24</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBaseUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Base<wbr/>Url</span><a href="#getBaseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBaseUrl.getBaseUrl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Base<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getBaseUrl.getBaseUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Gets the configured base URL</p>
16
16
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resoves to the api base URL</p>
17
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L51">client.ts:51</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Data</span><a href="#streamData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamData.streamData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamData.streamData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Stream data from the API.</p>
17
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:51</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Data</span><a href="#streamData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamData.streamData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamData.streamData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Stream data from the API.</p>
18
18
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="FetchOptions.html" class="tsd-signature-type tsd-kind-interface">FetchOptions</a></span><div class="tsd-comment tsd-typography"><p>Configuration options for the stream request.</p>
19
19
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the streaming is complete.</p>
20
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L31">client.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Json</span><a href="#streamJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamJson.streamJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Json</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamJson.streamJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Streams JSON line data from the API.</p>
20
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:31</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Json</span><a href="#streamJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamJson.streamJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Json</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamJson.streamJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Streams JSON line data from the API.</p>
21
21
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="streamJson.streamJson-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="StreamJsonOptions.html" class="tsd-signature-type tsd-kind-interface">StreamJsonOptions</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OsAPIClient.html#streamJson.streamJson-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Configuration options for the stream request.</p>
22
22
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the streaming is complete.</p>
23
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L45">client.ts:45</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Text</span><a href="#streamText" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamText.streamText-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Text</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamText.streamText-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Streams text data from the API.</p>
23
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="streamText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream<wbr/>Text</span><a href="#streamText" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="streamText.streamText-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stream<wbr/>Text</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#streamText.streamText-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Streams text data from the API.</p>
24
24
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="StreamTextOptions.html" class="tsd-signature-type tsd-kind-interface">StreamTextOptions</a></span><div class="tsd-comment tsd-typography"><p>Configuration options for the stream request.</p>
25
25
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the streaming is complete.</p>
26
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/0bade5b3d97f3076787b20c2c42657b0e88b6929/packages/octostar-platform-types/src/client.ts#L38">client.ts:38</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#fetchData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a><a href="#getBaseUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Url</span></a><a href="#streamData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Data</span></a><a href="#streamJson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Json</span></a><a href="#streamText" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.37</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
26
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in client.ts:38</li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#fetch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch</span></a><a href="#fetchData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a><a href="#getBaseUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Url</span></a><a href="#streamData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Data</span></a><a href="#streamJson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Json</span></a><a href="#streamText" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stream<wbr/>Text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/PeekSourceOptions.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PeekSourceOptions | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="PeekSourceOptions.html">PeekSourceOptions</a></li></ul><h1>Interface PeekSourceOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options for peeking into a source-backed file (e.g. a zip).</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">PeekSourceOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="PeekSourceOptions.html#inner">inner</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in files.ts:41</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="PeekSourceOptions.html#inner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inner?</span></a>
3
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="inner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>inner</span><a href="#inner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Path inside the source to list. Defaults to '/' (the source root).</p>
4
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in files.ts:43</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#inner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inner</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/PerUserCredentialInput.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PerUserCredentialInput | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="PerUserCredentialInput.html">PerUserCredentialInput</a></li></ul><h1>Interface PerUserCredentialInput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Write-only credential blob a user PUTs for their own per-user access.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">PerUserCredentialInput</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialInput.html#domain">domain</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialInput.html#password">password</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialInput.html#username">username</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:95</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="PerUserCredentialInput.html#domain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain?</span></a>
3
+ <a href="PerUserCredentialInput.html#password" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a>
4
+ <a href="PerUserCredentialInput.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="domain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>domain</span><a href="#domain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">domain</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:98</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:97</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:96</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#domain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/PerUserCredentialStatus.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PerUserCredentialStatus | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="PerUserCredentialStatus.html">PerUserCredentialStatus</a></li></ul><h1>Interface PerUserCredentialStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Metadata-only status of a user's saved per-user credential — never the secret.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">PerUserCredentialStatus</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialStatus.html#created_at">created_at</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialStatus.html#cred_type">cred_type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;password&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialStatus.html#last_updated_at">last_updated_at</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialStatus.html#last_used_at">last_used_at</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="PerUserCredentialStatus.html#set">set</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:102</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="PerUserCredentialStatus.html#created_at" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created_<wbr/>at</span></a>
3
+ <a href="PerUserCredentialStatus.html#cred_type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cred_<wbr/>type</span></a>
4
+ <a href="PerUserCredentialStatus.html#last_updated_at" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last_<wbr/>updated_<wbr/>at</span></a>
5
+ <a href="PerUserCredentialStatus.html#last_used_at" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last_<wbr/>used_<wbr/>at</span></a>
6
+ <a href="PerUserCredentialStatus.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="created_at" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>created_<wbr/>at</span><a href="#created_at" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">created_<wbr/>at</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:105</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="cred_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cred_<wbr/>type</span><a href="#cred_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cred_<wbr/>type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;password&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:104</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="last_updated_at" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last_<wbr/>updated_<wbr/>at</span><a href="#last_updated_at" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">last_<wbr/>updated_<wbr/>at</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:106</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="last_used_at" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last_<wbr/>used_<wbr/>at</span><a href="#last_used_at" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">last_<wbr/>used_<wbr/>at</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:107</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in mounts.ts:103</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#created_at" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created_<wbr/>at</span></a><a href="#cred_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cred_<wbr/>type</span></a><a href="#last_updated_at" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last_<wbr/>updated_<wbr/>at</span></a><a href="#last_used_at" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last_<wbr/>used_<wbr/>at</span></a><a href="#set" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/interfaces/ProcessingRecursiveStatus.html ADDED
@@ -0,0 +1,27 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ProcessingRecursiveStatus | @octostar/platform-types - v1.0.0</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 - v1.0.0</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="ProcessingRecursiveStatus.html">ProcessingRecursiveStatus</a></li></ul><h1>Interface ProcessingRecursiveStatus<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Fragment-tree completion payload persisted by the backend's debounced
2
+ recursive-rollup job. Returned in-line as
3
+ <a href="ProcessingStatus.html#detailed_status" class="tsd-kind-property">ProcessingStatus.detailed_status</a> for any entity whose subtree
4
+ has been rolled up at least once. Mirrors
5
+ <code>app/api/v1/pipeline/processing_status_models.py::ProcessingRecursiveStatus</code>.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ProcessingRecursiveStatus</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#fully_complete">fully_complete</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#has_missing_branches">has_missing_branches</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#known_floor">known_floor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#orphaned_prior_fragments">orphaned_prior_fragments</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#partial">partial</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#remaining_floor">remaining_floor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#status_code">status_code</a><span class="tsd-signature-symbol">?: </span><a href="../enums/ProcessingStatusCode.html" class="tsd-signature-type tsd-kind-enum">ProcessingStatusCode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#total_failed">total_failed</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#total_indexed">total_indexed</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#total_missing">total_missing</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#total_running">total_running</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#total_terminal">total_terminal</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ProcessingRecursiveStatus.html#tree_live">tree_live</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in model.ts:904</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ProcessingRecursiveStatus.html#fully_complete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fully_<wbr/>complete</span></a>
7
+ <a href="ProcessingRecursiveStatus.html#has_missing_branches" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>missing_<wbr/>branches</span></a>
8
+ <a href="ProcessingRecursiveStatus.html#known_floor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>known_<wbr/>floor</span></a>
9
+ <a href="ProcessingRecursiveStatus.html#orphaned_prior_fragments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>orphaned_<wbr/>prior_<wbr/>fragments?</span></a>
10
+ <a href="ProcessingRecursiveStatus.html#partial" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partial</span></a>
11
+ <a href="ProcessingRecursiveStatus.html#remaining_floor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remaining_<wbr/>floor</span></a>
12
+ <a href="ProcessingRecursiveStatus.html#status_code" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status_<wbr/>code?</span></a>
13
+ <a href="ProcessingRecursiveStatus.html#total_failed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>failed</span></a>
14
+ <a href="ProcessingRecursiveStatus.html#total_indexed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>indexed</span></a>
15
+ <a href="ProcessingRecursiveStatus.html#total_missing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>missing</span></a>
16
+ <a href="ProcessingRecursiveStatus.html#total_running" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>running</span></a>
17
+ <a href="ProcessingRecursiveStatus.html#total_terminal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>terminal</span></a>
18
+ <a href="ProcessingRecursiveStatus.html#tree_live" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tree_<wbr/>live</span></a>
19
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="fully_complete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>fully_<wbr/>complete</span><a href="#fully_complete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fully_<wbr/>complete</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:912</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="has_missing_branches" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>has_<wbr/>missing_<wbr/>branches</span><a href="#has_missing_branches" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_<wbr/>missing_<wbr/>branches</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:914</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="known_floor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>known_<wbr/>floor</span><a href="#known_floor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">known_<wbr/>floor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:910</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="orphaned_prior_fragments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>orphaned_<wbr/>prior_<wbr/>fragments</span><a href="#orphaned_prior_fragments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">orphaned_<wbr/>prior_<wbr/>fragments</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Fragments left by PRIOR pipeline runs that the latest run did not
20
+ re-create. They remain indexed and searchable in full — this count only
21
+ flags that they are NOT counted toward this (last-run-scoped) completion
22
+ rollup. Sparse: present only when &gt; 0. Cleared by a reprocess that
23
+ re-creates the whole tree, or by an explicit fragment cleanup.</p>
24
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:929</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="partial" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>partial</span><a href="#partial" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">partial</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:915</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="remaining_floor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>remaining_<wbr/>floor</span><a href="#remaining_floor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">remaining_<wbr/>floor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:911</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="status_code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>status_<wbr/>code</span><a href="#status_code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status_<wbr/>code</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/ProcessingStatusCode.html" class="tsd-signature-type tsd-kind-enum">ProcessingStatusCode</a></div><div class="tsd-comment tsd-typography"><p>Sparse rollup-effective status code override.
25
+ Consumers should compute the effective status as
26
+ <code>detailed_status?.status_code ?? status_code</code>.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:921</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_failed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>total_<wbr/>failed</span><a href="#total_failed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>failed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:909</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_indexed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>total_<wbr/>indexed</span><a href="#total_indexed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>indexed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:905</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_missing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>total_<wbr/>missing</span><a href="#total_missing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>missing</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:908</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_running" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>total_<wbr/>running</span><a href="#total_running" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>running</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:907</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="total_terminal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>total_<wbr/>terminal</span><a href="#total_terminal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total_<wbr/>terminal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:906</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tree_live" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>tree_<wbr/>live</span><a href="#tree_live" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tree_<wbr/>live</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in model.ts:913</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#fully_complete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fully_<wbr/>complete</span></a><a href="#has_missing_branches" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>missing_<wbr/>branches</span></a><a href="#known_floor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>known_<wbr/>floor</span></a><a href="#orphaned_prior_fragments" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>orphaned_<wbr/>prior_<wbr/>fragments</span></a><a href="#partial" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partial</span></a><a href="#remaining_floor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remaining_<wbr/>floor</span></a><a href="#status_code" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status_<wbr/>code</span></a><a href="#total_failed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>failed</span></a><a href="#total_indexed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>indexed</span></a><a href="#total_missing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>missing</span></a><a href="#total_running" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>running</span></a><a href="#total_terminal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total_<wbr/>terminal</span></a><a href="#tree_live" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tree_<wbr/>live</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v1.0.0</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>