@octostar/platform-types 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/enums/ProcessingStatusCode.html +30 -0
- 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/ActionContext.html +5 -4
- package/dist/docs/interfaces/{QueryObjectFilterClause.html → BinaryObjectFilterClause.html} +6 -5
- package/dist/docs/interfaces/ChartDataResponseResult.html +20 -0
- package/dist/docs/interfaces/Colorful.html +3 -3
- package/dist/docs/interfaces/Concept.html +12 -12
- package/dist/docs/interfaces/Desktop.html +90 -81
- package/dist/docs/interfaces/DesktopActionContext.html +8 -7
- package/dist/docs/interfaces/DesktopSettings.html +5 -5
- 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 +23 -23
- package/dist/docs/interfaces/ProcessingStatus.html +12 -0
- 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/SearchProps.html +7 -5
- 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/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 +34 -3
- package/dist/docs/types/ActionHandler.html +2 -2
- package/dist/docs/types/AddCommentParams.html +2 -2
- package/dist/docs/types/AddListener.html +2 -2
- package/dist/docs/types/ApiErrorResult.html +2 -2
- package/dist/docs/types/ApiResult.html +2 -2
- package/dist/docs/types/ApiSuccessResult.html +2 -2
- package/dist/docs/types/App.html +2 -2
- package/dist/docs/types/AppRegistry.html +2 -2
- package/dist/docs/types/AppServiceCallOptions.html +2 -2
- package/dist/docs/types/AppServiceCallProps.html +2 -2
- package/dist/docs/types/AsyncFilter.html +2 -2
- package/dist/docs/types/AttachmentResponseType.html +2 -2
- package/dist/docs/types/AttachmentType.html +2 -2
- package/dist/docs/types/Behaviour.html +2 -2
- package/dist/docs/types/BinaryOperator.html +2 -2
- package/dist/docs/types/Callback.html +2 -2
- package/dist/docs/types/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 +4 -3
- 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 +2 -2
- package/dist/docs/types/DesktopOpenParams.html +2 -2
- package/dist/docs/types/DesktopStylerContext.html +2 -2
- package/dist/docs/types/DraftWorkspaceItem.html +2 -2
- package/dist/docs/types/DragEndParams.html +2 -2
- package/dist/docs/types/DragStartParams.html +2 -2
- package/dist/docs/types/DropZoneRequestFn.html +1 -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 +2 -2
- package/dist/docs/types/EntityEdge.html +2 -2
- package/dist/docs/types/EntityOTM.html +2 -2
- package/dist/docs/types/EntityPasteContext.html +2 -2
- package/dist/docs/types/EvalContext.html +1 -1
- package/dist/docs/types/EventContextType.html +2 -2
- package/dist/docs/types/EventEmitterType.html +2 -2
- package/dist/docs/types/EventName.html +2 -2
- package/dist/docs/types/EventProducer.html +2 -2
- package/dist/docs/types/EventPublisher.html +2 -2
- package/dist/docs/types/EventSubscriber.html +2 -2
- package/dist/docs/types/EventUnsubscriber.html +2 -2
- package/dist/docs/types/ExportOptions.html +2 -2
- package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
- package/dist/docs/types/ExtrasApi.html +1 -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 +2 -2
- package/dist/docs/types/Permission.html +2 -2
- package/dist/docs/types/Point.html +2 -2
- package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
- package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
- package/dist/docs/types/PythonFileStylerDefinition.html +2 -2
- package/dist/docs/types/PythonFileTransformDefinition.html +2 -2
- package/dist/docs/types/PythonFilterDefinition.html +2 -2
- package/dist/docs/types/PythonInlineStylerDefinition.html +2 -2
- package/dist/docs/types/PythonInlineTransformDefinition.html +2 -2
- package/dist/docs/types/PythonType.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 +3 -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/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/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 +355 -23
- package/lib/action.d.ts +2 -1
- package/lib/action.d.ts.map +1 -1
- package/lib/desktop.d.ts +37 -6
- package/lib/desktop.d.ts.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/index.d.ts +3 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +3 -0
- package/lib/index.js.map +1 -1
- package/lib/jobManifestTypes.d.ts +8 -0
- package/lib/jobManifestTypes.d.ts.map +1 -1
- package/lib/model.d.ts +86 -2
- package/lib/model.d.ts.map +1 -1
- package/lib/model.js +35 -0
- package/lib/model.js.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 +128 -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 +5 -1
- package/lib/search.d.ts.map +1 -1
- package/lib/styling.d.ts +23 -10
- package/lib/styling.d.ts.map +1 -1
- package/lib/templates.d.ts +2 -0
- package/lib/templates.d.ts.map +1 -1
- package/package.json +2 -2
package/dist/platform-types.d.ts
CHANGED
|
@@ -19,6 +19,7 @@ export declare interface ActionContext {
|
|
|
19
19
|
workspace?: Workspace;
|
|
20
20
|
dataTransfer?: IDataTransfer;
|
|
21
21
|
eventTopicPrefix?: string;
|
|
22
|
+
selectedItems?: WorkspaceItem[];
|
|
22
23
|
/**
|
|
23
24
|
* Callback function to be executed with the result of the action.
|
|
24
25
|
* @param result - The result object containing records and relationships.
|
|
@@ -221,6 +222,19 @@ export declare type Behaviour = {
|
|
|
221
222
|
edit?: () => Promise<void>;
|
|
222
223
|
};
|
|
223
224
|
|
|
225
|
+
declare type BigNumber = any;
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* @beta
|
|
229
|
+
* Represents a filter clause with binary operations in a query object.
|
|
230
|
+
* It supports operations involving a column, a binary operator, and a comparator value.
|
|
231
|
+
*/
|
|
232
|
+
export declare interface BinaryObjectFilterClause {
|
|
233
|
+
col: string;
|
|
234
|
+
op: BinaryOperator;
|
|
235
|
+
val: Comparator;
|
|
236
|
+
}
|
|
237
|
+
|
|
224
238
|
/**
|
|
225
239
|
* @beta
|
|
226
240
|
* Type representing a binary operator.
|
|
@@ -235,6 +249,34 @@ export declare type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in
|
|
|
235
249
|
*/
|
|
236
250
|
export declare type Callback<T> = (t: T) => void;
|
|
237
251
|
|
|
252
|
+
export declare interface ChartDataResponseResult {
|
|
253
|
+
all_columns?: string[];
|
|
254
|
+
annotation_data: Record<string, any> | null;
|
|
255
|
+
cache_key: string | null;
|
|
256
|
+
cache_timeout: number | null;
|
|
257
|
+
cached_dttm: string | null;
|
|
258
|
+
/**
|
|
259
|
+
* Array of data records as dictionary
|
|
260
|
+
*/
|
|
261
|
+
data: Record<any, any>[];
|
|
262
|
+
/**
|
|
263
|
+
* Name of each column, for retaining the order of the output columns.
|
|
264
|
+
*/
|
|
265
|
+
colnames: string[];
|
|
266
|
+
/**
|
|
267
|
+
* Generic data types, based on the final output pandas dataframe.
|
|
268
|
+
*/
|
|
269
|
+
coltypes: GenericDataType[];
|
|
270
|
+
error: string | null;
|
|
271
|
+
is_cached: boolean;
|
|
272
|
+
query: string;
|
|
273
|
+
rowcount: number;
|
|
274
|
+
stacktrace: string | null;
|
|
275
|
+
status: 'stopped' | 'failed' | 'pending' | 'running' | 'scheduled' | 'success' | 'timed_out';
|
|
276
|
+
from_dttm: number | null;
|
|
277
|
+
to_dttm: number | null;
|
|
278
|
+
}
|
|
279
|
+
|
|
238
280
|
/**
|
|
239
281
|
* Interface for items that can have a color attribute.
|
|
240
282
|
* @beta
|
|
@@ -364,7 +406,7 @@ export declare type ConnectedEntity = Entity & {
|
|
|
364
406
|
* @beta
|
|
365
407
|
* Type representing the groups for a context menu.
|
|
366
408
|
*/
|
|
367
|
-
export declare type ContextMenuGroup = 'add' | 'addto' | 'copy' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags' | 'relations';
|
|
409
|
+
export declare type ContextMenuGroup = 'add' | 'addto' | 'copy' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags' | 'relations' | 'search';
|
|
368
410
|
|
|
369
411
|
/**
|
|
370
412
|
* @beta
|
|
@@ -433,15 +475,30 @@ export declare type CreateEntityFormProps = {
|
|
|
433
475
|
*/
|
|
434
476
|
entity?: Entity;
|
|
435
477
|
/**
|
|
436
|
-
* Workspace for the form.
|
|
478
|
+
* Workspace for the form. Defaults to activeWorkspace (when set) if no os_workspace is passed
|
|
437
479
|
*/
|
|
438
480
|
os_workspace?: string;
|
|
481
|
+
/**
|
|
482
|
+
* Fallback Workspace for the form in case there's no activeWorkspace or os_workspace
|
|
483
|
+
*/
|
|
484
|
+
fallback_workspace?: string;
|
|
439
485
|
/**
|
|
440
486
|
* Concept related to the form.
|
|
441
487
|
*/
|
|
442
488
|
concept?: string;
|
|
443
489
|
};
|
|
444
490
|
|
|
491
|
+
export declare type CreateLinkChartFn = (params: CreateLinkChartParams) => Promise<WorkspaceItem | undefined>;
|
|
492
|
+
|
|
493
|
+
export declare type CreateLinkChartParams = {
|
|
494
|
+
path?: string;
|
|
495
|
+
name: string;
|
|
496
|
+
nodes?: Entity[];
|
|
497
|
+
edges?: EdgeSpec[];
|
|
498
|
+
draft?: boolean;
|
|
499
|
+
os_workspace?: string;
|
|
500
|
+
};
|
|
501
|
+
|
|
445
502
|
/**
|
|
446
503
|
* Properties for creating relations dialog.
|
|
447
504
|
* @beta
|
|
@@ -554,6 +611,12 @@ export declare type DataContextType = {
|
|
|
554
611
|
removeFromGraph: (graph: GraphDataSpec) => void;
|
|
555
612
|
};
|
|
556
613
|
|
|
614
|
+
export declare type DataMask = {
|
|
615
|
+
extraFormData?: Record<string, any>;
|
|
616
|
+
filterState?: FilterState;
|
|
617
|
+
ownState?: Record<string, any>;
|
|
618
|
+
};
|
|
619
|
+
|
|
557
620
|
/**
|
|
558
621
|
* Interface for desktop actions.
|
|
559
622
|
* @beta
|
|
@@ -652,13 +715,13 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
652
715
|
*/
|
|
653
716
|
getAvailableTags: (entity: Entity, workspace?: string) => Promise<OsTag[]>;
|
|
654
717
|
/**
|
|
655
|
-
* Gets templates by layout
|
|
718
|
+
* Gets templates by layout or filter
|
|
656
719
|
*/
|
|
657
|
-
getTemplates: (layout?: string) => Promise<SavedTemplate[]>;
|
|
720
|
+
getTemplates: (layout?: string | ((template: SavedTemplate) => boolean)) => Promise<SavedTemplate[]>;
|
|
658
721
|
/**
|
|
659
|
-
* Gets a template by name or entity with an optional default template.
|
|
722
|
+
* Gets a template by name or entity or filter with an optional default template.
|
|
660
723
|
*/
|
|
661
|
-
getTemplate: (name: string | Entity, defaultTemplate?: string) => Promise<SavedTemplate>;
|
|
724
|
+
getTemplate: (name: string | Entity | ((template: SavedTemplate) => boolean), defaultTemplate?: string) => Promise<SavedTemplate>;
|
|
662
725
|
/**
|
|
663
726
|
* Gets the named app if it is on the desktop and in a running state.
|
|
664
727
|
*/
|
|
@@ -854,10 +917,33 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
|
|
|
854
917
|
* Connect an attachment to an entity as featured_in
|
|
855
918
|
*/
|
|
856
919
|
addAttachment: (entity: WorkspaceItem, file?: WorkspaceItem) => void;
|
|
920
|
+
/**
|
|
921
|
+
* Trigger a modal to allow users to manage the unzipping and extraction process within the workspace.
|
|
922
|
+
*/
|
|
923
|
+
unzipFiles: (entity: WorkspaceItem, file: File) => void;
|
|
857
924
|
/**
|
|
858
925
|
* Get config files
|
|
859
926
|
*/
|
|
860
927
|
getConfigFiles: (name: string) => Promise<WorkspaceItem[]>;
|
|
928
|
+
/**
|
|
929
|
+
* "Cache" for workspaces, avoiding to return a modal error, if this workspace was fetched before
|
|
930
|
+
*/
|
|
931
|
+
workspaceStore: {
|
|
932
|
+
[os_workspace: string]: Workspace;
|
|
933
|
+
};
|
|
934
|
+
/**
|
|
935
|
+
* Property to know if should show or not the modal
|
|
936
|
+
*/
|
|
937
|
+
failedWorkspaceModal: Promise<OS_CONFIRM_MODAL_RESPONSE> | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* Method to show workspace modal error only once per time
|
|
940
|
+
*/
|
|
941
|
+
handleFailedWorkspace: (wsuuid: string) => Promise<OS_CONFIRM_MODAL_RESPONSE>;
|
|
942
|
+
getWhitelabelingInfo(): Promise<{
|
|
943
|
+
OCTOSTAR_MAIN_LOGO: string;
|
|
944
|
+
OCTOSTAR_FAVICON: string;
|
|
945
|
+
OCTOSTAR_SPINNER: string;
|
|
946
|
+
}>;
|
|
861
947
|
}
|
|
862
948
|
|
|
863
949
|
/**
|
|
@@ -1024,7 +1110,7 @@ export declare interface DesktopSettings {
|
|
|
1024
1110
|
*/
|
|
1025
1111
|
setOpenWorkspaceIds: (ids: string[]) => Promise<void>;
|
|
1026
1112
|
/**
|
|
1027
|
-
* Listener for changes in open workspace IDs
|
|
1113
|
+
* Listener for changes in open workspace IDs list (list gets updated on eg close / open event)
|
|
1028
1114
|
*/
|
|
1029
1115
|
onOpenWorkspaceIdsChanged: AddListener<string[]>;
|
|
1030
1116
|
}
|
|
@@ -1097,6 +1183,13 @@ export declare type DragStartParams = {
|
|
|
1097
1183
|
dragEndTopic: string;
|
|
1098
1184
|
};
|
|
1099
1185
|
|
|
1186
|
+
export declare type DropZoneRequestFn = (args: any[]) => Promise<DropZoneRequestResult>;
|
|
1187
|
+
|
|
1188
|
+
export declare type DropZoneRequestResult = {
|
|
1189
|
+
to: any;
|
|
1190
|
+
data: any;
|
|
1191
|
+
};
|
|
1192
|
+
|
|
1100
1193
|
/**
|
|
1101
1194
|
* @beta
|
|
1102
1195
|
* Type representing a connection between two entities with a relationship.
|
|
@@ -1318,6 +1411,10 @@ export declare type ExtractEntitiesOptions = {
|
|
|
1318
1411
|
hydrate?: boolean;
|
|
1319
1412
|
};
|
|
1320
1413
|
|
|
1414
|
+
export declare type ExtrasApi = {
|
|
1415
|
+
createLinkChart: CreateLinkChartFn;
|
|
1416
|
+
};
|
|
1417
|
+
|
|
1321
1418
|
/**
|
|
1322
1419
|
* @beta
|
|
1323
1420
|
* File containing the code. Not yet supported.
|
|
@@ -1354,6 +1451,30 @@ export declare type FileTreeOptions = {
|
|
|
1354
1451
|
structure?: boolean;
|
|
1355
1452
|
};
|
|
1356
1453
|
|
|
1454
|
+
export declare type Filter = {
|
|
1455
|
+
cascadeParentIds: string[];
|
|
1456
|
+
defaultDataMask: DataMask;
|
|
1457
|
+
id: string;
|
|
1458
|
+
name: string;
|
|
1459
|
+
scope: NativeFilterScope;
|
|
1460
|
+
filterType: string;
|
|
1461
|
+
targets: [Partial<NativeFilterTarget>];
|
|
1462
|
+
controlValues: {
|
|
1463
|
+
[key: string]: any;
|
|
1464
|
+
};
|
|
1465
|
+
sortMetric?: string | null;
|
|
1466
|
+
adhoc_filters?: Record<any, any>[];
|
|
1467
|
+
granularity_sqla?: string;
|
|
1468
|
+
granularity?: string;
|
|
1469
|
+
time_grain_sqla?: string;
|
|
1470
|
+
time_range?: string;
|
|
1471
|
+
requiredFirst?: boolean;
|
|
1472
|
+
tabsInScope?: string[];
|
|
1473
|
+
chartsInScope?: number[];
|
|
1474
|
+
type: 'NATIVE_FILTER';
|
|
1475
|
+
description: string;
|
|
1476
|
+
};
|
|
1477
|
+
|
|
1357
1478
|
/**
|
|
1358
1479
|
* @beta
|
|
1359
1480
|
* Type representing a filter definition, which can be one of several specific filter types.
|
|
@@ -1382,6 +1503,11 @@ export declare type FilterReference = string | {
|
|
|
1382
1503
|
['require_all']: FilterReference[];
|
|
1383
1504
|
};
|
|
1384
1505
|
|
|
1506
|
+
export declare type FilterState = {
|
|
1507
|
+
value?: any;
|
|
1508
|
+
[key: string]: any;
|
|
1509
|
+
};
|
|
1510
|
+
|
|
1385
1511
|
/**
|
|
1386
1512
|
* Represents an item in a focus list.
|
|
1387
1513
|
* @beta
|
|
@@ -1412,6 +1538,13 @@ export declare type FolderPasteOptions = {
|
|
|
1412
1538
|
recursive?: boolean;
|
|
1413
1539
|
};
|
|
1414
1540
|
|
|
1541
|
+
declare enum GenericDataType {
|
|
1542
|
+
NUMERIC = 0,
|
|
1543
|
+
STRING = 1,
|
|
1544
|
+
TEMPORAL = 2,
|
|
1545
|
+
BOOLEAN = 3
|
|
1546
|
+
}
|
|
1547
|
+
|
|
1415
1548
|
/**
|
|
1416
1549
|
* Options for getting attachments.
|
|
1417
1550
|
* @beta
|
|
@@ -1716,6 +1849,7 @@ export declare type JobManifest = {
|
|
|
1716
1849
|
stylers?: StylerDefinitions;
|
|
1717
1850
|
/** Optional collection of services for the job. */
|
|
1718
1851
|
services?: ServiceDefinitions;
|
|
1852
|
+
secrets?: ManifestSecrets;
|
|
1719
1853
|
};
|
|
1720
1854
|
|
|
1721
1855
|
/**
|
|
@@ -1726,6 +1860,14 @@ export declare type KnownCounts = {
|
|
|
1726
1860
|
[relationship_name: string]: number;
|
|
1727
1861
|
};
|
|
1728
1862
|
|
|
1863
|
+
export declare type ManifestSecrets = {
|
|
1864
|
+
[key: string]: {
|
|
1865
|
+
description: string;
|
|
1866
|
+
default?: string;
|
|
1867
|
+
required?: boolean;
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
|
|
1729
1871
|
/**
|
|
1730
1872
|
* @beta
|
|
1731
1873
|
* Type representing the properties for a modal template, extending CustomTemplateIframeProps.
|
|
@@ -1771,6 +1913,21 @@ export declare type NamedEntityGroup = {
|
|
|
1771
1913
|
type: 'group';
|
|
1772
1914
|
};
|
|
1773
1915
|
|
|
1916
|
+
export declare interface NativeFilterColumn {
|
|
1917
|
+
name: string;
|
|
1918
|
+
displayName?: string;
|
|
1919
|
+
}
|
|
1920
|
+
|
|
1921
|
+
export declare interface NativeFilterScope {
|
|
1922
|
+
rootPath: string[];
|
|
1923
|
+
excluded: number[];
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1926
|
+
export declare interface NativeFilterTarget {
|
|
1927
|
+
datasetId: number;
|
|
1928
|
+
column: NativeFilterColumn;
|
|
1929
|
+
}
|
|
1930
|
+
|
|
1774
1931
|
/**
|
|
1775
1932
|
* @beta
|
|
1776
1933
|
* Type representing a Nunjucks file transform definition. Not yet supported.
|
|
@@ -2177,6 +2334,68 @@ export declare type Point = {
|
|
|
2177
2334
|
y: number;
|
|
2178
2335
|
};
|
|
2179
2336
|
|
|
2337
|
+
/**
|
|
2338
|
+
* Represents the status of a processing operation.
|
|
2339
|
+
* @beta
|
|
2340
|
+
*/
|
|
2341
|
+
export declare interface ProcessingStatus {
|
|
2342
|
+
/**
|
|
2343
|
+
* The id of the entity being processed.
|
|
2344
|
+
*/
|
|
2345
|
+
entity_id: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* The type of the entity being processed.
|
|
2348
|
+
*/
|
|
2349
|
+
entity_type: string;
|
|
2350
|
+
/**
|
|
2351
|
+
* The status code of the processing operation.
|
|
2352
|
+
*/
|
|
2353
|
+
status_code: ProcessingStatusCode;
|
|
2354
|
+
/**
|
|
2355
|
+
* The reason for the processing operation.
|
|
2356
|
+
*/
|
|
2357
|
+
reason: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* The timeout for the processing operation.
|
|
2360
|
+
*/
|
|
2361
|
+
timeout: number;
|
|
2362
|
+
}
|
|
2363
|
+
|
|
2364
|
+
/**
|
|
2365
|
+
* Possible statuses of a NiFi pipeline task.
|
|
2366
|
+
* @beta
|
|
2367
|
+
*/
|
|
2368
|
+
export declare enum ProcessingStatusCode {
|
|
2369
|
+
/** Queued and awaiting execution */
|
|
2370
|
+
QUEUED = "QUEUED",
|
|
2371
|
+
/** Currently running */
|
|
2372
|
+
RUNNING = "RUNNING",
|
|
2373
|
+
/** Stopped manually */
|
|
2374
|
+
STOPPED = "STOPPED",
|
|
2375
|
+
/** Paused and can be resumed */
|
|
2376
|
+
PAUSED = "PAUSED",
|
|
2377
|
+
/** Completed successfully */
|
|
2378
|
+
COMPLETED = "COMPLETED",
|
|
2379
|
+
/** Encountered a failure */
|
|
2380
|
+
FAILED = "FAILED",
|
|
2381
|
+
/** Scheduled to run */
|
|
2382
|
+
SCHEDULED = "SCHEDULED",
|
|
2383
|
+
/** Starting up */
|
|
2384
|
+
STARTING = "STARTING",
|
|
2385
|
+
/** Shutting down */
|
|
2386
|
+
STOPPING = "STOPPING",
|
|
2387
|
+
/** Disabled and cannot run */
|
|
2388
|
+
DISABLED = "DISABLED",
|
|
2389
|
+
/** Invalid configuration */
|
|
2390
|
+
INVALID = "INVALID",
|
|
2391
|
+
/** Waiting for an external event */
|
|
2392
|
+
WAITING = "WAITING",
|
|
2393
|
+
/** Retrying after failure */
|
|
2394
|
+
RETRYING = "RETRYING",
|
|
2395
|
+
/** Status is unknown */
|
|
2396
|
+
UNKNOWN = "UNKNOWN"
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2180
2399
|
/**
|
|
2181
2400
|
* Represents a property of a concept.
|
|
2182
2401
|
* @beta
|
|
@@ -2301,13 +2520,10 @@ export declare type QueryExecutor = {
|
|
|
2301
2520
|
|
|
2302
2521
|
/**
|
|
2303
2522
|
* @beta
|
|
2304
|
-
*
|
|
2523
|
+
* A union type that represents all possible filter clauses in a query object.
|
|
2524
|
+
* It can be either a binary filter clause or a unary filter clause.
|
|
2305
2525
|
*/
|
|
2306
|
-
export declare
|
|
2307
|
-
col: string;
|
|
2308
|
-
op: BinaryOperator;
|
|
2309
|
-
val: Comparator;
|
|
2310
|
-
}
|
|
2526
|
+
export declare type QueryObjectFilterClause = BinaryObjectFilterClause | UnaryObjectFilterClause;
|
|
2311
2527
|
|
|
2312
2528
|
/**
|
|
2313
2529
|
* @beta
|
|
@@ -2321,6 +2537,11 @@ export declare type QueryResponse = any[];
|
|
|
2321
2537
|
*/
|
|
2322
2538
|
export declare type QueryResult = ApiResult<any[]>;
|
|
2323
2539
|
|
|
2540
|
+
declare type QueryResult_2 = {
|
|
2541
|
+
language: string;
|
|
2542
|
+
query: string;
|
|
2543
|
+
};
|
|
2544
|
+
|
|
2324
2545
|
/**
|
|
2325
2546
|
* @beta
|
|
2326
2547
|
* Type representing a successful query result.
|
|
@@ -2362,6 +2583,17 @@ export declare type ReasonedBoolean = {
|
|
|
2362
2583
|
reason: string;
|
|
2363
2584
|
};
|
|
2364
2585
|
|
|
2586
|
+
export declare interface RecordData extends ChartDataResponseResult {
|
|
2587
|
+
data: Record<string, any>[];
|
|
2588
|
+
}
|
|
2589
|
+
|
|
2590
|
+
export declare type RecordFetchOptions = {
|
|
2591
|
+
all_columns: string[];
|
|
2592
|
+
order_by_cols: string[];
|
|
2593
|
+
row_limit: number;
|
|
2594
|
+
server_page_length: number;
|
|
2595
|
+
};
|
|
2596
|
+
|
|
2365
2597
|
/**
|
|
2366
2598
|
* Interface for providing records.
|
|
2367
2599
|
* @beta
|
|
@@ -2497,6 +2729,15 @@ export declare type RelationshipCountResult = {
|
|
|
2497
2729
|
expired?: boolean;
|
|
2498
2730
|
};
|
|
2499
2731
|
|
|
2732
|
+
export declare type RemoteAppApi = {
|
|
2733
|
+
subscribeToContext: SubscribeToContextFn;
|
|
2734
|
+
unsubscribeFromContext: UnsubscribeFromContextFn;
|
|
2735
|
+
subscribeToDragStart: SubscribeDragStartFn;
|
|
2736
|
+
unsubscribeFromDragStart: UnsubscribeFromDragStartFn;
|
|
2737
|
+
dropZoneRequest: DropZoneRequestFn;
|
|
2738
|
+
setTransformResult: SetTransformResultFn;
|
|
2739
|
+
};
|
|
2740
|
+
|
|
2500
2741
|
/**
|
|
2501
2742
|
* Properties for saving as modal.
|
|
2502
2743
|
* @beta
|
|
@@ -2512,6 +2753,44 @@ export declare type SaveAsModalProps = {
|
|
|
2512
2753
|
app?: WorkspaceItem;
|
|
2513
2754
|
};
|
|
2514
2755
|
|
|
2756
|
+
export declare const SAVED_SEARCH_MESSAGE_TYPES: Readonly<{
|
|
2757
|
+
getRecordsCount: "octostar:savedSearch:getRecordsCount";
|
|
2758
|
+
getRecordsCountQuery: "octostar:savedSearch:getRecordsCountQuery";
|
|
2759
|
+
getRecords: "octostar:savedSearch:getRecords";
|
|
2760
|
+
getRecordsQuery: "octostar:savedSearch:getRecordsQuery";
|
|
2761
|
+
getSavedSearchPasteContext: "octostar:savedSearch:getSavedSearchPasteContext";
|
|
2762
|
+
}>;
|
|
2763
|
+
|
|
2764
|
+
export declare const SAVED_SEARCH_PREFIX = "octostar:savedSearch:";
|
|
2765
|
+
|
|
2766
|
+
export declare interface SavedDatasource {
|
|
2767
|
+
uid: string;
|
|
2768
|
+
id: number;
|
|
2769
|
+
name?: string;
|
|
2770
|
+
table_name: string;
|
|
2771
|
+
type: string;
|
|
2772
|
+
main_dttm_col: string;
|
|
2773
|
+
}
|
|
2774
|
+
|
|
2775
|
+
export declare interface SavedSearchAPIInterface {
|
|
2776
|
+
getRecordsCount(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<BigNumber | number | null>;
|
|
2777
|
+
getRecordsCountQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<number | null>;
|
|
2778
|
+
getRecords(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: Partial<RecordFetchOptions>): Promise<RecordData | null>;
|
|
2779
|
+
getRecordsQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: RecordFetchOptions): Promise<QueryResult_2 | null>;
|
|
2780
|
+
getSavedSearchPasteContext(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<EntityPasteContext>;
|
|
2781
|
+
}
|
|
2782
|
+
|
|
2783
|
+
export declare interface SavedSearchContent {
|
|
2784
|
+
concept: string;
|
|
2785
|
+
dataset: true;
|
|
2786
|
+
filters: Filter[];
|
|
2787
|
+
crossFilters: DataMask[];
|
|
2788
|
+
datasourcesInScope: {
|
|
2789
|
+
[uid: string]: SavedDatasource;
|
|
2790
|
+
};
|
|
2791
|
+
initialCount?: number;
|
|
2792
|
+
}
|
|
2793
|
+
|
|
2515
2794
|
/**
|
|
2516
2795
|
* @beta
|
|
2517
2796
|
* Type representing a saved template, extending CustomTemplate.
|
|
@@ -2581,6 +2860,10 @@ export declare interface SearchProps {
|
|
|
2581
2860
|
* the filters to apply to the search.
|
|
2582
2861
|
*/
|
|
2583
2862
|
filters?: SearchFilter[];
|
|
2863
|
+
/**
|
|
2864
|
+
* the default image to use for the search.
|
|
2865
|
+
*/
|
|
2866
|
+
image?: WorkspaceItem;
|
|
2584
2867
|
}
|
|
2585
2868
|
|
|
2586
2869
|
/**
|
|
@@ -2739,6 +3022,8 @@ export declare type ServiceDefinitions = {
|
|
|
2739
3022
|
*/
|
|
2740
3023
|
export declare type ServiceRole = 'context_menu' | 'record_view' | 'set_view';
|
|
2741
3024
|
|
|
3025
|
+
export declare type SetTransformResultFn = (args: any[]) => Promise<void>;
|
|
3026
|
+
|
|
2742
3027
|
/**
|
|
2743
3028
|
* @beta
|
|
2744
3029
|
* Type representing the details of an ontology to be shown.
|
|
@@ -2796,22 +3081,35 @@ export declare enum SortOrder {
|
|
|
2796
3081
|
/**
|
|
2797
3082
|
* @beta
|
|
2798
3083
|
* Type representing a styler with methods for getting G6 node and edge styles.
|
|
3084
|
+
* See ColorByType.ts for an example
|
|
2799
3085
|
*/
|
|
2800
3086
|
export declare type Styler = {
|
|
2801
3087
|
/**
|
|
2802
|
-
*
|
|
2803
|
-
*
|
|
2804
|
-
*
|
|
2805
|
-
*
|
|
3088
|
+
* Use this function to modify style of a node from outside the graph.
|
|
3089
|
+
* You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
|
|
3090
|
+
* This can lead do recursive clone error later on.
|
|
3091
|
+
* Merging with actual style will be handled automatically!
|
|
3092
|
+
* Use them just as a reference:
|
|
3093
|
+
* - @param originStyle for eg original node radius (if its a circural node), so you want to eg multiply it by amount of connections.
|
|
3094
|
+
* - @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.
|
|
3095
|
+
* @param entity - The entity for which to get the node style.
|
|
3096
|
+
* @param originStyle - The original style (the one passed to node during it's initialization). See '@antv/graphin' -> NodeStyle
|
|
3097
|
+
* @param currentStyle - The current style. See '@antv/graphin' -> NodeStyle
|
|
3098
|
+
* @returns A promise that resolves to the style patch. See '@antv/graphin' -> NodeStyle
|
|
2806
3099
|
*/
|
|
2807
|
-
getG6NodeStyle?: (
|
|
3100
|
+
getG6NodeStyle?: (entity: Entity, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
|
|
2808
3101
|
/**
|
|
2809
|
-
*
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
2812
|
-
*
|
|
3102
|
+
* Use this function to modify style of a edge from outside the graph.
|
|
3103
|
+
* You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
|
|
3104
|
+
* This can lead do recursive clone error later on.
|
|
3105
|
+
* Merging with actual style will be handled automatically!
|
|
3106
|
+
* Use them just as a reference, eg edge width to multiply.
|
|
3107
|
+
* @param edge - The edge specification for which to get the edge style.
|
|
3108
|
+
* @param originStyle - The original style (the one passed to edge during it's initialization). See '@antv/graphin' -> EdgeStyle
|
|
3109
|
+
* @param currentStyle - The current style. See '@antv/graphin' -> EdgeStyle
|
|
3110
|
+
* @returns A promise that resolves to the style patch. See '@antv/graphin' -> EdgeStyle
|
|
2813
3111
|
*/
|
|
2814
|
-
getG6EdgeStyle?: (
|
|
3112
|
+
getG6EdgeStyle?: (edge: EdgeSpec, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
|
|
2815
3113
|
};
|
|
2816
3114
|
|
|
2817
3115
|
/**
|
|
@@ -2891,6 +3189,10 @@ export declare type StylerOption = {
|
|
|
2891
3189
|
*/
|
|
2892
3190
|
export declare type StylerProducer = (context: StylerContext) => Promise<Styler>;
|
|
2893
3191
|
|
|
3192
|
+
export declare type SubscribeDragStartFn = (id: string, callback: Callback<unknown>) => void;
|
|
3193
|
+
|
|
3194
|
+
export declare type SubscribeToContextFn = (id: string, callback: Callback<unknown>) => void;
|
|
3195
|
+
|
|
2894
3196
|
/**
|
|
2895
3197
|
* Represents a tag with a name and value.
|
|
2896
3198
|
* @beta
|
|
@@ -2975,6 +3277,8 @@ export declare type TemplateMetadata = {
|
|
|
2975
3277
|
description: string;
|
|
2976
3278
|
/** The concepts associated with the template. */
|
|
2977
3279
|
concepts: string[];
|
|
3280
|
+
/** The priority of the template. Default is 100, lower is higher priority. */
|
|
3281
|
+
priority?: number;
|
|
2978
3282
|
/** The type of the template. */
|
|
2979
3283
|
type: TemplateType;
|
|
2980
3284
|
/** The layout of the template. */
|
|
@@ -3052,6 +3356,16 @@ export declare type TransformDefinitions = {
|
|
|
3052
3356
|
*/
|
|
3053
3357
|
export declare type trigger = 'hover' | 'contextMenu' | 'click';
|
|
3054
3358
|
|
|
3359
|
+
/**
|
|
3360
|
+
* @beta
|
|
3361
|
+
* Represents a filter clause with unary operations in a query object.
|
|
3362
|
+
* It supports operations for checking null or not-null conditions.
|
|
3363
|
+
*/
|
|
3364
|
+
export declare interface UnaryObjectFilterClause {
|
|
3365
|
+
col: string;
|
|
3366
|
+
op: 'IS NULL' | 'IS NOT NULL';
|
|
3367
|
+
}
|
|
3368
|
+
|
|
3055
3369
|
/**
|
|
3056
3370
|
* @beta
|
|
3057
3371
|
* Type representing an unsubscribe function.
|
|
@@ -3059,6 +3373,12 @@ export declare type trigger = 'hover' | 'contextMenu' | 'click';
|
|
|
3059
3373
|
*/
|
|
3060
3374
|
export declare type Unsubscribe = () => Promise<void>;
|
|
3061
3375
|
|
|
3376
|
+
export declare type UnsubscribeFn = (id: string) => void;
|
|
3377
|
+
|
|
3378
|
+
export declare type UnsubscribeFromContextFn = UnsubscribeFn;
|
|
3379
|
+
|
|
3380
|
+
export declare type UnsubscribeFromDragStartFn = UnsubscribeFn;
|
|
3381
|
+
|
|
3062
3382
|
/**
|
|
3063
3383
|
* @beta
|
|
3064
3384
|
* Type representing a user profile.
|
|
@@ -3275,6 +3595,14 @@ export declare type WorkspaceItem<T = any> = WorkspaceRecord & {
|
|
|
3275
3595
|
* eg. 'folder1/folder2'
|
|
3276
3596
|
*/
|
|
3277
3597
|
'#os_path'?: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* The size in bytes of the content.
|
|
3600
|
+
*/
|
|
3601
|
+
os_content_size?: number;
|
|
3602
|
+
/**
|
|
3603
|
+
* Whether the item is readonly or not.
|
|
3604
|
+
*/
|
|
3605
|
+
os_readonly?: boolean;
|
|
3278
3606
|
};
|
|
3279
3607
|
|
|
3280
3608
|
/**
|
|
@@ -3415,6 +3743,10 @@ export declare type WorkspaceItemTitleProps = DesktopActionContext & {
|
|
|
3415
3743
|
* Whether the item is expanded.
|
|
3416
3744
|
*/
|
|
3417
3745
|
expanded?: boolean;
|
|
3746
|
+
/**
|
|
3747
|
+
* Selected items in left sidebar
|
|
3748
|
+
*/
|
|
3749
|
+
selectedItems: WorkspaceItem[];
|
|
3418
3750
|
};
|
|
3419
3751
|
|
|
3420
3752
|
/**
|
package/lib/action.d.ts
CHANGED
|
@@ -54,6 +54,7 @@ export interface ActionContext {
|
|
|
54
54
|
workspace?: Workspace;
|
|
55
55
|
dataTransfer?: IDataTransfer;
|
|
56
56
|
eventTopicPrefix?: string;
|
|
57
|
+
selectedItems?: WorkspaceItem[];
|
|
57
58
|
/**
|
|
58
59
|
* Callback function to be executed with the result of the action.
|
|
59
60
|
* @param result - The result object containing records and relationships.
|
|
@@ -72,7 +73,7 @@ export type trigger = 'hover' | 'contextMenu' | 'click';
|
|
|
72
73
|
* @beta
|
|
73
74
|
* Type representing the groups for a context menu.
|
|
74
75
|
*/
|
|
75
|
-
export type ContextMenuGroup = 'add' | 'addto' | 'copy' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags' | 'relations';
|
|
76
|
+
export type ContextMenuGroup = 'add' | 'addto' | 'copy' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags' | 'relations' | 'search';
|
|
76
77
|
/**
|
|
77
78
|
* @beta
|
|
78
79
|
* Type representing labels for context menu groups.
|
package/lib/action.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,YAAY,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpE,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,iDAAiD;IACjD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAEzB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAEzB,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,SAAS,GAAG,GAAG,CAAC;IACxB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,YAAY,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpE,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,iDAAiD;IACjD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAEzB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAEzB,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,SAAS,GAAG,GAAG,CAAC;IACxB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAEhC;;;OAGG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAA;KAAE,KAAK,IAAI,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACxB,KAAK,GACL,OAAO,GACP,MAAM,GACN,MAAM,GACN,WAAW,GACX,SAAS,GACT,MAAM,GACN,QAAQ,GACR,MAAM,GACN,WAAW,GACX,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;KAC7B,KAAK,IAAI,gBAAgB,CAAC,CAAC,EAAE,MAAM;CACrC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,CAAC,aAAa,GAAG;IACf,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC,GACF;IAAE,gBAAgB,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/B;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG;IAC9C,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACzC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC"}
|