@octostar/platform-types 0.5.7 → 0.5.9

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 (258) hide show
  1. package/dist/desktop.d.ts +0 -8
  2. package/dist/desktop.d.ts.map +1 -1
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/enums/ProcessingStatusCode.html +16 -16
  5. package/dist/docs/enums/SortOrder.html +3 -3
  6. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  7. package/dist/docs/hierarchy.html +1 -1
  8. package/dist/docs/index.html +2 -2
  9. package/dist/docs/interfaces/AIClient.html +4 -4
  10. package/dist/docs/interfaces/ActionContext.html +4 -4
  11. package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
  12. package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
  13. package/dist/docs/interfaces/ChatMessage.html +6 -6
  14. package/dist/docs/interfaces/Colorful.html +3 -3
  15. package/dist/docs/interfaces/Concept.html +12 -12
  16. package/dist/docs/interfaces/Desktop.html +90 -94
  17. package/dist/docs/interfaces/DesktopActionContext.html +7 -7
  18. package/dist/docs/interfaces/DesktopSettings.html +5 -5
  19. package/dist/docs/interfaces/FetchOptions.html +4 -4
  20. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  21. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  22. package/dist/docs/interfaces/Inheritance.html +5 -5
  23. package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
  24. package/dist/docs/interfaces/NativeFilterScope.html +2 -2
  25. package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
  26. package/dist/docs/interfaces/Ontology.html +23 -23
  27. package/dist/docs/interfaces/OsAPIClient.html +6 -6
  28. package/dist/docs/interfaces/ProcessingStatus.html +7 -7
  29. package/dist/docs/interfaces/Property.html +5 -5
  30. package/dist/docs/interfaces/RecordData.html +5 -5
  31. package/dist/docs/interfaces/RecordProvider.html +6 -6
  32. package/dist/docs/interfaces/RefObject.html +3 -3
  33. package/dist/docs/interfaces/Relationship.html +20 -20
  34. package/dist/docs/interfaces/SavedDatasource.html +2 -2
  35. package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
  36. package/dist/docs/interfaces/SavedSearchContent.html +2 -2
  37. package/dist/docs/interfaces/SavedSetContent.html +2 -2
  38. package/dist/docs/interfaces/SearchOptions.html +3 -3
  39. package/dist/docs/interfaces/SearchProps.html +8 -8
  40. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  41. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  42. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  43. package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
  44. package/dist/docs/interfaces/StreamTextOptions.html +5 -5
  45. package/dist/docs/interfaces/StylerContext.html +11 -11
  46. package/dist/docs/interfaces/TagAttributes.html +7 -7
  47. package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
  48. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  49. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  50. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  51. package/dist/docs/modules.html +2 -2
  52. package/dist/docs/types/ActionHandler.html +2 -2
  53. package/dist/docs/types/AddCommentParams.html +2 -2
  54. package/dist/docs/types/AddListener.html +2 -2
  55. package/dist/docs/types/ApiErrorResult.html +2 -2
  56. package/dist/docs/types/ApiResult.html +2 -2
  57. package/dist/docs/types/ApiSuccessResult.html +2 -2
  58. package/dist/docs/types/App.html +2 -2
  59. package/dist/docs/types/AppRegistry.html +2 -2
  60. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  61. package/dist/docs/types/AppServiceCallProps.html +2 -2
  62. package/dist/docs/types/AsyncFilter.html +2 -2
  63. package/dist/docs/types/AttachmentResponseType.html +2 -2
  64. package/dist/docs/types/AttachmentType.html +2 -2
  65. package/dist/docs/types/Behaviour.html +2 -2
  66. package/dist/docs/types/BinaryOperator.html +2 -2
  67. package/dist/docs/types/Callback.html +2 -2
  68. package/dist/docs/types/ChatModel.html +2 -2
  69. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  70. package/dist/docs/types/Comparator.html +2 -2
  71. package/dist/docs/types/ConceptFilter.html +2 -2
  72. package/dist/docs/types/ConceptMap.html +2 -2
  73. package/dist/docs/types/ConceptName.html +1 -1
  74. package/dist/docs/types/ConceptWithParents.html +2 -2
  75. package/dist/docs/types/ConnectedEntity.html +2 -2
  76. package/dist/docs/types/ContextMenuGroup.html +2 -2
  77. package/dist/docs/types/ContextMenuLabels.html +2 -2
  78. package/dist/docs/types/ContextMenuOptions.html +2 -2
  79. package/dist/docs/types/ContextMenuParams.html +2 -2
  80. package/dist/docs/types/ContextMenuRequest.html +2 -2
  81. package/dist/docs/types/CopyOptions.html +2 -2
  82. package/dist/docs/types/CreateEntityFormProps.html +2 -2
  83. package/dist/docs/types/CreateLinkChartFn.html +1 -1
  84. package/dist/docs/types/CreateLinkChartParams.html +1 -1
  85. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  86. package/dist/docs/types/CustomEventListener.html +2 -2
  87. package/dist/docs/types/CustomTemplate.html +2 -2
  88. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  89. package/dist/docs/types/DataContextType.html +2 -2
  90. package/dist/docs/types/DataMask.html +1 -1
  91. package/dist/docs/types/DesktopAction.html +2 -2
  92. package/dist/docs/types/DesktopActionFilter.html +2 -2
  93. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  94. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  95. package/dist/docs/types/DesktopActionOptions.html +2 -2
  96. package/dist/docs/types/DesktopOpenParams.html +2 -2
  97. package/dist/docs/types/DesktopStylerContext.html +2 -2
  98. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  99. package/dist/docs/types/DragEndParams.html +2 -2
  100. package/dist/docs/types/DragStartParams.html +2 -2
  101. package/dist/docs/types/DropZoneRequestFn.html +1 -1
  102. package/dist/docs/types/DropZoneRequestResult.html +1 -1
  103. package/dist/docs/types/EConnection.html +2 -2
  104. package/dist/docs/types/EdgeSpec.html +2 -2
  105. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  106. package/dist/docs/types/Entity.html +2 -2
  107. package/dist/docs/types/EntityBase.html +2 -2
  108. package/dist/docs/types/EntityEdge.html +2 -2
  109. package/dist/docs/types/EntityOTM.html +2 -2
  110. package/dist/docs/types/EntityPasteContext.html +2 -2
  111. package/dist/docs/types/EvalContext.html +1 -1
  112. package/dist/docs/types/EventContextType.html +2 -2
  113. package/dist/docs/types/EventEmitterType.html +2 -2
  114. package/dist/docs/types/EventName.html +2 -2
  115. package/dist/docs/types/EventProducer.html +2 -2
  116. package/dist/docs/types/EventPublisher.html +2 -2
  117. package/dist/docs/types/EventSubscriber.html +2 -2
  118. package/dist/docs/types/EventUnsubscriber.html +2 -2
  119. package/dist/docs/types/ExportOptions.html +2 -2
  120. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  121. package/dist/docs/types/ExtrasApi.html +1 -1
  122. package/dist/docs/types/FetchEntityOptions.html +2 -2
  123. package/dist/docs/types/FileCode.html +2 -2
  124. package/dist/docs/types/FileTreeOptions.html +2 -2
  125. package/dist/docs/types/Filter.html +1 -1
  126. package/dist/docs/types/FilterDefinition.html +2 -2
  127. package/dist/docs/types/FilterDefinitions.html +2 -2
  128. package/dist/docs/types/FilterName.html +2 -2
  129. package/dist/docs/types/FilterReference.html +2 -2
  130. package/dist/docs/types/FilterState.html +1 -1
  131. package/dist/docs/types/FocusListItem.html +2 -2
  132. package/dist/docs/types/FolderPasteOptions.html +2 -2
  133. package/dist/docs/types/GraphDataSpec.html +1 -1
  134. package/dist/docs/types/GraphSpec.html +2 -2
  135. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  136. package/dist/docs/types/Icon.html +2 -2
  137. package/dist/docs/types/IconProps.html +2 -2
  138. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  139. package/dist/docs/types/ImageInfo.html +2 -2
  140. package/dist/docs/types/ImportZipOptions.html +2 -2
  141. package/dist/docs/types/InlineCode.html +2 -2
  142. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  143. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  144. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  145. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  146. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  147. package/dist/docs/types/JavascriptType.html +2 -2
  148. package/dist/docs/types/JobManifest.html +2 -2
  149. package/dist/docs/types/KnownCounts.html +2 -2
  150. package/dist/docs/types/ManifestSecrets.html +1 -1
  151. package/dist/docs/types/ModalTemplateProps.html +2 -2
  152. package/dist/docs/types/NamedEntityGroup.html +2 -2
  153. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  154. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  155. package/dist/docs/types/NunjucksType.html +2 -2
  156. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  157. package/dist/docs/types/OntologyTags.html +2 -2
  158. package/dist/docs/types/OsAuditFields.html +2 -2
  159. package/dist/docs/types/OsConfirmProps.html +2 -2
  160. package/dist/docs/types/OsNotification.html +2 -2
  161. package/dist/docs/types/OsProgress.html +2 -2
  162. package/dist/docs/types/OsTag.html +2 -2
  163. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  164. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  165. package/dist/docs/types/PasteContextOptions.html +2 -2
  166. package/dist/docs/types/Permission.html +2 -2
  167. package/dist/docs/types/Point.html +2 -2
  168. package/dist/docs/types/PromptOptions.html +2 -2
  169. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  170. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  171. package/dist/docs/types/Query.html +2 -2
  172. package/dist/docs/types/QueryBatchResult.html +2 -2
  173. package/dist/docs/types/QueryErrorResult.html +2 -2
  174. package/dist/docs/types/QueryExecutor.html +2 -2
  175. package/dist/docs/types/QueryObjectFilterClause.html +2 -2
  176. package/dist/docs/types/QueryResponse.html +2 -2
  177. package/dist/docs/types/QueryResult.html +2 -2
  178. package/dist/docs/types/QuerySuccessResult.html +2 -2
  179. package/dist/docs/types/ReactCssProperties.html +2 -2
  180. package/dist/docs/types/ReactNode.html +2 -2
  181. package/dist/docs/types/ReactRef.html +2 -2
  182. package/dist/docs/types/ReasonedBoolean.html +2 -2
  183. package/dist/docs/types/RecordFetchOptions.html +1 -1
  184. package/dist/docs/types/RefCallback.html +2 -2
  185. package/dist/docs/types/RelationshipCountResult.html +2 -2
  186. package/dist/docs/types/RemoteAppApi.html +1 -1
  187. package/dist/docs/types/SaveAsModalProps.html +2 -2
  188. package/dist/docs/types/SaveFileOptions.html +2 -2
  189. package/dist/docs/types/SaveOptions.html +2 -2
  190. package/dist/docs/types/SavedTemplate.html +4 -3
  191. package/dist/docs/types/SearchFilter.html +2 -2
  192. package/dist/docs/types/SemanticBinding.html +2 -2
  193. package/dist/docs/types/SemanticBindingType.html +2 -2
  194. package/dist/docs/types/SemanticBindings.html +2 -2
  195. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  196. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  197. package/dist/docs/types/SendQueryOptions.html +2 -2
  198. package/dist/docs/types/ServiceDefinition.html +2 -2
  199. package/dist/docs/types/ServiceDefinitions.html +2 -2
  200. package/dist/docs/types/ServiceRole.html +2 -2
  201. package/dist/docs/types/SetTransformResultFn.html +1 -1
  202. package/dist/docs/types/ShowOntology.html +2 -2
  203. package/dist/docs/types/ShowTabProps.html +2 -2
  204. package/dist/docs/types/Styler.html +2 -2
  205. package/dist/docs/types/StylerConfig.html +2 -2
  206. package/dist/docs/types/StylerDefinition.html +2 -2
  207. package/dist/docs/types/StylerDefinitions.html +2 -2
  208. package/dist/docs/types/StylerOption.html +2 -2
  209. package/dist/docs/types/StylerProducer.html +2 -2
  210. package/dist/docs/types/SubscribeDragStartFn.html +1 -1
  211. package/dist/docs/types/SubscribeToContextFn.html +1 -1
  212. package/dist/docs/types/Tag.html +2 -2
  213. package/dist/docs/types/TagInfo.html +2 -2
  214. package/dist/docs/types/TagWithRelationship.html +2 -2
  215. package/dist/docs/types/TaskCleanupReason.html +2 -2
  216. package/dist/docs/types/TemplateMetadata.html +2 -2
  217. package/dist/docs/types/TemplateType.html +2 -2
  218. package/dist/docs/types/TemplateVariant.html +2 -2
  219. package/dist/docs/types/TransformAction.html +2 -2
  220. package/dist/docs/types/TransformActionContext.html +2 -2
  221. package/dist/docs/types/TransformDefinition.html +2 -2
  222. package/dist/docs/types/TransformDefinitions.html +2 -2
  223. package/dist/docs/types/Unsubscribe.html +2 -2
  224. package/dist/docs/types/UnsubscribeFn.html +1 -1
  225. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
  226. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
  227. package/dist/docs/types/UserProfile.html +2 -2
  228. package/dist/docs/types/Watcher.html +2 -2
  229. package/dist/docs/types/Whoami.html +2 -2
  230. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  231. package/dist/docs/types/Workspace.html +2 -2
  232. package/dist/docs/types/WorkspaceConfig.html +1 -1
  233. package/dist/docs/types/WorkspaceFlags.html +2 -2
  234. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  235. package/dist/docs/types/WorkspaceItem.html +2 -2
  236. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  237. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  238. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  239. package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
  240. package/dist/docs/types/WorkspaceItems.html +2 -2
  241. package/dist/docs/types/WorkspacePermission.html +2 -2
  242. package/dist/docs/types/WorkspaceRecord.html +2 -2
  243. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  244. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  245. package/dist/docs/types/WorkspaceRecords.html +2 -2
  246. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  247. package/dist/docs/types/WorkspaceSettings.html +2 -2
  248. package/dist/docs/types/trigger.html +2 -2
  249. package/dist/docs/types/uuid.html +2 -2
  250. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  251. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  252. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  253. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
  254. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
  255. package/dist/platform-types.d.ts +4 -8
  256. package/dist/templates.d.ts +4 -0
  257. package/dist/templates.d.ts.map +1 -1
  258. package/package.json +2 -2
