@octostar/platform-types 0.5.25 → 0.5.27
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.
- package/dist/desktop.d.ts +37 -1
- package/dist/desktop.d.ts.map +1 -1
- package/dist/desktop.js.map +1 -1
- package/dist/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/enums/ProcessingStatusCode.html +16 -16
- package/dist/docs/enums/SortOrder.html +3 -3
- package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
- package/dist/docs/hierarchy.html +1 -1
- package/dist/docs/index.html +2 -2
- package/dist/docs/interfaces/AIClient.html +4 -4
- package/dist/docs/interfaces/ActionContext.html +4 -4
- package/dist/docs/interfaces/BinaryObjectFilterClause.html +3 -3
- package/dist/docs/interfaces/ChartDataResponseResult.html +5 -5
- package/dist/docs/interfaces/ChatMessage.html +6 -6
- package/dist/docs/interfaces/Colorful.html +3 -3
- package/dist/docs/interfaces/Concept.html +12 -12
- package/dist/docs/interfaces/DeleteResponse.html +2 -2
- package/dist/docs/interfaces/Desktop.html +89 -87
- package/dist/docs/interfaces/DesktopActionContext.html +7 -7
- package/dist/docs/interfaces/DesktopSettings.html +5 -5
- package/dist/docs/interfaces/DownloadOptions.html +2 -2
- package/dist/docs/interfaces/FetchOptions.html +4 -4
- package/dist/docs/interfaces/FileListResponse.html +2 -2
- package/dist/docs/interfaces/FilesAPIClient.html +50 -0
- package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
- package/dist/docs/interfaces/IDataTransfer.html +11 -11
- package/dist/docs/interfaces/Inheritance.html +5 -5
- package/dist/docs/interfaces/LiveContext.html +11 -11
- package/dist/docs/interfaces/MoveOptions.html +2 -2
- package/dist/docs/interfaces/MoveResponse.html +5 -5
- package/dist/docs/interfaces/NativeFilterColumn.html +2 -2
- package/dist/docs/interfaces/NativeFilterScope.html +2 -2
- package/dist/docs/interfaces/NativeFilterTarget.html +2 -2
- package/dist/docs/interfaces/Ontology.html +23 -23
- package/dist/docs/interfaces/OsAPIClient.html +6 -6
- package/dist/docs/interfaces/ProcessingStatus.html +7 -7
- package/dist/docs/interfaces/Property.html +5 -5
- package/dist/docs/interfaces/RecordData.html +5 -5
- package/dist/docs/interfaces/RecordProvider.html +6 -6
- package/dist/docs/interfaces/RefObject.html +3 -3
- package/dist/docs/interfaces/Relationship.html +20 -20
- package/dist/docs/interfaces/SavedDatasource.html +2 -2
- package/dist/docs/interfaces/SavedSearchAPIInterface.html +2 -2
- package/dist/docs/interfaces/SavedSearchContent.html +2 -2
- package/dist/docs/interfaces/SavedSetContent.html +2 -2
- package/dist/docs/interfaces/SearchOptions.html +3 -3
- package/dist/docs/interfaces/SearchProps.html +8 -8
- package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
- package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
- package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
- package/dist/docs/interfaces/StreamJsonOptions.html +5 -5
- package/dist/docs/interfaces/StreamTextOptions.html +5 -5
- package/dist/docs/interfaces/StylerContext.html +11 -11
- package/dist/docs/interfaces/TagAttributes.html +7 -7
- package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
- package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
- package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
- package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
- package/dist/docs/modules.html +5 -3
- package/dist/docs/types/ActionHandler.html +2 -2
- package/dist/docs/types/AddCommentParams.html +2 -2
- package/dist/docs/types/AddListener.html +2 -2
- package/dist/docs/types/ApiErrorResult.html +2 -2
- package/dist/docs/types/ApiResult.html +2 -2
- package/dist/docs/types/ApiSuccessResult.html +2 -2
- package/dist/docs/types/App.html +2 -2
- package/dist/docs/types/AppRegistry.html +2 -2
- package/dist/docs/types/AppServiceCallOptions.html +2 -2
- package/dist/docs/types/AppServiceCallProps.html +2 -2
- package/dist/docs/types/AsyncFilter.html +2 -2
- package/dist/docs/types/AttachmentResponseType.html +2 -2
- package/dist/docs/types/AttachmentType.html +2 -2
- package/dist/docs/types/Behaviour.html +2 -2
- package/dist/docs/types/BinaryOperator.html +2 -2
- package/dist/docs/types/Callback.html +2 -2
- package/dist/docs/types/ChatModel.html +2 -2
- package/dist/docs/types/CommentWorkspaceItem.html +2 -2
- package/dist/docs/types/CommonOptions.html +1 -1
- package/dist/docs/types/Comparator.html +2 -2
- package/dist/docs/types/ConceptFilter.html +2 -2
- package/dist/docs/types/ConceptMap.html +2 -2
- package/dist/docs/types/ConceptName.html +1 -1
- package/dist/docs/types/ConceptWithParents.html +2 -2
- package/dist/docs/types/ConnectedEntity.html +2 -2
- package/dist/docs/types/ContextMenuGroup.html +2 -2
- package/dist/docs/types/ContextMenuLabels.html +2 -2
- package/dist/docs/types/ContextMenuOptions.html +2 -2
- package/dist/docs/types/ContextMenuParams.html +2 -2
- package/dist/docs/types/ContextMenuRequest.html +2 -2
- package/dist/docs/types/CopyOptions.html +2 -2
- package/dist/docs/types/CreateEntityFormProps.html +2 -2
- package/dist/docs/types/CreateLinkChartFn.html +1 -1
- package/dist/docs/types/CreateLinkChartParams.html +1 -1
- package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
- package/dist/docs/types/CustomEventListener.html +2 -2
- package/dist/docs/types/CustomTemplate.html +2 -2
- package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
- package/dist/docs/types/DataContextType.html +2 -2
- package/dist/docs/types/DataMask.html +1 -1
- package/dist/docs/types/DefaultLiveContextData.html +1 -1
- package/dist/docs/types/DesktopAction.html +2 -2
- package/dist/docs/types/DesktopActionFilter.html +2 -2
- package/dist/docs/types/DesktopActionMenuItem.html +8 -3
- package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
- package/dist/docs/types/DesktopActionOptions.html +2 -2
- package/dist/docs/types/DesktopOpenParams.html +2 -2
- package/dist/docs/types/DesktopStylerContext.html +2 -2
- package/dist/docs/types/DraftWorkspaceItem.html +2 -2
- package/dist/docs/types/DragEndParams.html +2 -2
- package/dist/docs/types/DragStartParams.html +2 -2
- package/dist/docs/types/DropZoneRequestFn.html +1 -1
- package/dist/docs/types/DropZoneRequestResult.html +1 -1
- package/dist/docs/types/EConnection.html +2 -2
- package/dist/docs/types/EdgeSpec.html +2 -2
- package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
- package/dist/docs/types/Entity.html +2 -2
- package/dist/docs/types/EntityBase.html +2 -2
- package/dist/docs/types/EntityEdge.html +2 -2
- package/dist/docs/types/EntityOTM.html +2 -2
- package/dist/docs/types/EntityPasteContext.html +2 -2
- package/dist/docs/types/EvalContext.html +1 -1
- package/dist/docs/types/EventContextType.html +2 -2
- package/dist/docs/types/EventEmitterType.html +2 -2
- package/dist/docs/types/EventName.html +2 -2
- package/dist/docs/types/EventProducer.html +2 -2
- package/dist/docs/types/EventPublisher.html +2 -2
- package/dist/docs/types/EventSubscriber.html +2 -2
- package/dist/docs/types/EventUnsubscriber.html +2 -2
- package/dist/docs/types/ExportOptions.html +2 -2
- package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
- package/dist/docs/types/ExtrasApi.html +1 -1
- package/dist/docs/types/FetchEntityOptions.html +2 -2
- package/dist/docs/types/FileCode.html +2 -2
- package/dist/docs/types/FileTreeOptions.html +2 -2
- package/dist/docs/types/Filter.html +1 -1
- package/dist/docs/types/FilterDefinition.html +2 -2
- package/dist/docs/types/FilterDefinitions.html +2 -2
- package/dist/docs/types/FilterName.html +2 -2
- package/dist/docs/types/FilterQuery.html +2 -0
- package/dist/docs/types/FilterReference.html +2 -2
- package/dist/docs/types/FilterState.html +1 -1
- package/dist/docs/types/FilterValue.html +2 -0
- package/dist/docs/types/FocusListItem.html +2 -2
- package/dist/docs/types/FolderPasteOptions.html +2 -2
- package/dist/docs/types/GraphDataSpec.html +1 -1
- package/dist/docs/types/GraphSpec.html +2 -2
- package/dist/docs/types/HttpTransformDefinition.html +2 -2
- package/dist/docs/types/Icon.html +2 -2
- package/dist/docs/types/IconProps.html +2 -2
- package/dist/docs/types/IframeTransformDefinition.html +2 -2
- package/dist/docs/types/ImageInfo.html +2 -2
- package/dist/docs/types/ImportZipOptions.html +2 -2
- package/dist/docs/types/InlineCode.html +2 -2
- package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
- package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
- package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
- package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
- package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
- package/dist/docs/types/JavascriptType.html +2 -2
- package/dist/docs/types/JobManifest.html +2 -2
- package/dist/docs/types/KnownCounts.html +2 -2
- package/dist/docs/types/ListByParentFolder.html +1 -1
- package/dist/docs/types/ListByPath.html +1 -1
- package/dist/docs/types/ListFolderOptions.html +1 -1
- package/dist/docs/types/LiveContextAPISetParams.html +1 -1
- package/dist/docs/types/LiveContextListener.html +1 -1
- package/dist/docs/types/ManifestSecrets.html +1 -1
- package/dist/docs/types/MkdirResponse.html +1 -1
- package/dist/docs/types/ModalTemplateProps.html +2 -2
- package/dist/docs/types/NamedEntityGroup.html +2 -2
- package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
- package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
- package/dist/docs/types/NunjucksType.html +2 -2
- package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
- package/dist/docs/types/OntologyTags.html +2 -2
- package/dist/docs/types/OsAuditFields.html +2 -2
- package/dist/docs/types/OsConfirmProps.html +2 -2
- package/dist/docs/types/OsNotification.html +2 -2
- package/dist/docs/types/OsProgress.html +2 -2
- package/dist/docs/types/OsTag.html +2 -2
- package/dist/docs/types/OsWorkspaceEntity.html +2 -2
- package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
- package/dist/docs/types/PasteContextOptions.html +2 -2
- package/dist/docs/types/Permission.html +2 -2
- package/dist/docs/types/Point.html +2 -2
- package/dist/docs/types/PromptOptions.html +2 -2
- package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
- package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
- package/dist/docs/types/Query.html +2 -2
- package/dist/docs/types/QueryBatchResult.html +2 -2
- package/dist/docs/types/QueryErrorResult.html +2 -2
- package/dist/docs/types/QueryExecutor.html +2 -2
- package/dist/docs/types/QueryObjectFilterClause.html +2 -2
- package/dist/docs/types/QueryResponse.html +2 -2
- package/dist/docs/types/QueryResult.html +2 -2
- package/dist/docs/types/QuerySuccessResult.html +2 -2
- package/dist/docs/types/ReactCssProperties.html +2 -2
- package/dist/docs/types/ReactNode.html +2 -2
- package/dist/docs/types/ReactRef.html +2 -2
- package/dist/docs/types/ReasonedBoolean.html +2 -2
- package/dist/docs/types/RecordFetchOptions.html +1 -1
- package/dist/docs/types/RefCallback.html +2 -2
- package/dist/docs/types/RelationshipCountResult.html +2 -2
- package/dist/docs/types/RemoteAppApi.html +1 -1
- package/dist/docs/types/SaveAsModalProps.html +2 -2
- package/dist/docs/types/SaveFileOptions.html +2 -2
- package/dist/docs/types/SaveOptions.html +2 -2
- package/dist/docs/types/SavedTemplate.html +2 -2
- package/dist/docs/types/SearchFilter.html +2 -2
- package/dist/docs/types/SemanticBinding.html +2 -2
- package/dist/docs/types/SemanticBindingType.html +2 -2
- package/dist/docs/types/SemanticBindings.html +2 -2
- package/dist/docs/types/SemanticallyBoundApp.html +2 -2
- package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
- package/dist/docs/types/SendQueryOptions.html +2 -2
- package/dist/docs/types/ServiceDefinition.html +2 -2
- package/dist/docs/types/ServiceDefinitions.html +2 -2
- package/dist/docs/types/ServiceRole.html +2 -2
- package/dist/docs/types/SetTransformResultFn.html +1 -1
- package/dist/docs/types/ShowOntology.html +2 -2
- package/dist/docs/types/ShowTabProps.html +2 -2
- package/dist/docs/types/Styler.html +2 -2
- package/dist/docs/types/StylerConfig.html +2 -2
- package/dist/docs/types/StylerDefinition.html +2 -2
- package/dist/docs/types/StylerDefinitions.html +2 -2
- package/dist/docs/types/StylerOption.html +2 -2
- package/dist/docs/types/StylerProducer.html +2 -2
- package/dist/docs/types/SubscribeDragStartFn.html +1 -1
- package/dist/docs/types/SubscribeToContextFn.html +1 -1
- package/dist/docs/types/Tag.html +2 -2
- package/dist/docs/types/TagInfo.html +2 -2
- package/dist/docs/types/TagWithRelationship.html +2 -2
- package/dist/docs/types/TaskCleanupReason.html +2 -2
- package/dist/docs/types/TemplateMetadata.html +2 -2
- package/dist/docs/types/TemplateType.html +2 -2
- package/dist/docs/types/TemplateVariant.html +2 -2
- package/dist/docs/types/TransformAction.html +2 -2
- package/dist/docs/types/TransformActionContext.html +2 -2
- package/dist/docs/types/TransformDefinition.html +2 -2
- package/dist/docs/types/TransformDefinitions.html +2 -2
- package/dist/docs/types/Unsubscribe.html +2 -2
- package/dist/docs/types/UnsubscribeFn.html +1 -1
- package/dist/docs/types/UnsubscribeFromContextFn.html +1 -1
- package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -1
- package/dist/docs/types/UserProfile.html +2 -2
- package/dist/docs/types/Watcher.html +2 -2
- package/dist/docs/types/Whoami.html +2 -2
- package/dist/docs/types/WithProgressBarOptions.html +2 -2
- package/dist/docs/types/Workspace.html +2 -2
- package/dist/docs/types/WorkspaceConfig.html +1 -1
- package/dist/docs/types/WorkspaceFlags.html +2 -2
- package/dist/docs/types/WorkspaceIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItem.html +2 -2
- package/dist/docs/types/WorkspaceItemBase.html +2 -2
- package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItemModel.html +2 -2
- package/dist/docs/types/WorkspaceItemTitleProps.html +2 -2
- package/dist/docs/types/WorkspaceItems.html +2 -2
- package/dist/docs/types/WorkspacePermission.html +2 -2
- package/dist/docs/types/WorkspaceRecord.html +2 -2
- package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
- package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
- package/dist/docs/types/WorkspaceRecords.html +2 -2
- package/dist/docs/types/WorkspaceRelationship.html +2 -2
- package/dist/docs/types/WorkspaceSettings.html +2 -2
- package/dist/docs/types/trigger.html +2 -2
- package/dist/docs/types/uuid.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
- package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
- package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -1
- package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -1
- package/dist/files.d.ts +36 -12
- package/dist/files.d.ts.map +1 -1
- package/dist/platform-types.d.ts +73 -12
- package/package.json +1 -1
- package/dist/docs/interfaces/Files.html +0 -38
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItemIdentifier | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItemIdentifier | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceItemIdentifier.html">WorkspaceItemIdentifier</a></li></ul><h1>Type Alias WorkspaceItemIdentifier<T><code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Item<wbr/>Identifier</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="WorkspaceItemIdentifier.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <a href="WorkspaceIdentifier.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceIdentifier</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="WorkspaceItemIdentifier.html#T">T</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Type representing a workspace item identifier, which is the same as a workspace identifier.</p>
|
|
2
2
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of the workspace item.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/workspace.ts#L146">workspace.ts:146</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItemModel | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItemModel | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceItemModel.html">WorkspaceItemModel</a></li></ul><h1>Type Alias WorkspaceItemModel<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Item<wbr/>Model</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">__uiState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">autoOpen</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">draft</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getEntities</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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"><</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getEntitiesCount</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">highlight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">initialState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isClosable</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isHidden</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><a href="ConceptFilter.html" class="tsd-signature-type tsd-kind-type-alias">ConceptFilter</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">rename</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">showCountOnlyWhenClosed</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">os_item_name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">os_item_type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Represents the model for a workspace item.</p>
|
|
2
2
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">__ui<wbr/>State</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">autoOpen</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">draft</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getEntities</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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"><</span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">getEntitiesCount</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">highlight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">initialState</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isClosable</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">isHidden</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><a href="ConceptFilter.html" class="tsd-signature-type tsd-kind-type-alias">ConceptFilter</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">rename</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">showCountOnlyWhenClosed</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Ephemeral UI state in lieu of using complex redux logic.
|
|
3
3
|
It is not saved in persistence and can be mutated by components.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">auto<wbr/>Open</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if the item is auto open</p>
|
|
@@ -17,4 +17,4 @@ It is not saved in persistence and can be mutated by components.</p>
|
|
|
17
17
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">show<wbr/>Count<wbr/>Only<wbr/>When<wbr/>Closed</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines if the count is shown only when the item is closed.</p>
|
|
18
18
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">os_<wbr/>item_<wbr/>name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Name of the workspace item.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">os_<wbr/>item_<wbr/>type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Type of the workspace item.</p>
|
|
20
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/model.ts#L391">model.ts:391</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,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>WorkspaceItemTitleProps | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItemTitleProps | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceItemTitleProps.html">WorkspaceItemTitleProps</a></li></ul><h1>Type Alias WorkspaceItemTitleProps<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Item<wbr/>Title<wbr/>Props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DesktopActionContext.html" class="tsd-signature-type tsd-kind-interface">DesktopActionContext</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">expanded</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">markdown</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">menuOptions</span><span class="tsd-signature-symbol">?: </span><a href="ContextMenuOptions.html" class="tsd-signature-type tsd-kind-type-alias">ContextMenuOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">extraActionItems</span><span class="tsd-signature-symbol">?: </span><a href="DesktopActionMenuItem.html" class="tsd-signature-type tsd-kind-type-alias">DesktopActionMenuItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">selectedItems</span><span class="tsd-signature-symbol">: </span><a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">showHiddenChildren</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"workspace"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Properties for workspace item title.</p>
|
|
2
2
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">expanded</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether the item is expanded.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">markdown</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If the component it is being used inside a Markdown component</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">menu<wbr/>Options</span><span class="tsd-signature-symbol">?: </span><a href="ContextMenuOptions.html" class="tsd-signature-type tsd-kind-type-alias">ContextMenuOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">extraActionItems</span><span class="tsd-signature-symbol">?: </span><a href="DesktopActionMenuItem.html" class="tsd-signature-type tsd-kind-type-alias">DesktopActionMenuItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Menu options with extra action items.</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">selected<wbr/>Items</span><span class="tsd-signature-symbol">: </span><a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Selected items in left sidebar</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">show<wbr/>Hidden<wbr/>Children</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"workspace"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to show hidden children in the workspace.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/desktop.ts#L1410">desktop.ts:1410</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItems | @octostar/platform-types - v0.5.
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceItems | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceItems.html">WorkspaceItems</a></li></ul><h1>Type Alias WorkspaceItems<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Items</span><span class="tsd-signature-symbol">:</span> <a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Represents an array of workspace items.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/model.ts#L701">model.ts:701</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspacePermission | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspacePermission | @octostar/platform-types - v0.5.27</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.27</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="WorkspacePermission.html">WorkspacePermission</a></li></ul><h1>Type Alias WorkspacePermission<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Permission</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../enums/WorkspacePermissionValue.html" class="tsd-signature-type tsd-kind-enum">WorkspacePermissionValue</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type representing a workspace permission.</p>
|
|
2
2
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The label for the permission.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../enums/WorkspacePermissionValue.html" class="tsd-signature-type tsd-kind-enum">WorkspacePermissionValue</a></h5><div class="tsd-comment tsd-typography"><p>The value of the permission.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/workspace.ts#L68">workspace.ts:68</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecord | @octostar/platform-types - v0.5.
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecord | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceRecord.html">WorkspaceRecord</a></li></ul><h1>Type Alias WorkspaceRecord<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Record</span><span class="tsd-signature-symbol">:</span> <a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol"> & </span><a href="WorkspaceItemBase.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItemBase</a><span class="tsd-signature-symbol"> & </span><a href="OsAuditFields.html" class="tsd-signature-type tsd-kind-type-alias">OsAuditFields</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">os_icon</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Represents a workspace record with additional attributes.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/model.ts#L550">model.ts:550</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,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>WorkspaceRecordInfo | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecordInfo | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceRecordInfo.html">WorkspaceRecordInfo</a></li></ul><h1>Type Alias WorkspaceRecordInfo<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Record<wbr/>Info</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">concept</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">entities</span><span class="tsd-signature-symbol">: </span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">max_last_updated</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type representing information about records in a workspace.</p>
|
|
2
2
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">concept</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The concept associated with the records.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The count of records.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">entities</span><span class="tsd-signature-symbol">: </span><a href="Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>The entities associated with the records.</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">max_<wbr/>last_<wbr/>updated</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The last updated timestamp for the records.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/workspace.ts#L89">workspace.ts:89</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,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>WorkspaceRecordWithRelationships | @octostar/platform-types - v0.5.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecordWithRelationships | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceRecordWithRelationships.html">WorkspaceRecordWithRelationships</a></li></ul><h1>Type Alias WorkspaceRecordWithRelationships<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Record<wbr/>With<wbr/>Relationships</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">relationship_name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">relationships</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="WorkspaceRecordWithRelationships.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceRecordWithRelationships</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type representing a workspace record with its relationships.</p>
|
|
2
2
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a></h5><div class="tsd-comment tsd-typography"><p>The workspace item.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">relationship_<wbr/>name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The name of the relationship.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Beta</code><span class="tsd-kind-property">relationships</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="WorkspaceRecordWithRelationships.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceRecordWithRelationships</a><span class="tsd-signature-symbol">]</span></h5><div class="tsd-comment tsd-typography"><p>The relationships associated with the workspace record.</p>
|
|
5
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/workspace.ts#L152">workspace.ts:152</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecords | @octostar/platform-types - v0.5.
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkspaceRecords | @octostar/platform-types - v0.5.27</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.27</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="WorkspaceRecords.html">WorkspaceRecords</a></li></ul><h1>Type Alias WorkspaceRecords<code class="tsd-tag">Beta</code></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workspace<wbr/>Records</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="WorkspaceRecordInfo.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceRecordInfo</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type representing a collection of workspace records.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/38e0b7553d12d6c8cfd1b03bef42233440a49267/packages/octostar-platform-types/src/workspace.ts#L104">workspace.ts:104</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.27</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>
|