@octostar/platform-types 0.5.4 → 0.5.5
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/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/assets/style.css +0 -0
- 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 +6 -0
- package/dist/docs/interfaces/ActionContext.html +4 -4
- package/dist/docs/interfaces/{QueryObjectFilterClause.html → BinaryObjectFilterClause.html} +6 -5
- package/dist/docs/interfaces/ChartDataResponseResult.html +20 -0
- package/dist/docs/interfaces/ChatMessage.html +15 -0
- package/dist/docs/interfaces/Colorful.html +3 -3
- package/dist/docs/interfaces/Concept.html +12 -12
- package/dist/docs/interfaces/Desktop.html +103 -90
- package/dist/docs/interfaces/DesktopActionContext.html +7 -7
- package/dist/docs/interfaces/DesktopSettings.html +5 -5
- package/dist/docs/interfaces/FetchOptions.html +6 -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/NativeFilterColumn.html +3 -0
- package/dist/docs/interfaces/NativeFilterScope.html +3 -0
- package/dist/docs/interfaces/NativeFilterTarget.html +3 -0
- package/dist/docs/interfaces/Ontology.html +42 -33
- package/dist/docs/interfaces/OsAPIClient.html +18 -0
- package/dist/docs/interfaces/ProcessingStatus.html +7 -7
- package/dist/docs/interfaces/Property.html +5 -5
- package/dist/docs/interfaces/RecordData.html +20 -0
- 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 +7 -0
- package/dist/docs/interfaces/SavedSearchAPIInterface.html +6 -0
- package/dist/docs/interfaces/SavedSearchContent.html +7 -0
- package/dist/docs/interfaces/SavedSetContent.html +3 -0
- package/dist/docs/interfaces/SearchOptions.html +4 -0
- package/dist/docs/interfaces/SearchProps.html +11 -7
- 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 +8 -0
- package/dist/docs/interfaces/StreamTextOptions.html +8 -0
- package/dist/docs/interfaces/StylerContext.html +11 -11
- package/dist/docs/interfaces/TagAttributes.html +7 -7
- package/dist/docs/interfaces/UnaryObjectFilterClause.html +5 -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 +46 -10
- 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 -0
- package/dist/docs/types/CommentWorkspaceItem.html +2 -2
- package/dist/docs/types/Comparator.html +2 -2
- package/dist/docs/types/ConceptFilter.html +3 -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 -0
- package/dist/docs/types/CreateLinkChartParams.html +1 -0
- 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 -0
- 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 +4 -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 -0
- package/dist/docs/types/DropZoneRequestResult.html +1 -0
- 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 +3 -5
- package/dist/docs/types/EntityBase.html +4 -0
- 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 -0
- package/dist/docs/types/FetchEntityOptions.html +2 -0
- package/dist/docs/types/FileCode.html +2 -2
- package/dist/docs/types/FileTreeOptions.html +2 -2
- package/dist/docs/types/Filter.html +1 -0
- 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/FilterReference.html +2 -2
- package/dist/docs/types/FilterState.html +1 -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 +3 -3
- package/dist/docs/types/KnownCounts.html +2 -2
- package/dist/docs/types/ManifestSecrets.html +1 -0
- 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 +3 -2
- package/dist/docs/types/Permission.html +2 -2
- package/dist/docs/types/Point.html +2 -2
- package/dist/docs/types/PromptOptions.html +2 -0
- 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 +3 -0
- 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 -0
- package/dist/docs/types/RefCallback.html +2 -2
- package/dist/docs/types/RelationshipCountResult.html +2 -2
- package/dist/docs/types/RemoteAppApi.html +1 -0
- 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 -0
- package/dist/docs/types/ShowOntology.html +2 -2
- package/dist/docs/types/ShowTabProps.html +2 -2
- package/dist/docs/types/Styler.html +19 -10
- 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 -0
- package/dist/docs/types/SubscribeToContextFn.html +1 -0
- 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 -0
- package/dist/docs/types/UnsubscribeFromContextFn.html +1 -0
- package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -0
- 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 -0
- 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 +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 +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 -0
- package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -0
- package/dist/platform-types.d.ts +473 -70
- package/lib/action.d.ts +1 -0
- package/lib/action.d.ts.map +1 -1
- package/lib/ai.d.ts +57 -0
- package/lib/ai.d.ts.map +1 -0
- package/lib/ai.js +2 -0
- package/lib/ai.js.map +1 -0
- package/lib/client.d.ts +63 -0
- package/lib/client.d.ts.map +1 -0
- package/lib/client.js +2 -0
- package/lib/client.js.map +1 -0
- package/lib/desktop.d.ts +56 -4
- package/lib/desktop.d.ts.map +1 -1
- package/lib/desktop.js.map +1 -1
- package/lib/extras.d.ts +15 -0
- package/lib/extras.d.ts.map +1 -0
- package/lib/extras.js +2 -0
- package/lib/extras.js.map +1 -0
- package/lib/filters.d.ts +1 -11
- package/lib/filters.d.ts.map +1 -1
- package/lib/index.d.ts +5 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -0
- package/lib/index.js.map +1 -1
- package/lib/jobManifestTypes.d.ts +10 -30
- package/lib/jobManifestTypes.d.ts.map +1 -1
- package/lib/model.d.ts +26 -4
- package/lib/model.d.ts.map +1 -1
- package/lib/model.js.map +1 -1
- package/lib/ontology.d.ts +14 -0
- package/lib/ontology.d.ts.map +1 -1
- package/lib/remoteApp.d.ts +21 -0
- package/lib/remoteApp.d.ts.map +1 -0
- package/lib/remoteApp.js +2 -0
- package/lib/remoteApp.js.map +1 -0
- package/lib/savedSearch.d.ts +132 -0
- package/lib/savedSearch.d.ts.map +1 -0
- package/lib/savedSearch.js +16 -0
- package/lib/savedSearch.js.map +1 -0
- package/lib/search.d.ts +18 -0
- package/lib/search.d.ts.map +1 -1
- package/lib/styling.d.ts +23 -10
- package/lib/styling.d.ts.map +1 -1
- package/package.json +2 -2
- package/dist/docs/types/PythonFileStylerDefinition.html +0 -2
- package/dist/docs/types/PythonFileTransformDefinition.html +0 -2
- package/dist/docs/types/PythonFilterDefinition.html +0 -4
- package/dist/docs/types/PythonInlineStylerDefinition.html +0 -2
- package/dist/docs/types/PythonInlineTransformDefinition.html +0 -2
- package/dist/docs/types/PythonType.html +0 -3
package/dist/platform-types.d.ts
CHANGED
|
@@ -70,6 +70,20 @@ export declare type AddCommentParams = {
|
|
|
70
70
|
*/
|
|
71
71
|
export declare type AddListener<T> = (callback: Callback<T>) => Promise<Unsubscribe>;
|
|
72
72
|
|
|
73
|
+
/**
|
|
74
|
+
* The interface for the AI client.
|
|
75
|
+
*/
|
|
76
|
+
export declare interface AIClient {
|
|
77
|
+
/**
|
|
78
|
+
* Get the chat models.
|
|
79
|
+
*/
|
|
80
|
+
getChatModels(): Promise<ChatModel[]>;
|
|
81
|
+
/**
|
|
82
|
+
* Prompt the AI.
|
|
83
|
+
*/
|
|
84
|
+
prompt(prompt: string, options?: PromptOptions): Promise<string>;
|
|
85
|
+
}
|
|
86
|
+
|
|
73
87
|
/**
|
|
74
88
|
* @beta
|
|
75
89
|
* Type representing an error API result.
|
|
@@ -222,6 +236,19 @@ export declare type Behaviour = {
|
|
|
222
236
|
edit?: () => Promise<void>;
|
|
223
237
|
};
|
|
224
238
|
|
|
239
|
+
declare type BigNumber = any;
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* @beta
|
|
243
|
+
* Represents a filter clause with binary operations in a query object.
|
|
244
|
+
* It supports operations involving a column, a binary operator, and a comparator value.
|
|
245
|
+
*/
|
|
246
|
+
export declare interface BinaryObjectFilterClause {
|
|
247
|
+
col: string;
|
|
248
|
+
op: BinaryOperator;
|
|
249
|
+
val: Comparator;
|
|
250
|
+
}
|
|
251
|
+
|
|
225
252
|
/**
|
|
226
253
|
* @beta
|
|
227
254
|
* Type representing a binary operator.
|
|
@@ -236,6 +263,69 @@ export declare type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in
|
|
|
236
263
|
*/
|
|
237
264
|
export declare type Callback<T> = (t: T) => void;
|
|
238
265
|
|
|
266
|
+
export declare interface ChartDataResponseResult {
|
|
267
|
+
all_columns?: string[];
|
|
268
|
+
annotation_data: Record<string, any> | null;
|
|
269
|
+
cache_key: string | null;
|
|
270
|
+
cache_timeout: number | null;
|
|
271
|
+
cached_dttm: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* Array of data records as dictionary
|
|
274
|
+
*/
|
|
275
|
+
data: Record<any, any>[];
|
|
276
|
+
/**
|
|
277
|
+
* Name of each column, for retaining the order of the output columns.
|
|
278
|
+
*/
|
|
279
|
+
colnames: string[];
|
|
280
|
+
/**
|
|
281
|
+
* Generic data types, based on the final output pandas dataframe.
|
|
282
|
+
*/
|
|
283
|
+
coltypes: GenericDataType[];
|
|
284
|
+
error: string | null;
|
|
285
|
+
is_cached: boolean;
|
|
286
|
+
query: string;
|
|
287
|
+
rowcount: number;
|
|
288
|
+
stacktrace: string | null;
|
|
289
|
+
status: 'stopped' | 'failed' | 'pending' | 'running' | 'scheduled' | 'success' | 'timed_out';
|
|
290
|
+
from_dttm: number | null;
|
|
291
|
+
to_dttm: number | null;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
export declare interface ChatMessage {
|
|
295
|
+
/**
|
|
296
|
+
* The id of the message. This is used to identify the message in the conversation.
|
|
297
|
+
* It is generated by the chat agent, and is used to update the message in the conversation.
|
|
298
|
+
* (It is repeated in each update, but this is ok because it is used to identify the message in the conversation.)
|
|
299
|
+
*/
|
|
300
|
+
id: string;
|
|
301
|
+
/**
|
|
302
|
+
* The role of the message.
|
|
303
|
+
*/
|
|
304
|
+
role: 'user' | 'assistant' | 'system';
|
|
305
|
+
/**
|
|
306
|
+
* The content of the message.
|
|
307
|
+
* For `update` and `complete` messages, this is the partial or final response.
|
|
308
|
+
* For `add_entities` and `remove_entities` messages, this is the json encoded list of entities.
|
|
309
|
+
*/
|
|
310
|
+
content: string;
|
|
311
|
+
/**
|
|
312
|
+
* The type of the message.
|
|
313
|
+
*/
|
|
314
|
+
type?: 'update' | 'complete' | 'add_entities' | 'remove_entities';
|
|
315
|
+
/**
|
|
316
|
+
* The timestamp of the message in ISO 8601 format.
|
|
317
|
+
*/
|
|
318
|
+
timestamp?: string;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* The type for the chat model.
|
|
323
|
+
*/
|
|
324
|
+
export declare type ChatModel = {
|
|
325
|
+
model_name: string;
|
|
326
|
+
description: string;
|
|
327
|
+
};
|
|
328
|
+
|
|
239
329
|
/**
|
|
240
330
|
* Interface for items that can have a color attribute.
|
|
241
331
|
* @beta
|
|
@@ -396,6 +486,7 @@ export declare type ContextMenuParams = ActionContext & {
|
|
|
396
486
|
trigger?: trigger[];
|
|
397
487
|
onMenuToggle?: (isOpen: boolean) => void;
|
|
398
488
|
options?: ContextMenuOptions;
|
|
489
|
+
markdown?: boolean;
|
|
399
490
|
};
|
|
400
491
|
|
|
401
492
|
/**
|
|
@@ -447,6 +538,17 @@ export declare type CreateEntityFormProps = {
|
|
|
447
538
|
concept?: string;
|
|
448
539
|
};
|
|
449
540
|
|
|
541
|
+
export declare type CreateLinkChartFn = (params: CreateLinkChartParams) => Promise<WorkspaceItem | undefined>;
|
|
542
|
+
|
|
543
|
+
export declare type CreateLinkChartParams = {
|
|
544
|
+
path?: string;
|
|
545
|
+
name: string;
|
|
546
|
+
nodes?: Entity[];
|
|
547
|
+
edges?: EdgeSpec[];
|
|
548
|
+
draft?: boolean;
|
|
549
|
+
os_workspace?: string;
|
|
550
|
+
};
|
|
551
|
+
|
|
450
552
|
/**
|
|
451
553
|
* Properties for creating relations dialog.
|
|
452
554
|
* @beta
|
|
@@ -559,6 +661,12 @@ export declare type DataContextType = {
|
|
|
559
661
|
removeFromGraph: (graph: GraphDataSpec) => void;
|
|
560
662
|
};
|
|
561
663
|
|
|
664
|
+
export declare type DataMask = {
|
|
665
|
+
extraFormData?: Record<string, any>;
|
|
666
|
+
filterState?: FilterState;
|
|
667
|
+
ownState?: Record<string, any>;
|
|
668
|
+
};
|
|
669
|
+
|
|
562
670
|
/**
|
|
563
671
|
* Interface for desktop actions.
|
|
564
672
|
* @beta
|
|
@@ -623,11 +731,19 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
623
731
|
/**
|
|
624
732
|
* Gets a workspace by identifier.
|
|
625
733
|
*/
|
|
626
|
-
getWorkspace: (ws: WorkspaceIdentifier) => Promise<Workspace | undefined>;
|
|
734
|
+
getWorkspace: (ws: WorkspaceIdentifier, shouldRetry?: boolean) => Promise<Workspace | undefined>;
|
|
627
735
|
/**
|
|
628
736
|
* Gets items in a workspace by name.
|
|
629
737
|
*/
|
|
630
738
|
getWorkspaceItems(os_item_name: string): Promise<WorkspaceItem[]>;
|
|
739
|
+
/**
|
|
740
|
+
* Gets the OsAPIClient.
|
|
741
|
+
*/
|
|
742
|
+
getOsAPIClient(): Promise<OsAPIClient>;
|
|
743
|
+
/**
|
|
744
|
+
* Gets the AI client.
|
|
745
|
+
*/
|
|
746
|
+
getAIClient(): Promise<AIClient>;
|
|
631
747
|
/**
|
|
632
748
|
* Applies a tag to an entity.
|
|
633
749
|
*/
|
|
@@ -675,7 +791,11 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
675
791
|
/**
|
|
676
792
|
* Creates a workspace by name.
|
|
677
793
|
*/
|
|
678
|
-
createWorkspace: (name: string) => Promise<WorkspaceItem>;
|
|
794
|
+
createWorkspace: (name: string, config?: WorkspaceConfig) => Promise<WorkspaceItem>;
|
|
795
|
+
/**
|
|
796
|
+
* Creates a private workspace for user by name.
|
|
797
|
+
*/
|
|
798
|
+
createPrivateWorkspace: (name: string, config?: WorkspaceConfig) => Promise<Workspace>;
|
|
679
799
|
/**
|
|
680
800
|
* Connects two entities with a relationship in a workspace.
|
|
681
801
|
*/
|
|
@@ -700,6 +820,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
700
820
|
* Exports an item or items with optional export options.
|
|
701
821
|
*/
|
|
702
822
|
export: (item: WorkspaceItem | WorkspaceItem[], options?: ExportOptions) => Promise<void>;
|
|
823
|
+
/**
|
|
824
|
+
* Fetches an entity from the index, or from the ontology if not found in the index.
|
|
825
|
+
*/
|
|
826
|
+
fetchEntity: (entity: EntityBase, options?: FetchEntityOptions) => Promise<Entity>;
|
|
703
827
|
/**
|
|
704
828
|
* Extracts entities from some text which may be json or a list of urls.
|
|
705
829
|
*/
|
|
@@ -728,6 +852,13 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
728
852
|
* Deletes local concept records in a workspace by base concept.
|
|
729
853
|
*/
|
|
730
854
|
delete_local_concept_records: (workspace_id: string, base_concept: string) => Promise<void>;
|
|
855
|
+
/**
|
|
856
|
+
* Searches the index using the query string
|
|
857
|
+
* @param query OpenSearch qeuery string.
|
|
858
|
+
* @param options query options
|
|
859
|
+
* @returns a promise resolving to the found entities.
|
|
860
|
+
*/
|
|
861
|
+
search: (query: string, options?: SearchOptions) => Promise<Entity[]>;
|
|
731
862
|
/**
|
|
732
863
|
* Searches experience with optional search options.
|
|
733
864
|
*/
|
|
@@ -1021,6 +1152,14 @@ export declare type DesktopActionOptions = {
|
|
|
1021
1152
|
* Whether to raise the tab to the front.
|
|
1022
1153
|
*/
|
|
1023
1154
|
raiseOnly?: boolean;
|
|
1155
|
+
/**
|
|
1156
|
+
* Open tab in a new tabset
|
|
1157
|
+
*/
|
|
1158
|
+
newTabset?: boolean;
|
|
1159
|
+
/**
|
|
1160
|
+
* Wait for the tab to open
|
|
1161
|
+
*/
|
|
1162
|
+
awaitShowTab?: boolean;
|
|
1024
1163
|
};
|
|
1025
1164
|
|
|
1026
1165
|
/**
|
|
@@ -1125,6 +1264,13 @@ export declare type DragStartParams = {
|
|
|
1125
1264
|
dragEndTopic: string;
|
|
1126
1265
|
};
|
|
1127
1266
|
|
|
1267
|
+
export declare type DropZoneRequestFn = (args: any[]) => Promise<DropZoneRequestResult>;
|
|
1268
|
+
|
|
1269
|
+
export declare type DropZoneRequestResult = {
|
|
1270
|
+
to: any;
|
|
1271
|
+
data: any;
|
|
1272
|
+
};
|
|
1273
|
+
|
|
1128
1274
|
/**
|
|
1129
1275
|
* @beta
|
|
1130
1276
|
* Type representing a connection between two entities with a relationship.
|
|
@@ -1168,7 +1314,18 @@ export declare type EmitEventTransformDefinition = {
|
|
|
1168
1314
|
* Represents an entity with basic attributes.
|
|
1169
1315
|
* @beta
|
|
1170
1316
|
*/
|
|
1171
|
-
export declare type Entity = {
|
|
1317
|
+
export declare type Entity = EntityBase & {
|
|
1318
|
+
/**
|
|
1319
|
+
* The label of the entity.
|
|
1320
|
+
*/
|
|
1321
|
+
entity_label: string;
|
|
1322
|
+
};
|
|
1323
|
+
|
|
1324
|
+
/**
|
|
1325
|
+
* Represents an entity without a label.
|
|
1326
|
+
* @beta
|
|
1327
|
+
*/
|
|
1328
|
+
export declare type EntityBase = {
|
|
1172
1329
|
/**
|
|
1173
1330
|
* The ID of the entity.
|
|
1174
1331
|
*/
|
|
@@ -1177,10 +1334,6 @@ export declare type Entity = {
|
|
|
1177
1334
|
* The type of the entity.
|
|
1178
1335
|
*/
|
|
1179
1336
|
entity_type: string;
|
|
1180
|
-
/**
|
|
1181
|
-
* The label of the entity.
|
|
1182
|
-
*/
|
|
1183
|
-
entity_label: string;
|
|
1184
1337
|
};
|
|
1185
1338
|
|
|
1186
1339
|
/**
|
|
@@ -1346,6 +1499,29 @@ export declare type ExtractEntitiesOptions = {
|
|
|
1346
1499
|
hydrate?: boolean;
|
|
1347
1500
|
};
|
|
1348
1501
|
|
|
1502
|
+
export declare type ExtrasApi = {
|
|
1503
|
+
createLinkChart: CreateLinkChartFn;
|
|
1504
|
+
};
|
|
1505
|
+
|
|
1506
|
+
/**
|
|
1507
|
+
* Options for fetching an entity.
|
|
1508
|
+
* @beta
|
|
1509
|
+
*/
|
|
1510
|
+
export declare type FetchEntityOptions = {};
|
|
1511
|
+
|
|
1512
|
+
/**
|
|
1513
|
+
* @beta
|
|
1514
|
+
* Options for fetching data from an API.
|
|
1515
|
+
*/
|
|
1516
|
+
export declare interface FetchOptions extends Omit<RequestInit, 'body'> {
|
|
1517
|
+
/**
|
|
1518
|
+
* The API endpoint to hit, starting with a slash.
|
|
1519
|
+
*/
|
|
1520
|
+
endpoint: string;
|
|
1521
|
+
/** A BodyInit object, object or null to set request's body. */
|
|
1522
|
+
body?: BodyInit | object | null;
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1349
1525
|
/**
|
|
1350
1526
|
* @beta
|
|
1351
1527
|
* File containing the code. Not yet supported.
|
|
@@ -1382,11 +1558,35 @@ export declare type FileTreeOptions = {
|
|
|
1382
1558
|
structure?: boolean;
|
|
1383
1559
|
};
|
|
1384
1560
|
|
|
1561
|
+
export declare type Filter = {
|
|
1562
|
+
cascadeParentIds: string[];
|
|
1563
|
+
defaultDataMask: DataMask;
|
|
1564
|
+
id: string;
|
|
1565
|
+
name: string;
|
|
1566
|
+
scope: NativeFilterScope;
|
|
1567
|
+
filterType: string;
|
|
1568
|
+
targets: [Partial<NativeFilterTarget>];
|
|
1569
|
+
controlValues: {
|
|
1570
|
+
[key: string]: any;
|
|
1571
|
+
};
|
|
1572
|
+
sortMetric?: string | null;
|
|
1573
|
+
adhoc_filters?: Record<any, any>[];
|
|
1574
|
+
granularity_sqla?: string;
|
|
1575
|
+
granularity?: string;
|
|
1576
|
+
time_grain_sqla?: string;
|
|
1577
|
+
time_range?: string;
|
|
1578
|
+
requiredFirst?: boolean;
|
|
1579
|
+
tabsInScope?: string[];
|
|
1580
|
+
chartsInScope?: number[];
|
|
1581
|
+
type: 'NATIVE_FILTER';
|
|
1582
|
+
description: string;
|
|
1583
|
+
};
|
|
1584
|
+
|
|
1385
1585
|
/**
|
|
1386
1586
|
* @beta
|
|
1387
1587
|
* Type representing a filter definition, which can be one of several specific filter types.
|
|
1388
1588
|
*/
|
|
1389
|
-
export declare type FilterDefinition = ProvidedFilterDefinition |
|
|
1589
|
+
export declare type FilterDefinition = ProvidedFilterDefinition | JavascriptFilterDefinition | SemanticallyBoundFilterDefinition;
|
|
1390
1590
|
|
|
1391
1591
|
/**
|
|
1392
1592
|
* @beta
|
|
@@ -1410,6 +1610,11 @@ export declare type FilterReference = string | {
|
|
|
1410
1610
|
['require_all']: FilterReference[];
|
|
1411
1611
|
};
|
|
1412
1612
|
|
|
1613
|
+
export declare type FilterState = {
|
|
1614
|
+
value?: any;
|
|
1615
|
+
[key: string]: any;
|
|
1616
|
+
};
|
|
1617
|
+
|
|
1413
1618
|
/**
|
|
1414
1619
|
* Represents an item in a focus list.
|
|
1415
1620
|
* @beta
|
|
@@ -1440,6 +1645,13 @@ export declare type FolderPasteOptions = {
|
|
|
1440
1645
|
recursive?: boolean;
|
|
1441
1646
|
};
|
|
1442
1647
|
|
|
1648
|
+
declare enum GenericDataType {
|
|
1649
|
+
NUMERIC = 0,
|
|
1650
|
+
STRING = 1,
|
|
1651
|
+
TEMPORAL = 2,
|
|
1652
|
+
BOOLEAN = 3
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1443
1655
|
/**
|
|
1444
1656
|
* Options for getting attachments.
|
|
1445
1657
|
* @beta
|
|
@@ -1744,6 +1956,7 @@ export declare type JobManifest = {
|
|
|
1744
1956
|
stylers?: StylerDefinitions;
|
|
1745
1957
|
/** Optional collection of services for the job. */
|
|
1746
1958
|
services?: ServiceDefinitions;
|
|
1959
|
+
secrets?: ManifestSecrets;
|
|
1747
1960
|
};
|
|
1748
1961
|
|
|
1749
1962
|
/**
|
|
@@ -1754,6 +1967,14 @@ export declare type KnownCounts = {
|
|
|
1754
1967
|
[relationship_name: string]: number;
|
|
1755
1968
|
};
|
|
1756
1969
|
|
|
1970
|
+
export declare type ManifestSecrets = {
|
|
1971
|
+
[key: string]: {
|
|
1972
|
+
description: string;
|
|
1973
|
+
default?: string;
|
|
1974
|
+
required?: boolean;
|
|
1975
|
+
};
|
|
1976
|
+
};
|
|
1977
|
+
|
|
1757
1978
|
/**
|
|
1758
1979
|
* @beta
|
|
1759
1980
|
* Type representing the properties for a modal template, extending CustomTemplateIframeProps.
|
|
@@ -1799,6 +2020,21 @@ export declare type NamedEntityGroup = {
|
|
|
1799
2020
|
type: 'group';
|
|
1800
2021
|
};
|
|
1801
2022
|
|
|
2023
|
+
export declare interface NativeFilterColumn {
|
|
2024
|
+
name: string;
|
|
2025
|
+
displayName?: string;
|
|
2026
|
+
}
|
|
2027
|
+
|
|
2028
|
+
export declare interface NativeFilterScope {
|
|
2029
|
+
rootPath: string[];
|
|
2030
|
+
excluded: number[];
|
|
2031
|
+
}
|
|
2032
|
+
|
|
2033
|
+
export declare interface NativeFilterTarget {
|
|
2034
|
+
datasetId: number;
|
|
2035
|
+
column: NativeFilterColumn;
|
|
2036
|
+
}
|
|
2037
|
+
|
|
1802
2038
|
/**
|
|
1803
2039
|
* @beta
|
|
1804
2040
|
* Type representing a Nunjucks file transform definition. Not yet supported.
|
|
@@ -1862,6 +2098,13 @@ export declare interface Ontology {
|
|
|
1862
2098
|
* @returns A promise that resolves to an array of connected entities.
|
|
1863
2099
|
*/
|
|
1864
2100
|
getConnectedEntities: <T extends Entity>(entity: Entity, relationship: Relationship | string, forceRefresh?: boolean) => Promise<T[]>;
|
|
2101
|
+
/**
|
|
2102
|
+
* Gets connections by type for a given entity and concept.
|
|
2103
|
+
* @param entity - The entity for which to get connections.
|
|
2104
|
+
* @param concept - The concept for which to get connections.
|
|
2105
|
+
* @returns A promise that resolves to an array of connections.
|
|
2106
|
+
*/
|
|
2107
|
+
getConnectionsByType: <T extends Entity>(entity: Entity, concept: string, handler?: (connections: EConnection[]) => Promise<void>) => Promise<EConnection[]>;
|
|
1865
2108
|
/**
|
|
1866
2109
|
* Gets the concept names.
|
|
1867
2110
|
* @returns A promise that resolves to an array concept names.
|
|
@@ -1911,6 +2154,12 @@ export declare interface Ontology {
|
|
|
1911
2154
|
* @returns A promise that resolves to an array of relationships.
|
|
1912
2155
|
*/
|
|
1913
2156
|
getRelationshipsForEntity: (entity: Entity) => Promise<Relationship[]>;
|
|
2157
|
+
/**
|
|
2158
|
+
* Checks whether a concept exists.
|
|
2159
|
+
* @param conceptName - The name of the concept.
|
|
2160
|
+
* @returns A promise that resolves to a boolean indicating whether the concept exists.
|
|
2161
|
+
*/
|
|
2162
|
+
isConcept: (conceptName: string) => Promise<boolean>;
|
|
1914
2163
|
/**
|
|
1915
2164
|
* Sends a query.
|
|
1916
2165
|
* @param query - The query string.
|
|
@@ -1993,6 +2242,37 @@ export declare type OS_CONFIRM_MODAL_RESPONSE = typeof OS_CONFIRM_MODAL_YES | ty
|
|
|
1993
2242
|
*/
|
|
1994
2243
|
export declare const OS_CONFIRM_MODAL_YES = true;
|
|
1995
2244
|
|
|
2245
|
+
/**
|
|
2246
|
+
* @beta
|
|
2247
|
+
* Interface representing a client for interacting with the OctoStar API.
|
|
2248
|
+
*/
|
|
2249
|
+
export declare interface OsAPIClient {
|
|
2250
|
+
/**
|
|
2251
|
+
* Fetch data from the API.
|
|
2252
|
+
* @param options - Configuration options for the fetch request.
|
|
2253
|
+
* @returns A promise that resolves with the fetched data of type T.
|
|
2254
|
+
*/
|
|
2255
|
+
fetchData<T>(options: FetchOptions): Promise<T>;
|
|
2256
|
+
/**
|
|
2257
|
+
* Stream data from the API.
|
|
2258
|
+
* @param options - Configuration options for the stream request.
|
|
2259
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2260
|
+
*/
|
|
2261
|
+
streamData(options: FetchOptions): Promise<ReadableStream<Uint8Array>>;
|
|
2262
|
+
/**
|
|
2263
|
+
* Streams text data from the API.
|
|
2264
|
+
* @param options - Configuration options for the stream request.
|
|
2265
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2266
|
+
*/
|
|
2267
|
+
streamText(options: StreamTextOptions): Promise<void>;
|
|
2268
|
+
/**
|
|
2269
|
+
* Streams JSON line data from the API.
|
|
2270
|
+
* @param options - Configuration options for the stream request.
|
|
2271
|
+
* @returns A promise that resolves when the streaming is complete.
|
|
2272
|
+
*/
|
|
2273
|
+
streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
|
|
2274
|
+
}
|
|
2275
|
+
|
|
1996
2276
|
/**
|
|
1997
2277
|
* Represents audit fields for OS (Operational Support) records.
|
|
1998
2278
|
* @beta
|
|
@@ -2177,6 +2457,10 @@ export declare type PasteContextOptions = {
|
|
|
2177
2457
|
* Query for the context.
|
|
2178
2458
|
*/
|
|
2179
2459
|
query?: ConceptFilter;
|
|
2460
|
+
/**
|
|
2461
|
+
* Whether to return a SavedSet entity when a folder is dropped.
|
|
2462
|
+
*/
|
|
2463
|
+
preferSavedSet?: boolean;
|
|
2180
2464
|
};
|
|
2181
2465
|
|
|
2182
2466
|
/**
|
|
@@ -2267,6 +2551,17 @@ export declare enum ProcessingStatusCode {
|
|
|
2267
2551
|
UNKNOWN = "UNKNOWN"
|
|
2268
2552
|
}
|
|
2269
2553
|
|
|
2554
|
+
/**
|
|
2555
|
+
* The options for the prompt.
|
|
2556
|
+
*/
|
|
2557
|
+
export declare type PromptOptions = {
|
|
2558
|
+
model?: string;
|
|
2559
|
+
apiKey?: string;
|
|
2560
|
+
stream?: boolean;
|
|
2561
|
+
enableRag?: boolean;
|
|
2562
|
+
cohereKey?: string;
|
|
2563
|
+
};
|
|
2564
|
+
|
|
2270
2565
|
/**
|
|
2271
2566
|
* Represents a property of a concept.
|
|
2272
2567
|
* @beta
|
|
@@ -2304,50 +2599,6 @@ export declare type ProvidedTransformDefinition = {
|
|
|
2304
2599
|
type: 'provided';
|
|
2305
2600
|
};
|
|
2306
2601
|
|
|
2307
|
-
/**
|
|
2308
|
-
* @beta
|
|
2309
|
-
* Type representing a Python file styler definition.
|
|
2310
|
-
*/
|
|
2311
|
-
export declare type PythonFileStylerDefinition = PythonType & FileCode;
|
|
2312
|
-
|
|
2313
|
-
/**
|
|
2314
|
-
* @beta
|
|
2315
|
-
* Type representing a Python file transform definition. Not yet supported.
|
|
2316
|
-
*/
|
|
2317
|
-
export declare type PythonFileTransformDefinition = PythonType & FileCode;
|
|
2318
|
-
|
|
2319
|
-
/**
|
|
2320
|
-
* @beta
|
|
2321
|
-
* Type representing a Python filter definition.
|
|
2322
|
-
*/
|
|
2323
|
-
export declare type PythonFilterDefinition = {
|
|
2324
|
-
/** The type of the filter, always 'python' for this type. */
|
|
2325
|
-
type: 'python';
|
|
2326
|
-
/** The Python code defining the filter. */
|
|
2327
|
-
code: string;
|
|
2328
|
-
};
|
|
2329
|
-
|
|
2330
|
-
/**
|
|
2331
|
-
* @beta
|
|
2332
|
-
* Type representing an inline Python styler definition.
|
|
2333
|
-
*/
|
|
2334
|
-
export declare type PythonInlineStylerDefinition = PythonType & InlineCode;
|
|
2335
|
-
|
|
2336
|
-
/**
|
|
2337
|
-
* @beta
|
|
2338
|
-
* Type representing an inline Python transform definition.
|
|
2339
|
-
*/
|
|
2340
|
-
export declare type PythonInlineTransformDefinition = PythonType & InlineCode;
|
|
2341
|
-
|
|
2342
|
-
/**
|
|
2343
|
-
* @beta
|
|
2344
|
-
* Type representing a Python file transform definition.
|
|
2345
|
-
*/
|
|
2346
|
-
export declare type PythonType = {
|
|
2347
|
-
/** The type of the transform or styler, always 'python' for this type. */
|
|
2348
|
-
type: 'python';
|
|
2349
|
-
};
|
|
2350
|
-
|
|
2351
2602
|
/**
|
|
2352
2603
|
* @beta
|
|
2353
2604
|
* Type representing a query, which can be a string or a function returning a promise.
|
|
@@ -2391,13 +2642,10 @@ export declare type QueryExecutor = {
|
|
|
2391
2642
|
|
|
2392
2643
|
/**
|
|
2393
2644
|
* @beta
|
|
2394
|
-
*
|
|
2645
|
+
* A union type that represents all possible filter clauses in a query object.
|
|
2646
|
+
* It can be either a binary filter clause or a unary filter clause.
|
|
2395
2647
|
*/
|
|
2396
|
-
export declare
|
|
2397
|
-
col: string;
|
|
2398
|
-
op: BinaryOperator;
|
|
2399
|
-
val: Comparator;
|
|
2400
|
-
}
|
|
2648
|
+
export declare type QueryObjectFilterClause = BinaryObjectFilterClause | UnaryObjectFilterClause;
|
|
2401
2649
|
|
|
2402
2650
|
/**
|
|
2403
2651
|
* @beta
|
|
@@ -2411,6 +2659,11 @@ export declare type QueryResponse = any[];
|
|
|
2411
2659
|
*/
|
|
2412
2660
|
export declare type QueryResult = ApiResult<any[]>;
|
|
2413
2661
|
|
|
2662
|
+
declare type QueryResult_2 = {
|
|
2663
|
+
language: string;
|
|
2664
|
+
query: string;
|
|
2665
|
+
};
|
|
2666
|
+
|
|
2414
2667
|
/**
|
|
2415
2668
|
* @beta
|
|
2416
2669
|
* Type representing a successful query result.
|
|
@@ -2452,6 +2705,17 @@ export declare type ReasonedBoolean = {
|
|
|
2452
2705
|
reason: string;
|
|
2453
2706
|
};
|
|
2454
2707
|
|
|
2708
|
+
export declare interface RecordData extends ChartDataResponseResult {
|
|
2709
|
+
data: Record<string, any>[];
|
|
2710
|
+
}
|
|
2711
|
+
|
|
2712
|
+
export declare type RecordFetchOptions = {
|
|
2713
|
+
all_columns: string[];
|
|
2714
|
+
order_by_cols: string[];
|
|
2715
|
+
row_limit: number;
|
|
2716
|
+
server_page_length: number;
|
|
2717
|
+
};
|
|
2718
|
+
|
|
2455
2719
|
/**
|
|
2456
2720
|
* Interface for providing records.
|
|
2457
2721
|
* @beta
|
|
@@ -2587,6 +2851,15 @@ export declare type RelationshipCountResult = {
|
|
|
2587
2851
|
expired?: boolean;
|
|
2588
2852
|
};
|
|
2589
2853
|
|
|
2854
|
+
export declare type RemoteAppApi = {
|
|
2855
|
+
subscribeToContext: SubscribeToContextFn;
|
|
2856
|
+
unsubscribeFromContext: UnsubscribeFromContextFn;
|
|
2857
|
+
subscribeToDragStart: SubscribeDragStartFn;
|
|
2858
|
+
unsubscribeFromDragStart: UnsubscribeFromDragStartFn;
|
|
2859
|
+
dropZoneRequest: DropZoneRequestFn;
|
|
2860
|
+
setTransformResult: SetTransformResultFn;
|
|
2861
|
+
};
|
|
2862
|
+
|
|
2590
2863
|
/**
|
|
2591
2864
|
* Properties for saving as modal.
|
|
2592
2865
|
* @beta
|
|
@@ -2602,6 +2875,49 @@ export declare type SaveAsModalProps = {
|
|
|
2602
2875
|
app?: WorkspaceItem;
|
|
2603
2876
|
};
|
|
2604
2877
|
|
|
2878
|
+
export declare const SAVED_SEARCH_MESSAGE_TYPES: Readonly<{
|
|
2879
|
+
getRecordsCount: "octostar:savedSearch:getRecordsCount";
|
|
2880
|
+
getRecordsCountQuery: "octostar:savedSearch:getRecordsCountQuery";
|
|
2881
|
+
getRecords: "octostar:savedSearch:getRecords";
|
|
2882
|
+
getRecordsQuery: "octostar:savedSearch:getRecordsQuery";
|
|
2883
|
+
getSavedSearchPasteContext: "octostar:savedSearch:getSavedSearchPasteContext";
|
|
2884
|
+
}>;
|
|
2885
|
+
|
|
2886
|
+
export declare const SAVED_SEARCH_PREFIX = "octostar:savedSearch:";
|
|
2887
|
+
|
|
2888
|
+
export declare interface SavedDatasource {
|
|
2889
|
+
uid: string;
|
|
2890
|
+
id: number;
|
|
2891
|
+
name?: string;
|
|
2892
|
+
table_name: string;
|
|
2893
|
+
type: string;
|
|
2894
|
+
main_dttm_col: string;
|
|
2895
|
+
}
|
|
2896
|
+
|
|
2897
|
+
export declare interface SavedSearchAPIInterface {
|
|
2898
|
+
getRecordsCount(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<BigNumber | number | null>;
|
|
2899
|
+
getRecordsCountQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<number | null>;
|
|
2900
|
+
getRecords(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: Partial<RecordFetchOptions>): Promise<RecordData | null>;
|
|
2901
|
+
getRecordsQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: RecordFetchOptions): Promise<QueryResult_2 | null>;
|
|
2902
|
+
getSavedSearchPasteContext(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<EntityPasteContext>;
|
|
2903
|
+
}
|
|
2904
|
+
|
|
2905
|
+
export declare interface SavedSearchContent {
|
|
2906
|
+
concept: string;
|
|
2907
|
+
dataset: true;
|
|
2908
|
+
filters: Filter[];
|
|
2909
|
+
crossFilters: DataMask[];
|
|
2910
|
+
datasourcesInScope: {
|
|
2911
|
+
[uid: string]: SavedDatasource;
|
|
2912
|
+
};
|
|
2913
|
+
initialCount?: number;
|
|
2914
|
+
}
|
|
2915
|
+
|
|
2916
|
+
export declare interface SavedSetContent {
|
|
2917
|
+
lastFiredQuery: string;
|
|
2918
|
+
uiState: Record<string, any>;
|
|
2919
|
+
}
|
|
2920
|
+
|
|
2605
2921
|
/**
|
|
2606
2922
|
* @beta
|
|
2607
2923
|
* Type representing a saved template, extending CustomTemplate.
|
|
@@ -2654,6 +2970,17 @@ export declare type SearchFilter = {
|
|
|
2654
2970
|
imageUrl?: string;
|
|
2655
2971
|
};
|
|
2656
2972
|
|
|
2973
|
+
/**
|
|
2974
|
+
* @beta
|
|
2975
|
+
* Interface representing the options given to search
|
|
2976
|
+
*/
|
|
2977
|
+
export declare interface SearchOptions {
|
|
2978
|
+
/**
|
|
2979
|
+
* The maximum number of entities returned.
|
|
2980
|
+
*/
|
|
2981
|
+
limit?: number;
|
|
2982
|
+
}
|
|
2983
|
+
|
|
2657
2984
|
/**
|
|
2658
2985
|
* @beta
|
|
2659
2986
|
* Interface representing the properties for the Search component.
|
|
@@ -2675,6 +3002,14 @@ export declare interface SearchProps {
|
|
|
2675
3002
|
* the default image to use for the search.
|
|
2676
3003
|
*/
|
|
2677
3004
|
image?: WorkspaceItem;
|
|
3005
|
+
/**
|
|
3006
|
+
* disable ask AI
|
|
3007
|
+
*/
|
|
3008
|
+
disableAskAI?: boolean;
|
|
3009
|
+
/**
|
|
3010
|
+
* disable save search
|
|
3011
|
+
*/
|
|
3012
|
+
disableSaveSearch?: boolean;
|
|
2678
3013
|
}
|
|
2679
3014
|
|
|
2680
3015
|
/**
|
|
@@ -2833,6 +3168,8 @@ export declare type ServiceDefinitions = {
|
|
|
2833
3168
|
*/
|
|
2834
3169
|
export declare type ServiceRole = 'context_menu' | 'record_view' | 'set_view';
|
|
2835
3170
|
|
|
3171
|
+
export declare type SetTransformResultFn = (args: any[]) => Promise<void>;
|
|
3172
|
+
|
|
2836
3173
|
/**
|
|
2837
3174
|
* @beta
|
|
2838
3175
|
* Type representing the details of an ontology to be shown.
|
|
@@ -2887,25 +3224,60 @@ export declare enum SortOrder {
|
|
|
2887
3224
|
HIDE = -1
|
|
2888
3225
|
}
|
|
2889
3226
|
|
|
3227
|
+
/**
|
|
3228
|
+
* @beta
|
|
3229
|
+
* Options for streaming JSON line data from an API.
|
|
3230
|
+
*/
|
|
3231
|
+
export declare interface StreamJsonOptions<T> extends FetchOptions {
|
|
3232
|
+
/**
|
|
3233
|
+
* The asynchronous function to process each JSON object.
|
|
3234
|
+
*/
|
|
3235
|
+
jsonHandler: (value: T) => Promise<void>;
|
|
3236
|
+
}
|
|
3237
|
+
|
|
3238
|
+
/**
|
|
3239
|
+
* @beta
|
|
3240
|
+
* Options for streaming text data from an API.
|
|
3241
|
+
*/
|
|
3242
|
+
export declare interface StreamTextOptions extends FetchOptions {
|
|
3243
|
+
/**
|
|
3244
|
+
* The asynchronous function to process each line of text.
|
|
3245
|
+
*/
|
|
3246
|
+
handler: (line: string) => Promise<void>;
|
|
3247
|
+
}
|
|
3248
|
+
|
|
2890
3249
|
/**
|
|
2891
3250
|
* @beta
|
|
2892
3251
|
* Type representing a styler with methods for getting G6 node and edge styles.
|
|
3252
|
+
* See ColorByType.ts for an example
|
|
2893
3253
|
*/
|
|
2894
3254
|
export declare type Styler = {
|
|
2895
3255
|
/**
|
|
2896
|
-
*
|
|
2897
|
-
*
|
|
2898
|
-
*
|
|
2899
|
-
*
|
|
3256
|
+
* Use this function to modify style of a node from outside the graph.
|
|
3257
|
+
* You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
|
|
3258
|
+
* This can lead do recursive clone error later on.
|
|
3259
|
+
* Merging with actual style will be handled automatically!
|
|
3260
|
+
* Use them just as a reference:
|
|
3261
|
+
* - @param originStyle for eg original node radius (if its a circural node), so you want to eg multiply it by amount of connections.
|
|
3262
|
+
* - @param currentStyle for eg current node radius (if its a circural node), so you want to eg apply a holor like a heatmap by amount of connections.
|
|
3263
|
+
* @param entity - The entity for which to get the node style.
|
|
3264
|
+
* @param originStyle - The original style (the one passed to node during it's initialization). See '@antv/graphin' -> NodeStyle
|
|
3265
|
+
* @param currentStyle - The current style. See '@antv/graphin' -> NodeStyle
|
|
3266
|
+
* @returns A promise that resolves to the style patch. See '@antv/graphin' -> NodeStyle
|
|
2900
3267
|
*/
|
|
2901
|
-
getG6NodeStyle?: (
|
|
3268
|
+
getG6NodeStyle?: (entity: Entity, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
|
|
2902
3269
|
/**
|
|
2903
|
-
*
|
|
2904
|
-
*
|
|
2905
|
-
*
|
|
2906
|
-
*
|
|
3270
|
+
* Use this function to modify style of a edge from outside the graph.
|
|
3271
|
+
* You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
|
|
3272
|
+
* This can lead do recursive clone error later on.
|
|
3273
|
+
* Merging with actual style will be handled automatically!
|
|
3274
|
+
* Use them just as a reference, eg edge width to multiply.
|
|
3275
|
+
* @param edge - The edge specification for which to get the edge style.
|
|
3276
|
+
* @param originStyle - The original style (the one passed to edge during it's initialization). See '@antv/graphin' -> EdgeStyle
|
|
3277
|
+
* @param currentStyle - The current style. See '@antv/graphin' -> EdgeStyle
|
|
3278
|
+
* @returns A promise that resolves to the style patch. See '@antv/graphin' -> EdgeStyle
|
|
2907
3279
|
*/
|
|
2908
|
-
getG6EdgeStyle?: (
|
|
3280
|
+
getG6EdgeStyle?: (edge: EdgeSpec, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
|
|
2909
3281
|
};
|
|
2910
3282
|
|
|
2911
3283
|
/**
|
|
@@ -2956,7 +3328,7 @@ export declare interface StylerContext {
|
|
|
2956
3328
|
* @beta
|
|
2957
3329
|
* Type representing a styler definition, which can be one of several specific types.
|
|
2958
3330
|
*/
|
|
2959
|
-
export declare type StylerDefinition =
|
|
3331
|
+
export declare type StylerDefinition = JavascriptFileStylerDefinition | JavascriptInlineStylerDefinition;
|
|
2960
3332
|
|
|
2961
3333
|
/**
|
|
2962
3334
|
* @beta
|
|
@@ -2985,6 +3357,10 @@ export declare type StylerOption = {
|
|
|
2985
3357
|
*/
|
|
2986
3358
|
export declare type StylerProducer = (context: StylerContext) => Promise<Styler>;
|
|
2987
3359
|
|
|
3360
|
+
export declare type SubscribeDragStartFn = (id: string, callback: Callback<unknown>) => void;
|
|
3361
|
+
|
|
3362
|
+
export declare type SubscribeToContextFn = (id: string, callback: Callback<unknown>) => void;
|
|
3363
|
+
|
|
2988
3364
|
/**
|
|
2989
3365
|
* Represents a tag with a name and value.
|
|
2990
3366
|
* @beta
|
|
@@ -3132,7 +3508,7 @@ export declare type TransformActionContext = DesktopActionContext & {
|
|
|
3132
3508
|
* @beta
|
|
3133
3509
|
* Type representing a transform definition, which can be one of several specific types.
|
|
3134
3510
|
*/
|
|
3135
|
-
export declare type TransformDefinition = ProvidedTransformDefinition | HttpTransformDefinition | IframeTransformDefinition |
|
|
3511
|
+
export declare type TransformDefinition = ProvidedTransformDefinition | HttpTransformDefinition | IframeTransformDefinition | JavascriptFileTransformDefinition | JavascriptInlineTransformDefinition | NunjucksFileTransformDefinition | NunjucksInlineTransformDefinition | EmitEventTransformDefinition;
|
|
3136
3512
|
|
|
3137
3513
|
/**
|
|
3138
3514
|
* @beta
|
|
@@ -3148,6 +3524,16 @@ export declare type TransformDefinitions = {
|
|
|
3148
3524
|
*/
|
|
3149
3525
|
export declare type trigger = 'hover' | 'contextMenu' | 'click';
|
|
3150
3526
|
|
|
3527
|
+
/**
|
|
3528
|
+
* @beta
|
|
3529
|
+
* Represents a filter clause with unary operations in a query object.
|
|
3530
|
+
* It supports operations for checking null or not-null conditions.
|
|
3531
|
+
*/
|
|
3532
|
+
export declare interface UnaryObjectFilterClause {
|
|
3533
|
+
col: string;
|
|
3534
|
+
op: 'IS NULL' | 'IS NOT NULL';
|
|
3535
|
+
}
|
|
3536
|
+
|
|
3151
3537
|
/**
|
|
3152
3538
|
* @beta
|
|
3153
3539
|
* Type representing an unsubscribe function.
|
|
@@ -3155,6 +3541,12 @@ export declare type trigger = 'hover' | 'contextMenu' | 'click';
|
|
|
3155
3541
|
*/
|
|
3156
3542
|
export declare type Unsubscribe = () => Promise<void>;
|
|
3157
3543
|
|
|
3544
|
+
export declare type UnsubscribeFn = (id: string) => void;
|
|
3545
|
+
|
|
3546
|
+
export declare type UnsubscribeFromContextFn = UnsubscribeFn;
|
|
3547
|
+
|
|
3548
|
+
export declare type UnsubscribeFromDragStartFn = UnsubscribeFn;
|
|
3549
|
+
|
|
3158
3550
|
/**
|
|
3159
3551
|
* @beta
|
|
3160
3552
|
* Type representing a user profile.
|
|
@@ -3324,6 +3716,13 @@ export declare interface WorkspaceChangeEmitter {
|
|
|
3324
3716
|
onOpenWorkspacesChanged: AddListener<Workspace[]>;
|
|
3325
3717
|
}
|
|
3326
3718
|
|
|
3719
|
+
export declare type WorkspaceConfig = Partial<{
|
|
3720
|
+
description: string;
|
|
3721
|
+
os_icon: string;
|
|
3722
|
+
color: string;
|
|
3723
|
+
id?: string;
|
|
3724
|
+
}>;
|
|
3725
|
+
|
|
3327
3726
|
/**
|
|
3328
3727
|
*
|
|
3329
3728
|
* @beta
|
|
@@ -3523,6 +3922,10 @@ export declare type WorkspaceItemTitleProps = DesktopActionContext & {
|
|
|
3523
3922
|
* Selected items in left sidebar
|
|
3524
3923
|
*/
|
|
3525
3924
|
selectedItems: WorkspaceItem[];
|
|
3925
|
+
/**
|
|
3926
|
+
* If the component it is being used inside a Markdown component
|
|
3927
|
+
*/
|
|
3928
|
+
markdown?: boolean;
|
|
3526
3929
|
};
|
|
3527
3930
|
|
|
3528
3931
|
/**
|