package/dist/docs/interfaces/Relationship.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>Relationship | @octostar/platform-types - v0.5.7</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.7</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="Relationship.html">Relationship</a></li></ul><h1>Interface Relationship<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a relationship between concepts.</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Relationship</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#additional_properties">additional_properties</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="Relationship.html#concept">concept</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#datasource_id">datasource_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#description">description</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="Relationship.html#inverse_name">inverse_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#is_inverse">is_inverse</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="Relationship.html#is_mtm">is_mtm</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="Relationship.html#key">key</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="Relationship.html#mapping_json">mapping_json</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="Relationship.html#mapping_name">mapping_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#mapping_query">mapping_query</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="Relationship.html#relationship_name">relationship_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#sort_order">sort_order</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="Relationship.html#source_properties">source_properties</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="Relationship.html#tables">tables</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="Relationship.html#target_concept">target_concept</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#target_properties">target_properties</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="Relationship.html#transitivity">transitivity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L217">model.ts:217</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Relationship.html#additional_properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional_<wbr/>properties</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>Relationship | @octostar/platform-types - v0.5.9</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.9</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="Relationship.html">Relationship</a></li></ul><h1>Interface Relationship<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a relationship between concepts.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Relationship</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#additional_properties">additional_properties</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="Relationship.html#concept">concept</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#datasource_id">datasource_id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#description">description</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="Relationship.html#inverse_name">inverse_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#is_inverse">is_inverse</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="Relationship.html#is_mtm">is_mtm</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="Relationship.html#key">key</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="Relationship.html#mapping_json">mapping_json</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="Relationship.html#mapping_name">mapping_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#mapping_query">mapping_query</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="Relationship.html#relationship_name">relationship_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#sort_order">sort_order</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="Relationship.html#source_properties">source_properties</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="Relationship.html#tables">tables</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="Relationship.html#target_concept">target_concept</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Relationship.html#target_properties">target_properties</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="Relationship.html#transitivity">transitivity</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L217">model.ts:217</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Relationship.html#additional_properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional_<wbr/>properties</span></a>
3
3
  <a href="Relationship.html#concept" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>concept</span></a>
