@octostar/platform-types 0.5.28 → 0.5.30
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/ai.d.ts +38 -0
- package/dist/ai.d.ts.map +1 -1
- package/dist/app.d.ts +5 -7
- package/dist/app.d.ts.map +1 -1
- package/dist/desktop.d.ts +190 -45
- package/dist/desktop.d.ts.map +1 -1
- package/dist/desktop.js.map +1 -1
- package/dist/docs/assets/highlight.css +63 -0
- 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/functions/isWorkspaceFileItem.html +1 -0
- 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 +126 -105
- 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/EntityUiState.html +2 -0
- package/dist/docs/interfaces/FetchOptions.html +4 -4
- package/dist/docs/interfaces/FileListResponse.html +2 -2
- package/dist/docs/interfaces/FilesAPIClient.html +37 -28
- package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
- package/dist/docs/interfaces/IDataTransfer.html +11 -11
- package/dist/docs/interfaces/IndexSearchHitSource.html +5 -0
- package/dist/docs/interfaces/Inheritance.html +5 -5
- package/dist/docs/interfaces/LiveContext.html +30 -32
- package/dist/docs/interfaces/MoveOptions.html +6 -4
- package/dist/docs/interfaces/MoveResponse.html +7 -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 +66 -50
- package/dist/docs/interfaces/OsAPIClient.html +6 -6
- package/dist/docs/interfaces/ProcessingStatus.html +10 -9
- package/dist/docs/interfaces/Property.html +5 -5
- package/dist/docs/interfaces/RecordData.html +5 -5
- package/dist/docs/interfaces/RecordProvider.html +10 -10
- package/dist/docs/interfaces/RefObject.html +3 -3
- package/dist/docs/interfaces/Relationship.html +20 -20
- package/dist/docs/interfaces/S3Headers.html +7 -0
- package/dist/docs/interfaces/S3UploadResponse.html +3 -0
- package/dist/docs/interfaces/SavedDatasource.html +2 -2
- package/dist/docs/interfaces/SavedSearchAPIInterface.html +6 -6
- package/dist/docs/interfaces/SavedSearchContent.html +2 -2
- package/dist/docs/interfaces/SavedSetContent.html +2 -2
- package/dist/docs/interfaces/SearchOptions.html +4 -3
- package/dist/docs/interfaces/SearchProps.html +12 -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/UiStateManager.html +5 -0
- package/dist/docs/interfaces/UnaryObjectFilterClause.html +3 -3
- package/dist/docs/interfaces/UnzipOptions.html +2 -0
- package/dist/docs/interfaces/UploadOptions.html +3 -0
- 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 +15 -2
- 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 +3 -15
- package/dist/docs/types/AppServiceCallOptions.html +2 -2
- package/dist/docs/types/AppServiceCallProps.html +4 -4
- 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/ChatApiResponse.html +1 -0
- 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 +6 -3
- 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 +2 -2
- package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
- package/dist/docs/types/DesktopActionOptions.html +3 -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 +3 -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 -2
- package/dist/docs/types/FilterReference.html +2 -2
- package/dist/docs/types/FilterState.html +1 -1
- package/dist/docs/types/FilterValue.html +2 -2
- package/dist/docs/types/FocusListItem.html +2 -2
- package/dist/docs/types/FolderPasteOptions.html +2 -2
- package/dist/docs/types/GetSystemSettingResponse.html +1 -0
- package/dist/docs/types/GraphDataSpec.html +1 -1
- package/dist/docs/types/GraphSpec.html +2 -2
- package/dist/docs/types/HttpTransformDefinition.html +5 -5
- 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 +3 -3
- 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 +8 -5
- package/dist/docs/types/OsProgress.html +4 -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 +3 -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 +3 -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 +4 -3
- package/dist/docs/types/ServiceDefinition.html +4 -4
- 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/SetsOptions.html +10 -0
- 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/VirtualEntity.html +2 -0
- package/dist/docs/types/Watcher.html +2 -2
- package/dist/docs/types/Whoami.html +2 -2
- package/dist/docs/types/WithProgressBarOptions.html +4 -2
- package/dist/docs/types/Workspace.html +2 -2
- package/dist/docs/types/WorkspaceConfig.html +8 -1
- package/dist/docs/types/WorkspaceFlags.html +2 -2
- package/dist/docs/types/WorkspaceIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItem.html +4 -2
- package/dist/docs/types/WorkspaceItemBase.html +2 -2
- package/dist/docs/types/WorkspaceItemDocumentFields.html +1 -0
- package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
- package/dist/docs/types/WorkspaceItemModel.html +2 -2
- package/dist/docs/types/WorkspaceItemTitleProps.html +3 -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 +4 -3
- 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/event.d.ts.map +1 -1
- package/dist/extras.d.ts +2 -2
- package/dist/extras.d.ts.map +1 -1
- package/dist/files.d.ts +53 -12
- package/dist/files.d.ts.map +1 -1
- package/dist/files.js +3 -1
- package/dist/files.js.map +1 -1
- package/dist/graph.d.ts +2 -4
- package/dist/graph.d.ts.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/indexSearch.d.ts +216 -0
- package/dist/indexSearch.d.ts.map +1 -0
- package/dist/indexSearch.js +2 -0
- package/dist/indexSearch.js.map +1 -0
- package/dist/jobManifestTypes.d.ts +19 -41
- package/dist/jobManifestTypes.d.ts.map +1 -1
- package/dist/liveContext.d.ts +12 -16
- package/dist/liveContext.d.ts.map +1 -1
- package/dist/model.d.ts +32 -16
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js.map +1 -1
- package/dist/ontology.d.ts +44 -9
- package/dist/ontology.d.ts.map +1 -1
- package/dist/platform-types.d.ts +615 -138
- package/dist/query.d.ts +4 -4
- package/dist/query.d.ts.map +1 -1
- package/dist/remoteApp.d.ts +1 -1
- package/dist/remoteApp.d.ts.map +1 -1
- package/dist/savedSearch.d.ts +9 -13
- package/dist/savedSearch.d.ts.map +1 -1
- package/dist/savedSearch.js.map +1 -1
- package/dist/search.d.ts +11 -2
- package/dist/search.d.ts.map +1 -1
- package/dist/styling.d.ts +5 -5
- package/dist/styling.d.ts.map +1 -1
- package/dist/templates.d.ts +3 -3
- package/dist/templates.d.ts.map +1 -1
- package/dist/workspace.d.ts +5 -5
- package/dist/workspace.d.ts.map +1 -1
- package/dist/workspace.js.map +1 -1
- package/package.json +20 -6
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
import { FilterDefinition, FilterName } from './filters';
|
|
2
|
-
import { DesktopActionFilter, DesktopActionMenuItemGroup } from './desktop';
|
|
3
|
-
import { SemanticBindings } from './semantic';
|
|
1
|
+
import type { FilterDefinition, FilterName } from './filters';
|
|
2
|
+
import type { DesktopActionFilter, DesktopActionMenuItemGroup } from './desktop';
|
|
3
|
+
import type { SemanticBindings } from './semantic';
|
|
4
4
|
/**
|
|
5
5
|
* @beta
|
|
6
6
|
* Type representing a collection of filter definitions.
|
|
7
7
|
*/
|
|
8
|
-
export type FilterDefinitions =
|
|
9
|
-
[k: FilterName]: FilterDefinition;
|
|
10
|
-
};
|
|
8
|
+
export type FilterDefinitions = Record<FilterName, FilterDefinition>;
|
|
11
9
|
/**
|
|
12
10
|
* @beta
|
|
13
11
|
* Type representing a reference to a filter, which can be a string or an object requiring all filters.
|
|
@@ -63,13 +61,9 @@ export type HttpTransformDefinition = {
|
|
|
63
61
|
/** The URL for the HTTP request, can be relative to the url of the deployed app */
|
|
64
62
|
url: string;
|
|
65
63
|
/** Optional headers for the HTTP request. */
|
|
66
|
-
headers?:
|
|
67
|
-
[k: string]: string;
|
|
68
|
-
};
|
|
64
|
+
headers?: Record<string, string>;
|
|
69
65
|
/** Optional data for the HTTP request. */
|
|
70
|
-
data?: string |
|
|
71
|
-
[k: string]: any;
|
|
72
|
-
};
|
|
66
|
+
data?: string | Record<string, any>;
|
|
73
67
|
};
|
|
74
68
|
/**
|
|
75
69
|
* @beta
|
|
@@ -104,15 +98,9 @@ export type NunjucksType = {
|
|
|
104
98
|
type: 'nunjucks';
|
|
105
99
|
};
|
|
106
100
|
export type EvalContext = {
|
|
107
|
-
variables:
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
filters: {
|
|
111
|
-
[key: string]: DesktopActionFilter;
|
|
112
|
-
};
|
|
113
|
-
transforms: {
|
|
114
|
-
[key: string]: Function;
|
|
115
|
-
};
|
|
101
|
+
variables: Record<string, any>;
|
|
102
|
+
filters: Record<string, DesktopActionFilter>;
|
|
103
|
+
transforms: Record<string, Function>;
|
|
116
104
|
};
|
|
117
105
|
/**
|
|
118
106
|
* @beta
|
|
@@ -146,9 +134,7 @@ export type TransformDefinition = ProvidedTransformDefinition | HttpTransformDef
|
|
|
146
134
|
* @beta
|
|
147
135
|
* Type representing a collection of transform definitions.
|
|
148
136
|
*/
|
|
149
|
-
export type TransformDefinitions =
|
|
150
|
-
[transformName: string]: TransformDefinition;
|
|
151
|
-
};
|
|
137
|
+
export type TransformDefinitions = Record<string, TransformDefinition>;
|
|
152
138
|
/**
|
|
153
139
|
* @beta
|
|
154
140
|
* Type representing a JavaScript file styler definition.
|
|
@@ -168,9 +154,7 @@ export type StylerDefinition = JavascriptFileStylerDefinition | JavascriptInline
|
|
|
168
154
|
* @beta
|
|
169
155
|
* Type representing a collection of styler definitions.
|
|
170
156
|
*/
|
|
171
|
-
export type StylerDefinitions =
|
|
172
|
-
[stylerName: string]: StylerDefinition;
|
|
173
|
-
};
|
|
157
|
+
export type StylerDefinitions = Record<string, StylerDefinition>;
|
|
174
158
|
/**
|
|
175
159
|
* @beta
|
|
176
160
|
* Type representing a service role.
|
|
@@ -198,9 +182,7 @@ export type ServiceDefinition = {
|
|
|
198
182
|
/** Optional order for the service. */
|
|
199
183
|
order?: number;
|
|
200
184
|
/** Optional parameters for the service. */
|
|
201
|
-
params?:
|
|
202
|
-
[k: string]: any;
|
|
203
|
-
};
|
|
185
|
+
params?: Record<string, any>;
|
|
204
186
|
/** Optional roles for the service. */
|
|
205
187
|
role?: ServiceRole[] | ServiceRole;
|
|
206
188
|
/** Filters accepted by the service. */
|
|
@@ -217,16 +199,12 @@ export type ServiceDefinition = {
|
|
|
217
199
|
* @beta
|
|
218
200
|
* Type representing a collection of service definitions.
|
|
219
201
|
*/
|
|
220
|
-
export type ServiceDefinitions =
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
default?: string;
|
|
227
|
-
required?: boolean;
|
|
228
|
-
};
|
|
229
|
-
};
|
|
202
|
+
export type ServiceDefinitions = Record<string, ServiceDefinition>;
|
|
203
|
+
export type ManifestSecrets = Record<string, {
|
|
204
|
+
description: string;
|
|
205
|
+
default?: string;
|
|
206
|
+
required?: boolean;
|
|
207
|
+
}>;
|
|
230
208
|
/**
|
|
231
209
|
* @beta
|
|
232
210
|
* Type representing a job manifest.
|
|
@@ -239,7 +217,7 @@ export type JobManifest = {
|
|
|
239
217
|
/** AI description for the job. */
|
|
240
218
|
aiDescription?: string;
|
|
241
219
|
/** Icon for the job. */
|
|
242
|
-
icon
|
|
220
|
+
icon?: string;
|
|
243
221
|
/** Custom color for the app. */
|
|
244
222
|
color?: string;
|
|
245
223
|
/** Optional image for the job. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jobManifestTypes.d.ts","sourceRoot":"","sources":["../src/jobManifestTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"jobManifestTypes.d.ts","sourceRoot":"","sources":["../src/jobManifestTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IAAE,CAAC,aAAa,CAAC,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,kEAAkE;IAClE,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,oEAAoE;IACpE,IAAI,EAAE,YAAY,CAAC;IACnB,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gEAAgE;IAChE,IAAI,EAAE,QAAQ,CAAC;IACf,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;CAErB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IAC7D,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,8EAA8E;IAC9E,IAAI,EAAE,YAAY,CAAC;CACpB,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,4EAA4E;IAC5E,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC7C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,cAAc,GAAG,QAAQ,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG,cAAc,GAAG,UAAU,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,YAAY,GAAG,QAAQ,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,YAAY,GAAG;IAC7D,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B,2BAA2B,GAC3B,uBAAuB,GACvB,yBAAyB,GACzB,iCAAiC,GACjC,mCAAmC,GACnC,+BAA+B,GAC/B,iCAAiC,GACjC,4BAA4B,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,cAAc,GAAG,UAAU,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,8BAA8B,GAAG,gCAAgC,CAAC;AAEjG;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,aAAa,GAAG,UAAU,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,sCAAsC;IACtC,IAAI,CAAC,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;IACnC,uCAAuC;IACvC,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,yCAAyC;IACzC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CACF,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,WAAW,CAAC;IACpC,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2CAA2C;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,qDAAqD;IACrD,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,kDAAkD;IAClD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,kDAAkD;IAClD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC"}
|
package/dist/liveContext.d.ts
CHANGED
|
@@ -6,39 +6,35 @@ type DefaultLiveContextData = Record<string, any>;
|
|
|
6
6
|
* Represents a context management interface for handling state across components
|
|
7
7
|
*/
|
|
8
8
|
export interface LiveContext<ContextData extends DefaultLiveContextData = DefaultLiveContextData> {
|
|
9
|
+
/**
|
|
10
|
+
* Unique identifier for the context instance
|
|
11
|
+
*/
|
|
12
|
+
readonly id: string;
|
|
9
13
|
/**
|
|
10
14
|
* @beta
|
|
11
15
|
* Retrieves the current context data
|
|
12
16
|
* @returns The current context data
|
|
13
17
|
*/
|
|
14
|
-
getContext()
|
|
18
|
+
getContext: () => ContextData;
|
|
15
19
|
/**
|
|
16
20
|
* @beta
|
|
17
21
|
* Updates the context with new data
|
|
18
22
|
* @param context - New context data or function to update context
|
|
19
23
|
*/
|
|
20
|
-
setContext(context: LiveContextAPISetParams<ContextData>)
|
|
24
|
+
setContext: (context: LiveContextAPISetParams<ContextData>) => void;
|
|
21
25
|
/**
|
|
22
26
|
* @beta
|
|
23
27
|
* Subscribes to context changes with an automatically generated ID
|
|
24
28
|
* @param contextListener - Callback function triggered on context changes
|
|
25
29
|
* @returns Generated subscription ID
|
|
26
30
|
*/
|
|
27
|
-
subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
|
|
28
|
-
/**
|
|
29
|
-
* @beta
|
|
30
|
-
* Subscribes to context changes with a custom ID
|
|
31
|
-
* @param id - Custom subscription ID
|
|
32
|
-
* @param contextListener - Callback function triggered on context changes
|
|
33
|
-
* @returns The subscription ID
|
|
34
|
-
*/
|
|
35
|
-
subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
|
|
31
|
+
subscribeToChanges: ((contextListener: LiveContextListener<ContextData>) => string) & ((id: string, contextListener: LiveContextListener<ContextData>) => string);
|
|
36
32
|
/**
|
|
37
33
|
* @beta
|
|
38
34
|
* Unsubscribes from context changes
|
|
39
35
|
* @param id - Subscription ID to remove
|
|
40
36
|
*/
|
|
41
|
-
unsubscribeFromChanges(id: string)
|
|
37
|
+
unsubscribeFromChanges: (id: string) => void;
|
|
42
38
|
/**
|
|
43
39
|
* @beta
|
|
44
40
|
* Adds a context listener to another Context instance
|
|
@@ -46,24 +42,24 @@ export interface LiveContext<ContextData extends DefaultLiveContextData = Defaul
|
|
|
46
42
|
* @param mapContext - Optional function to transform context data
|
|
47
43
|
* @returns Function to remove the context listener
|
|
48
44
|
*/
|
|
49
|
-
addContextListener<ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData)
|
|
45
|
+
addContextListener: <ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData) => () => void;
|
|
50
46
|
/**
|
|
51
47
|
* @beta
|
|
52
48
|
* Removes a context listener
|
|
53
49
|
* @param idOrContextAPI - ID or Context instance to disconnect from
|
|
54
50
|
*/
|
|
55
|
-
removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string)
|
|
51
|
+
removeContextListener: <ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string) => void;
|
|
56
52
|
/**
|
|
57
53
|
* @beta
|
|
58
54
|
* Connects to target window for context synchronization
|
|
59
55
|
* @returns The channel ID used for communication
|
|
60
56
|
*/
|
|
61
|
-
connect()
|
|
57
|
+
connect: () => string;
|
|
62
58
|
/**
|
|
63
59
|
* @beta
|
|
64
60
|
* Destroys the context and cleans up all listeners
|
|
65
61
|
*/
|
|
66
|
-
destroy()
|
|
62
|
+
destroy: () => void;
|
|
67
63
|
}
|
|
68
64
|
export type { LiveContextListener, LiveContextAPISetParams, DefaultLiveContextData };
|
|
69
65
|
//# sourceMappingURL=liveContext.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"liveContext.d.ts","sourceRoot":"","sources":["../src/liveContext.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,
|
|
1
|
+
{"version":3,"file":"liveContext.d.ts","sourceRoot":"","sources":["../src/liveContext.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CACxF,OAAO,EAAE,WAAW,KACjB,IAAI,CAAC;AAEV,KAAK,uBAAuB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACtF,WAAW,GACX,CAAC,CAAC,cAAc,EAAE,WAAW,KAAK,WAAW,CAAC,CAAC;AAEnD,KAAK,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW,SAAS,sBAAsB,GAAG,sBAAsB;IAC9F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,WAAW,CAAC;IAE9B;;;;OAIG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,CAAC,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC,GACjF,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC,CAAC;IAE9E;;;;OAIG;IACH,sBAAsB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAE7C;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,oBAAoB,SAAS,sBAAsB,EACtE,UAAU,EAAE,WAAW,CAAC,oBAAoB,CAAC,EAC7C,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,WAAW,KACxD,MAAM,IAAI,CAAC;IAEhB;;;;OAIG;IACH,qBAAqB,EAAE,CAAC,oBAAoB,SAAS,sBAAsB,EACzE,cAAc,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,MAAM,KACvD,IAAI,CAAC;IAEV;;;;OAIG;IACH,OAAO,EAAE,MAAM,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,YAAY,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,CAAC"}
|
package/dist/model.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* @beta
|
|
3
3
|
* Type representing a binary operator.
|
|
4
4
|
*/
|
|
5
|
-
export type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | '
|
|
5
|
+
export type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'IN' | 'NOT IN' | 'regex' | 'LIKE' | 'ILIKE';
|
|
6
6
|
/**
|
|
7
7
|
* @beta
|
|
8
8
|
* Type representing a comparator for a filter clause in a query object.
|
|
@@ -25,7 +25,7 @@ export declare interface BinaryObjectFilterClause {
|
|
|
25
25
|
*/
|
|
26
26
|
export declare interface UnaryObjectFilterClause {
|
|
27
27
|
col: string;
|
|
28
|
-
op: 'IS NULL' | 'IS NOT NULL';
|
|
28
|
+
op: 'IS NULL' | 'IS NOT NULL' | 'IN' | 'NOT IN';
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* @beta
|
|
@@ -149,6 +149,10 @@ export type EntityBase = {
|
|
|
149
149
|
* The type of the entity.
|
|
150
150
|
*/
|
|
151
151
|
entity_type: string;
|
|
152
|
+
/**
|
|
153
|
+
* The workspace of the entity.
|
|
154
|
+
*/
|
|
155
|
+
os_workspace?: string;
|
|
152
156
|
};
|
|
153
157
|
/**
|
|
154
158
|
* Represents an entity with basic attributes.
|
|
@@ -335,7 +339,15 @@ export type ConceptFilter = {
|
|
|
335
339
|
/**
|
|
336
340
|
* The filters to apply to the records of the concept.
|
|
337
341
|
*/
|
|
338
|
-
filters: QueryObjectFilterClause
|
|
342
|
+
filters: (QueryObjectFilterClause & {
|
|
343
|
+
formattedLabel?: string;
|
|
344
|
+
})[];
|
|
345
|
+
/**
|
|
346
|
+
* Indicates if the item only should be returned.
|
|
347
|
+
* If true, only the item itself will be returned.
|
|
348
|
+
* If false, the item and its contents will be returned.
|
|
349
|
+
*/
|
|
350
|
+
itemOnly?: boolean;
|
|
339
351
|
};
|
|
340
352
|
/**
|
|
341
353
|
* Represents the model for a workspace item.
|
|
@@ -481,6 +493,13 @@ export type CommentWorkspaceItem = WorkspaceItemBase & OsAuditFields & Entity &
|
|
|
481
493
|
export type WorkspaceRecord = Entity & WorkspaceItemBase & OsAuditFields & {
|
|
482
494
|
os_icon?: string;
|
|
483
495
|
};
|
|
496
|
+
/**
|
|
497
|
+
* Represents a virtual entity not in the database.
|
|
498
|
+
* @beta
|
|
499
|
+
*/
|
|
500
|
+
export type VirtualEntity = Entity & {
|
|
501
|
+
'#virtual': true;
|
|
502
|
+
};
|
|
484
503
|
/**
|
|
485
504
|
* Interface for items that can have a color attribute.
|
|
486
505
|
* @beta
|
|
@@ -542,6 +561,14 @@ export type ImageInfo = {
|
|
|
542
561
|
* @beta
|
|
543
562
|
*/
|
|
544
563
|
export type WorkspaceItem<T = any> = WorkspaceRecord & {
|
|
564
|
+
/**
|
|
565
|
+
* Whether the item is a set.
|
|
566
|
+
*/
|
|
567
|
+
os_is_set?: boolean;
|
|
568
|
+
/**
|
|
569
|
+
* The concept of the workspace item.
|
|
570
|
+
*/
|
|
571
|
+
os_concept?: string;
|
|
545
572
|
/**
|
|
546
573
|
* The type-specific content of the workspace item.
|
|
547
574
|
*/
|
|
@@ -643,7 +670,7 @@ export interface RecordProvider {
|
|
|
643
670
|
* Retrieves a message related to the records.
|
|
644
671
|
* @returns A promise that resolves to the message, or undefined if no message is available.
|
|
645
672
|
*/
|
|
646
|
-
getMessage()
|
|
673
|
+
getMessage: () => Promise<string | undefined>;
|
|
647
674
|
}
|
|
648
675
|
/**
|
|
649
676
|
* Represents a named group (set?) entities.
|
|
@@ -725,18 +752,7 @@ export declare enum ProcessingStatusCode {
|
|
|
725
752
|
* Represents the status of a processing operation.
|
|
726
753
|
* @beta
|
|
727
754
|
*/
|
|
728
|
-
export interface ProcessingStatus {
|
|
729
|
-
/**
|
|
730
|
-
* The id of the entity being processed.
|
|
731
|
-
*/
|
|
732
|
-
entity_id: string;
|
|
733
|
-
/**
|
|
734
|
-
* The type of the entity being processed.
|
|
735
|
-
*/
|
|
736
|
-
entity_type: string;
|
|
737
|
-
/**
|
|
738
|
-
* The status code of the processing operation.
|
|
739
|
-
*/
|
|
755
|
+
export interface ProcessingStatus extends EntityBase {
|
|
740
756
|
status_code: ProcessingStatusCode;
|
|
741
757
|
/**
|
|
742
758
|
* The reason for the processing operation.
|
package/dist/model.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,cAAc,
|
|
1
|
+
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;AAElH;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC;AACtE;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,wBAAwB;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,cAAc,CAAC;IACnB,GAAG,EAAE,UAAU,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,uBAAuB;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,SAAS,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,CAAC;CACjD;AACD;;;;GAIG;AACH,MAAM,CAAC,OAAO,MAAM,uBAAuB,GAAG,wBAAwB,GAAG,uBAAuB,CAAC;AAEjG,eAAe,uBAAuB,CAAC;AAEvC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,eAAe,EAAE,WAAW,CAAC;IAC7B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,MAAM,GAAG;IACvC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,WAAW,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,SAAS,KAAK;IACd,KAAK,KAAK;IACV,IAAI,KAAK;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AACD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,yBAAyB,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,CAAC,uBAAuB,GAAG;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;IACnE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC;QAEtB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzC;;;;WAIG;QACH,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAEpD;;WAEG;QACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAElC;;WAEG;QACH,YAAY,CAAC,EAAE,GAAG,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG;IACnD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAClD,aAAa,GACb,MAAM,GAAG;IACP;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAClC,iBAAiB,GACjB,aAAa,GAAG;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IACnC,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,eAAe,GAAG,aAAa,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,GAAG,IAAI,eAAe,GAAG;IACrD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC;IAC5C;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,aAAa,GAAG;IACd;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG;IAC/C;;OAEG;IACH,aAAa,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,EAAE,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;OAIG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;OAGG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB;IACE,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB,GACD,gBAAgB,CAAC;AAErB;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjF;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,oCAAoC;IACpC,MAAM,WAAW;IACjB,wBAAwB;IACxB,OAAO,YAAY;IACnB,uBAAuB;IACvB,OAAO,YAAY;IACnB,gCAAgC;IAChC,MAAM,WAAW;IACjB,6BAA6B;IAC7B,SAAS,cAAc;IACvB,4BAA4B;IAC5B,MAAM,WAAW;IACjB,uBAAuB;IACvB,SAAS,cAAc;IACvB,kBAAkB;IAClB,QAAQ,aAAa;IACrB,oBAAoB;IACpB,QAAQ,aAAa;IACrB,8BAA8B;IAC9B,QAAQ,aAAa;IACrB,4BAA4B;IAC5B,OAAO,YAAY;IACnB,oCAAoC;IACpC,OAAO,YAAY;IACnB,6BAA6B;IAC7B,QAAQ,aAAa;IACrB,wBAAwB;IACxB,OAAO,YAAY;CACpB;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,WAAW,EAAE,oBAAoB,CAAC;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}
|
package/dist/model.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AA2SA;;;GAGG;AACH,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oDAAc,CAAA;IACd,4CAAU,CAAA;IACV,0CAAS,CAAA;AACX,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAqeD;;;GAGG;AACH,MAAM,CAAN,IAAY,oBA6BX;AA7BD,WAAY,oBAAoB;IAC9B,oCAAoC;IACpC,yCAAiB,CAAA;IACjB,wBAAwB;IACxB,2CAAmB,CAAA;IACnB,uBAAuB;IACvB,2CAAmB,CAAA;IACnB,gCAAgC;IAChC,yCAAiB,CAAA;IACjB,6BAA6B;IAC7B,+CAAuB,CAAA;IACvB,4BAA4B;IAC5B,yCAAiB,CAAA;IACjB,uBAAuB;IACvB,+CAAuB,CAAA;IACvB,kBAAkB;IAClB,6CAAqB,CAAA;IACrB,oBAAoB;IACpB,6CAAqB,CAAA;IACrB,8BAA8B;IAC9B,6CAAqB,CAAA;IACrB,4BAA4B;IAC5B,2CAAmB,CAAA;IACnB,oCAAoC;IACpC,2CAAmB,CAAA;IACnB,6BAA6B;IAC7B,6CAAqB,CAAA;IACrB,wBAAwB;IACxB,2CAAmB,CAAA;AACrB,CAAC,EA7BW,oBAAoB,KAApB,oBAAoB,QA6B/B"}
|
package/dist/ontology.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { Callback, Unsubscribe } from './callback';
|
|
2
|
-
import { EConnection } from './graph';
|
|
3
|
-
import { Concept, Entity, Inheritance, Relationship, WorkspaceItem, WorkspaceRelationship } from './model';
|
|
4
|
-
import { QueryResponse, SendQueryOptions } from './query';
|
|
1
|
+
import type { Callback, Unsubscribe } from './callback';
|
|
2
|
+
import type { EConnection, EntityEdge } from './graph';
|
|
3
|
+
import type { Concept, Entity, Inheritance, Relationship, WorkspaceItem, WorkspaceRelationship } from './model';
|
|
4
|
+
import type { QueryResponse, SendQueryOptions } from './query';
|
|
5
5
|
/**
|
|
6
6
|
* @beta
|
|
7
7
|
* Type representing the result of a relationship count operation.
|
|
@@ -34,7 +34,7 @@ export interface Ontology {
|
|
|
34
34
|
* @param rel - The relationship or relationship name.
|
|
35
35
|
* @returns A promise that resolves to an array of workspace relationships.
|
|
36
36
|
*/
|
|
37
|
-
getWorkspaceRelationshipRecords(entity: Entity, rel: string | Relationship)
|
|
37
|
+
getWorkspaceRelationshipRecords: (entity: Entity, rel: string | Relationship) => Promise<WorkspaceRelationship[]>;
|
|
38
38
|
/**
|
|
39
39
|
* Clears the relationship cache for a given entity and relationship.
|
|
40
40
|
* @param entity - The entity for which to clear the cache.
|
|
@@ -75,11 +75,34 @@ export interface Ontology {
|
|
|
75
75
|
*/
|
|
76
76
|
getConcepts: () => Promise<Map<string, Concept>>;
|
|
77
77
|
/**
|
|
78
|
-
* Gets an entity.
|
|
79
|
-
*
|
|
78
|
+
* Gets an entity by ID.
|
|
79
|
+
*
|
|
80
|
+
* ⚠️ **NOTE**: This method has unusual behavior for missing entities.
|
|
81
|
+
* The method gets a database version of the entity, if one exists, otherwise returns the original entity.
|
|
82
|
+
* It is used in many parts of the system where the entity encountered may or may not be saved in the database.
|
|
83
|
+
*
|
|
84
|
+
* In the case where it's important to distinguish whether the input record was found in the database,
|
|
85
|
+
* include an identifiying attribute eg, '#original': true as such a field will not be present in the saved version.
|
|
86
|
+
*
|
|
87
|
+
* **Example Usage:**
|
|
88
|
+
* ```typescript
|
|
89
|
+
* const entityWithOriginal: Entity & { '#original': boolean } = {
|
|
90
|
+
* entity_id: someId,
|
|
91
|
+
* entity_type: someType,
|
|
92
|
+
* entity_label: someLabel,
|
|
93
|
+
* '#original': true,
|
|
94
|
+
* };
|
|
95
|
+
* const result = await ontologyAPI.getEntity<Entity & { '#original': boolean }>(entityWithOriginal);
|
|
96
|
+
* if (result['#original']) {
|
|
97
|
+
* // Entity doesn't exist - the method returned our input object unchanged
|
|
98
|
+
* }
|
|
99
|
+
* // Entity exists - the method returned actual entity data (without #original flag)
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
102
|
+
* @param e - The entity to get (may include special flags like `#original`).
|
|
80
103
|
* @param refresh - Whether to refresh the data.
|
|
81
104
|
* @param skipSideEffects - Whether to skip side effects.
|
|
82
|
-
* @returns A promise that resolves to the entity.
|
|
105
|
+
* @returns A promise that resolves to either the actual entity data OR the input entity if not found.
|
|
83
106
|
*/
|
|
84
107
|
getEntity: <T extends Entity>(e: Entity, refresh?: boolean, skipSideEffects?: boolean) => Promise<T>;
|
|
85
108
|
/**
|
|
@@ -132,7 +155,19 @@ export interface Ontology {
|
|
|
132
155
|
* Gets the system inheritance.
|
|
133
156
|
* @returns A promise that resolves to an array of inheritances.
|
|
134
157
|
*/
|
|
135
|
-
getSysInheritance()
|
|
158
|
+
getSysInheritance: () => Promise<Inheritance[]>;
|
|
159
|
+
/**
|
|
160
|
+
* Gets the local entity edges.
|
|
161
|
+
* @param entities - The entities for which to get the edges.
|
|
162
|
+
* @returns A promise that resolves to an array of entity edges.
|
|
163
|
+
*/
|
|
164
|
+
getLocalEntityEdges: (entities: Entity[]) => Promise<EntityEdge[]>;
|
|
165
|
+
/**
|
|
166
|
+
* Discovers edges on adding nodes.
|
|
167
|
+
* @param entities - The entities for which to discover edges.
|
|
168
|
+
* @returns A promise that resolves to an array of entity edges.
|
|
169
|
+
*/
|
|
170
|
+
discoverEdgesOnAddingNodes: (newEntities: Entity[], oldEntities: Entity[]) => Promise<EntityEdge[]>;
|
|
136
171
|
/**
|
|
137
172
|
* Subscribes to changes for a given entity.
|
|
138
173
|
* @param entity - The entity to subscribe to.
|
package/dist/ontology.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ontology.d.ts","sourceRoot":"","sources":["../src/ontology.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"ontology.d.ts","sourceRoot":"","sources":["../src/ontology.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAChH,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;OAGG;IACH,sBAAsB,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,+BAA+B,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,YAAY,KAAK,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAElH;;;;;;OAMG;IACH,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElH;;;;;;OAMG;IACH,oBAAoB,EAAE,CAAC,CAAC,SAAS,MAAM,EACrC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GAAG,MAAM,EACnC,YAAY,CAAC,EAAE,OAAO,KACnB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAElB;;;;;OAKG;IACH,oBAAoB,EAAE,CAAC,CAAC,SAAS,MAAM,EACrC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,KACpD,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE5B;;;OAGG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAExE;;;OAGG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAErG;;;OAGG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,oBAAoB,EAAE,CACpB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,YAAY,GAAG,MAAM,EAC1B,YAAY,CAAC,EAAE,OAAO,KACnB,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtC;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEtE;;;;OAIG;IACH,yBAAyB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAEvE;;;;OAIG;IACH,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;OAKG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpG;;;OAGG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhD;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAEnE;;;;OAIG;IACH,0BAA0B,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAEpG;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7G;;;;;OAKG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtE;;;;OAIG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;CAC5F;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,wCAAwC;IACxC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,sCAAsC;IACtC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,uCAAuC;IACvC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,6CAA6C;IAC7C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,uCAAuC;IACvC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,4CAA4C;IAC5C,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
|