4
4
  <a href="Relationship.html#datasource_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>datasource_<wbr/>id</span></a>
5
5
  <a href="Relationship.html#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a>
@@ -18,21 +18,21 @@
18
18
  <a href="Relationship.html#target_properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target_<wbr/>properties</span></a>
19
19
  <a href="Relationship.html#transitivity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transitivity</span></a>
20
20
  </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="additional_properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>additional_<wbr/>properties</span><a href="#additional_properties" 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">additional_<wbr/>properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Additional properties associated with the relationship.</p>
21
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L261">model.ts:261</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>concept</span><a href="#concept" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Source concept in the relationship.</p>
22
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L226">model.ts:226</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="datasource_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>datasource_<wbr/>id</span><a href="#datasource_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">datasource_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Identifier for the data source.</p>
23
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L296">model.ts:296</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Description of the relationship (optional).</p>
24
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L306">model.ts:306</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inverse_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>inverse_<wbr/>name</span><a href="#inverse_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inverse_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Inverse name of the relationship.</p>
25
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L241">model.ts:241</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_inverse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>is_<wbr/>inverse</span><a href="#is_inverse" 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">is_<wbr/>inverse</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the relationship is inverse (1 for true, 0 for false).</p>
26
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L281">model.ts:281</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_mtm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>is_<wbr/>mtm</span><a href="#is_mtm" 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">is_<wbr/>mtm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the relationship is many-to-many (1 for true, 0 for false).</p>
27
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L286">model.ts:286</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>key</span><a href="#key" 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">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Unique identifier for the relationship.</p>
28
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L221">model.ts:221</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_json" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>json</span><a href="#mapping_json" 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">mapping_<wbr/>json</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>JSON representation of the mapping.</p>
29
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L276">model.ts:276</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>name</span><a href="#mapping_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mapping_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the mapping.</p>
30
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L256">model.ts:256</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>query</span><a href="#mapping_query" 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">mapping_<wbr/>query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Query used for mapping the relationship.</p>
31
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L266">model.ts:266</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="relationship_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>relationship_<wbr/>name</span><a href="#relationship_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">relationship_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the relationship.</p>
32
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L236">model.ts:236</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sort_order" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>sort_<wbr/>order</span><a href="#sort_order" 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">sort_<wbr/>order</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Sort order for the relationship.</p>
33
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L301">model.ts:301</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="source_properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>source_<wbr/>properties</span><a href="#source_properties" 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">source_<wbr/>properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Properties of the source concept.</p>
34
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L246">model.ts:246</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tables" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>tables</span><a href="#tables" 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">tables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Tables involved in the relationship.</p>
35
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L271">model.ts:271</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="target_concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>target_<wbr/>concept</span><a href="#target_concept" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">target_<wbr/>concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Target concept in the relationship.</p>
36
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L231">model.ts:231</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="target_properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>target_<wbr/>properties</span><a href="#target_properties" 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">target_<wbr/>properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Properties of the target concept.</p>
37
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L251">model.ts:251</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transitivity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>transitivity</span><a href="#transitivity" 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">transitivity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Transitivity property of the relationship.</p>
38
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/model.ts#L291">model.ts:291</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#additional_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional_<wbr/>properties</span></a><a href="#concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>concept</span></a><a href="#datasource_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>datasource_<wbr/>id</span></a><a href="#description" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#inverse_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inverse_<wbr/>name</span></a><a href="#is_inverse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>inverse</span></a><a href="#is_mtm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mtm</span></a><a href="#key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#mapping_json" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>json</span></a><a href="#mapping_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>name</span></a><a href="#mapping_query" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>query</span></a><a href="#relationship_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship_<wbr/>name</span></a><a href="#sort_order" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort_<wbr/>order</span></a><a href="#source_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source_<wbr/>properties</span></a><a href="#tables" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tables</span></a><a href="#target_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target_<wbr/>concept</span></a><a href="#target_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target_<wbr/>properties</span></a><a href="#transitivity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transitivity</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.7</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>
21
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L261">model.ts:261</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>concept</span><a href="#concept" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Source concept in the relationship.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L226">model.ts:226</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="datasource_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>datasource_<wbr/>id</span><a href="#datasource_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">datasource_<wbr/>id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Identifier for the data source.</p>
23
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L296">model.ts:296</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Description of the relationship (optional).</p>
24
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L306">model.ts:306</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inverse_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>inverse_<wbr/>name</span><a href="#inverse_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inverse_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Inverse name of the relationship.</p>
25
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L241">model.ts:241</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_inverse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>is_<wbr/>inverse</span><a href="#is_inverse" 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">is_<wbr/>inverse</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the relationship is inverse (1 for true, 0 for false).</p>
26
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L281">model.ts:281</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="is_mtm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>is_<wbr/>mtm</span><a href="#is_mtm" 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">is_<wbr/>mtm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the relationship is many-to-many (1 for true, 0 for false).</p>
27
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L286">model.ts:286</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>key</span><a href="#key" 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">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Unique identifier for the relationship.</p>
28
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L221">model.ts:221</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_json" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>json</span><a href="#mapping_json" 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">mapping_<wbr/>json</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>JSON representation of the mapping.</p>
29
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L276">model.ts:276</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>name</span><a href="#mapping_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mapping_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the mapping.</p>
30
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L256">model.ts:256</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mapping_query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>mapping_<wbr/>query</span><a href="#mapping_query" 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">mapping_<wbr/>query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Query used for mapping the relationship.</p>
31
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L266">model.ts:266</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="relationship_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>relationship_<wbr/>name</span><a href="#relationship_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">relationship_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the relationship.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L236">model.ts:236</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sort_order" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>sort_<wbr/>order</span><a href="#sort_order" 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">sort_<wbr/>order</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Sort order for the relationship.</p>
33
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L301">model.ts:301</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="source_properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>source_<wbr/>properties</span><a href="#source_properties" 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">source_<wbr/>properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Properties of the source concept.</p>
34
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L246">model.ts:246</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tables" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>tables</span><a href="#tables" 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">tables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Tables involved in the relationship.</p>
35
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L271">model.ts:271</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="target_concept" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>target_<wbr/>concept</span><a href="#target_concept" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">target_<wbr/>concept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Target concept in the relationship.</p>
36
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L231">model.ts:231</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="target_properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>target_<wbr/>properties</span><a href="#target_properties" 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">target_<wbr/>properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Properties of the target concept.</p>
37
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L251">model.ts:251</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transitivity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Beta</code><span>transitivity</span><a href="#transitivity" 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">transitivity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Transitivity property of the relationship.</p>
38
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/model.ts#L291">model.ts:291</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#additional_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional_<wbr/>properties</span></a><a href="#concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>concept</span></a><a href="#datasource_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>datasource_<wbr/>id</span></a><a href="#description" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#inverse_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inverse_<wbr/>name</span></a><a href="#is_inverse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>inverse</span></a><a href="#is_mtm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>mtm</span></a><a href="#key" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#mapping_json" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>json</span></a><a href="#mapping_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>name</span></a><a href="#mapping_query" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mapping_<wbr/>query</span></a><a href="#relationship_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship_<wbr/>name</span></a><a href="#sort_order" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort_<wbr/>order</span></a><a href="#source_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source_<wbr/>properties</span></a><a href="#tables" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tables</span></a><a href="#target_concept" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target_<wbr/>concept</span></a><a href="#target_properties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target_<wbr/>properties</span></a><a href="#transitivity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transitivity</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.9</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/SavedDatasource.html CHANGED
@@ -1,7 +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>SavedDatasource | @octostar/platform-types - v0.5.7</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.7</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="SavedDatasource.html">SavedDatasource</a></li></ul><h1>Interface SavedDatasource</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedDatasource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#id">id</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="SavedDatasource.html#main_dttm_col">main_dttm_col</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="SavedDatasource.html#name">name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#table_name">table_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#type">type</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="SavedDatasource.html#uid">uid</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L12">savedSearch.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SavedDatasource.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SavedDatasource | @octostar/platform-types - v0.5.9</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.9</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="SavedDatasource.html">SavedDatasource</a></li></ul><h1>Interface SavedDatasource</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedDatasource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#id">id</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="SavedDatasource.html#main_dttm_col">main_dttm_col</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="SavedDatasource.html#name">name</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#table_name">table_name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="SavedDatasource.html#type">type</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="SavedDatasource.html#uid">uid</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L12">savedSearch.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="SavedDatasource.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
2
2
  <a href="SavedDatasource.html#main_dttm_col" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main_<wbr/>dttm_<wbr/>col</span></a>
3
3
  <a href="SavedDatasource.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name?</span></a>
4
4
  <a href="SavedDatasource.html#table_name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table_<wbr/>name</span></a>
5
5
  <a href="SavedDatasource.html#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>type</span></a>
6
6
  <a href="SavedDatasource.html#uid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L14">savedSearch.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="main_dttm_col" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>main_<wbr/>dttm_<wbr/>col</span><a href="#main_dttm_col" 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">main_<wbr/>dttm_<wbr/>col</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L18">savedSearch.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L15">savedSearch.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="table_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>table_<wbr/>name</span><a href="#table_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">table_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L16">savedSearch.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L17">savedSearch.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uid</span><a href="#uid" 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">uid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L13">savedSearch.ts:13</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#main_dttm_col" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main_<wbr/>dttm_<wbr/>col</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#table_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table_<wbr/>name</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</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.7</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>
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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L14">savedSearch.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="main_dttm_col" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>main_<wbr/>dttm_<wbr/>col</span><a href="#main_dttm_col" 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">main_<wbr/>dttm_<wbr/>col</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L18">savedSearch.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L15">savedSearch.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="table_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>table_<wbr/>name</span><a href="#table_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">table_<wbr/>name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L16">savedSearch.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L17">savedSearch.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uid</span><a href="#uid" 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">uid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L13">savedSearch.ts:13</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#main_dttm_col" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>main_<wbr/>dttm_<wbr/>col</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#table_name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table_<wbr/>name</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</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.9</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/SavedSearchAPIInterface.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SavedSearchAPIInterface | @octostar/platform-types - v0.5.7</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.7</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="SavedSearchAPIInterface.html">SavedSearchAPIInterface</a></li></ul><h1>Interface SavedSearchAPIInterface</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedSearchAPIInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecords.getRecords-1">getRecords</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsCount.getRecordsCount-1">getRecordsCount</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsCountQuery.getRecordsCountQuery-1">getRecordsCountQuery</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsQuery.getRecordsQuery-1">getRecordsQuery</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getSavedSearchPasteContext.getSavedSearchPasteContext-1">getSavedSearchPasteContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><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/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L143">savedSearch.ts:143</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="SavedSearchAPIInterface.html#getRecords" 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/>Records</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>SavedSearchAPIInterface | @octostar/platform-types - v0.5.9</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.9</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="SavedSearchAPIInterface.html">SavedSearchAPIInterface</a></li></ul><h1>Interface SavedSearchAPIInterface</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SavedSearchAPIInterface</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecords.getRecords-1">getRecords</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsCount.getRecordsCount-1">getRecordsCount</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsCountQuery.getRecordsCountQuery-1">getRecordsCountQuery</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getRecordsQuery.getRecordsQuery-1">getRecordsQuery</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="SavedSearchAPIInterface.html#getSavedSearchPasteContext.getSavedSearchPasteContext-1">getSavedSearchPasteContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</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><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><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/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L143">savedSearch.ts:143</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="SavedSearchAPIInterface.html#getRecords" 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/>Records</span></a>
2
2
  <a href="SavedSearchAPIInterface.html#getRecordsCount" 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/>Records<wbr/>Count</span></a>
3
3
  <a href="SavedSearchAPIInterface.html#getRecordsCountQuery" 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/>Records<wbr/>Count<wbr/>Query</span></a>
4
4
  <a href="SavedSearchAPIInterface.html#getRecordsQuery" 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/>Records<wbr/>Query</span></a>
5
5
  <a href="SavedSearchAPIInterface.html#getSavedSearchPasteContext" 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/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records</span><a href="#getRecords" 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="getRecords.getRecords-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span>, <span class="tsd-kind-parameter">options</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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span><a href="#getRecords.getRecords-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">&gt;</span></span></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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L152">savedSearch.ts:152</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count</span><a href="#getRecordsCount" 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="getRecordsCount.getRecordsCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsCount.getRecordsCount-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L144">savedSearch.ts:144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsCountQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span><a href="#getRecordsCountQuery" 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="getRecordsCountQuery.getRecordsCountQuery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Count<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsCountQuery.getRecordsCountQuery-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L148">savedSearch.ts:148</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Query</span><a href="#getRecordsQuery" 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="getRecordsQuery.getRecordsQuery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span>, <span class="tsd-kind-parameter">options</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsQuery.getRecordsQuery-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a></span></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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L157">savedSearch.ts:157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSavedSearchPasteContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><a href="#getSavedSearchPasteContext" 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="getSavedSearchPasteContext.getSavedSearchPasteContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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 href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><span class="tsd-signature-symbol">&gt;</span><a href="#getSavedSearchPasteContext.getSavedSearchPasteContext-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ef1cc6bb49a33cde2a63569479a2bd1921c7d97d/packages/octostar-platform-types/src/savedSearch.ts#L162">savedSearch.ts:162</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="#getRecords" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records</span></a><a href="#getRecordsCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Count</span></a><a href="#getRecordsCountQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span></a><a href="#getRecordsQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Query</span></a><a href="#getSavedSearchPasteContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</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.7</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records</span><a href="#getRecords" 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="getRecords.getRecords-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span>, <span class="tsd-kind-parameter">options</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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span><a href="#getRecords.getRecords-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a><span class="tsd-signature-symbol">&gt;</span></span></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">null</span><span class="tsd-signature-symbol"> | </span><a href="RecordData.html" class="tsd-signature-type tsd-kind-interface">RecordData</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L152">savedSearch.ts:152</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count</span><a href="#getRecordsCount" 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="getRecordsCount.getRecordsCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsCount.getRecordsCount-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L144">savedSearch.ts:144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsCountQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span><a href="#getRecordsCountQuery" 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="getRecordsCountQuery.getRecordsCountQuery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Count<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsCountQuery.getRecordsCountQuery-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L148">savedSearch.ts:148</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>Query</span><a href="#getRecordsQuery" 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="getRecordsQuery.getRecordsQuery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</span>, <span class="tsd-kind-parameter">options</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordsQuery.getRecordsQuery-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/RecordFetchOptions.html" class="tsd-signature-type tsd-kind-type-alias">RecordFetchOptions</a></span></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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">QueryResult</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L157">savedSearch.ts:157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSavedSearchPasteContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><a href="#getSavedSearchPasteContext" 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="getSavedSearchPasteContext.getSavedSearchPasteContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">savedSearchIdn</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 href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><span class="tsd-signature-symbol">&gt;</span><a href="#getSavedSearchPasteContext.getSavedSearchPasteContext-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"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">savedSearchIdn</span>: <a href="../types/WorkspaceItemIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemIdentifier</a><span class="tsd-signature-symbol">&lt;</span><a href="SavedSearchContent.html" class="tsd-signature-type tsd-kind-interface">SavedSearchContent</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EntityPasteContext.html" class="tsd-signature-type tsd-kind-type-alias">EntityPasteContext</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/ee83a54a8d94131350269e7d6aa6ccf1da5029a6/packages/octostar-platform-types/src/savedSearch.ts#L162">savedSearch.ts:162</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="#getRecords" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records</span></a><a href="#getRecordsCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Count</span></a><a href="#getRecordsCountQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Count<wbr/>Query</span></a><a href="#getRecordsQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>Query</span></a><a href="#getSavedSearchPasteContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Saved<wbr/>Search<wbr/>Paste<wbr/>Context</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.9</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>