@octostar/platform-types 0.5.2 → 0.5.4

package/dist/platform-types.d.ts

@@ -70,20 +70,6 @@ export declare type AddCommentParams = {
  */
 export declare type AddListener<T> = (callback: Callback<T>) => Promise<Unsubscribe>;
 
-/**
- * The interface for the AI client.
- */
-export declare interface AIClient {
-    /**
-     * Get the chat models.
-     */
-    getChatModels(): Promise<ChatModel[]>;
-    /**
-     * Prompt the AI.
-     */
-    prompt(prompt: string, options?: PromptOptions): Promise<string>;
-}
-
 /**
  * @beta
  * Type representing an error API result.
@@ -236,19 +222,6 @@ export declare type Behaviour = {
     edit?: () => Promise<void>;
 };
 
-declare type BigNumber = any;
-
-/**
- * @beta
- * Represents a filter clause with binary operations in a query object.
- * It supports operations involving a column, a binary operator, and a comparator value.
- */
-export declare interface BinaryObjectFilterClause {
-    col: string;
-    op: BinaryOperator;
-    val: Comparator;
-}
-
 /**
  * @beta
  * Type representing a binary operator.
@@ -263,69 +236,6 @@ export declare type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in
  */
 export declare type Callback<T> = (t: T) => void;
 
-export declare interface ChartDataResponseResult {
-    all_columns?: string[];
-    annotation_data: Record<string, any> | null;
-    cache_key: string | null;
-    cache_timeout: number | null;
-    cached_dttm: string | null;
-    /**
-     * Array of data records as dictionary
-     */
-    data: Record<any, any>[];
-    /**
-     * Name of each column, for retaining the order of the output columns.
-     */
-    colnames: string[];
-    /**
-     * Generic data types, based on the final output pandas dataframe.
-     */
-    coltypes: GenericDataType[];
-    error: string | null;
-    is_cached: boolean;
-    query: string;
-    rowcount: number;
-    stacktrace: string | null;
-    status: 'stopped' | 'failed' | 'pending' | 'running' | 'scheduled' | 'success' | 'timed_out';
-    from_dttm: number | null;
-    to_dttm: number | null;
-}
-
-export declare interface ChatMessage {
-    /**
-     * The id of the message. This is used to identify the message in the conversation.
-     * It is generated by the chat agent, and is used to update the message in the conversation.
-     * (It is repeated in each update, but this is ok because it is used to identify the message in the conversation.)
-     */
-    id: string;
-    /**
-     * The role of the message.
-     */
-    role: 'user' | 'assistant' | 'system';
-    /**
-     * The content of the message.
-     * For `update` and `complete` messages, this is the partial or final response.
-     * For `add_entities` and `remove_entities` messages, this is the json encoded list of entities.
-     */
-    content: string;
-    /**
-     * The type of the message.
-     */
-    type?: 'update' | 'complete' | 'add_entities' | 'remove_entities';
-    /**
-     * The timestamp of the message in ISO 8601 format.
-     */
-    timestamp?: string;
-}
-
-/**
- * The type for the chat model.
- */
-export declare type ChatModel = {
-    model_name: string;
-    description: string;
-};
-
 /**
  * Interface for items that can have a color attribute.
  * @beta
@@ -486,7 +396,6 @@ export declare type ContextMenuParams = ActionContext & {
     trigger?: trigger[];
     onMenuToggle?: (isOpen: boolean) => void;
     options?: ContextMenuOptions;
-    markdown?: boolean;
 };
 
 /**
@@ -538,17 +447,6 @@ export declare type CreateEntityFormProps = {
     concept?: string;
 };
 
-export declare type CreateLinkChartFn = (params: CreateLinkChartParams) => Promise<WorkspaceItem | undefined>;
-
-export declare type CreateLinkChartParams = {
-    path?: string;
-    name: string;
-    nodes?: Entity[];
-    edges?: EdgeSpec[];
-    draft?: boolean;
-    os_workspace?: string;
-};
-
 /**
  * Properties for creating relations dialog.
  * @beta
@@ -661,12 +559,6 @@ export declare type DataContextType = {
     removeFromGraph: (graph: GraphDataSpec) => void;
 };
 
-export declare type DataMask = {
-    extraFormData?: Record<string, any>;
-    filterState?: FilterState;
-    ownState?: Record<string, any>;
-};
-
 /**
  * Interface for desktop actions.
  * @beta
@@ -736,14 +628,6 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Gets items in a workspace by name.
      */
     getWorkspaceItems(os_item_name: string): Promise<WorkspaceItem[]>;
-    /**
-     * Gets the OsAPIClient.
-     */
-    getOsAPIClient(): Promise<OsAPIClient>;
-    /**
-     * Gets the AI client.
-     */
-    getAIClient(): Promise<AIClient>;
     /**
      * Applies a tag to an entity.
      */
@@ -791,7 +675,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * Creates a workspace by name.
      */
-    createWorkspace: (name: string, config?: WorkspaceConfig) => Promise<WorkspaceItem>;
+    createWorkspace: (name: string) => Promise<WorkspaceItem>;
     /**
      * Connects two entities with a relationship in a workspace.
      */
@@ -816,10 +700,6 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Exports an item or items with optional export options.
      */
     export: (item: WorkspaceItem | WorkspaceItem[], options?: ExportOptions) => Promise<void>;
-    /**
-     * Fetches an entity from the index, or from the ontology if not found in the index.
-     */
-    fetchEntity: (entity: EntityBase, options?: FetchEntityOptions) => Promise<Entity>;
     /**
      * Extracts entities from some text which may be json or a list of urls.
      */
@@ -848,13 +728,6 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Deletes local concept records in a workspace by base concept.
      */
     delete_local_concept_records: (workspace_id: string, base_concept: string) => Promise<void>;
-    /**
-     * Searches the index using the query string
-     * @param query OpenSearch qeuery string.
-     * @param options query options
-     * @returns a promise resolving to the found entities.
-     */
-    search: (query: string, options?: SearchOptions) => Promise<Entity[]>;
     /**
      * Searches experience with optional search options.
      */
@@ -1148,14 +1021,6 @@ export declare type DesktopActionOptions = {
      * Whether to raise the tab to the front.
      */
     raiseOnly?: boolean;
-    /**
-     * Open tab in a new tabset
-     */
-    newTabset?: boolean;
-    /**
-     * Wait for the tab to open
-     */
-    awaitShowTab?: boolean;
 };
 
 /**
@@ -1260,13 +1125,6 @@ export declare type DragStartParams = {
     dragEndTopic: string;
 };
 
-export declare type DropZoneRequestFn = (args: any[]) => Promise<DropZoneRequestResult>;
-
-export declare type DropZoneRequestResult = {
-    to: any;
-    data: any;
-};
-
 /**
  * @beta
  * Type representing a connection between two entities with a relationship.
@@ -1310,18 +1168,7 @@ export declare type EmitEventTransformDefinition = {
  * Represents an entity with basic attributes.
  * @beta
  */
-export declare type Entity = EntityBase & {
-    /**
-     * The label of the entity.
-     */
-    entity_label: string;
-};
-
-/**
- * Represents an entity without a label.
- * @beta
- */
-export declare type EntityBase = {
+export declare type Entity = {
     /**
      * The ID of the entity.
      */
@@ -1330,6 +1177,10 @@ export declare type EntityBase = {
      * The type of the entity.
      */
     entity_type: string;
+    /**
+     * The label of the entity.
+     */
+    entity_label: string;
 };
 
 /**
@@ -1495,27 +1346,6 @@ export declare type ExtractEntitiesOptions = {
     hydrate?: boolean;
 };
 
-export declare type ExtrasApi = {
-    createLinkChart: CreateLinkChartFn;
-};
-
-/**
- * Options for fetching an entity.
- * @beta
- */
-export declare type FetchEntityOptions = {};
-
-/**
- * @beta
- * Options for fetching data from an API.
- */
-export declare interface FetchOptions extends RequestInit {
-    /**
-     * The API endpoint to hit, starting with a slash.
-     */
-    endpoint: string;
-}
-
 /**
  * @beta
  * File containing the code. Not yet supported.
@@ -1552,30 +1382,6 @@ export declare type FileTreeOptions = {
     structure?: boolean;
 };
 
-export declare type Filter = {
-    cascadeParentIds: string[];
-    defaultDataMask: DataMask;
-    id: string;
-    name: string;
-    scope: NativeFilterScope;
-    filterType: string;
-    targets: [Partial<NativeFilterTarget>];
-    controlValues: {
-        [key: string]: any;
-    };
-    sortMetric?: string | null;
-    adhoc_filters?: Record<any, any>[];
-    granularity_sqla?: string;
-    granularity?: string;
-    time_grain_sqla?: string;
-    time_range?: string;
-    requiredFirst?: boolean;
-    tabsInScope?: string[];
-    chartsInScope?: number[];
-    type: 'NATIVE_FILTER';
-    description: string;
-};
-
 /**
  * @beta
  * Type representing a filter definition, which can be one of several specific filter types.
@@ -1604,11 +1410,6 @@ export declare type FilterReference = string | {
     ['require_all']: FilterReference[];
 };
 
-export declare type FilterState = {
-    value?: any;
-    [key: string]: any;
-};
-
 /**
  * Represents an item in a focus list.
  * @beta
@@ -1639,13 +1440,6 @@ export declare type FolderPasteOptions = {
     recursive?: boolean;
 };
 
-declare enum GenericDataType {
-    NUMERIC = 0,
-    STRING = 1,
-    TEMPORAL = 2,
-    BOOLEAN = 3
-}
-
 /**
  * Options for getting attachments.
  * @beta
@@ -1950,7 +1744,6 @@ export declare type JobManifest = {
     stylers?: StylerDefinitions;
     /** Optional collection of services for the job. */
     services?: ServiceDefinitions;
-    secrets?: ManifestSecrets;
 };
 
 /**
@@ -1961,14 +1754,6 @@ export declare type KnownCounts = {
     [relationship_name: string]: number;
 };
 
-export declare type ManifestSecrets = {
-    [key: string]: {
-        description: string;
-        default?: string;
-        required?: boolean;
-    };
-};
-
 /**
  * @beta
  * Type representing the properties for a modal template, extending CustomTemplateIframeProps.
@@ -2014,21 +1799,6 @@ export declare type NamedEntityGroup = {
     type: 'group';
 };
 
-export declare interface NativeFilterColumn {
-    name: string;
-    displayName?: string;
-}
-
-export declare interface NativeFilterScope {
-    rootPath: string[];
-    excluded: number[];
-}
-
-export declare interface NativeFilterTarget {
-    datasetId: number;
-    column: NativeFilterColumn;
-}
-
 /**
  * @beta
  * Type representing a Nunjucks file transform definition. Not yet supported.
@@ -2092,13 +1862,6 @@ export declare interface Ontology {
      * @returns A promise that resolves to an array of connected entities.
      */
     getConnectedEntities: <T extends Entity>(entity: Entity, relationship: Relationship | string, forceRefresh?: boolean) => Promise<T[]>;
-    /**
-     * Gets connections by type for a given entity and concept.
-     * @param entity - The entity for which to get connections.
-     * @param concept - The concept for which to get connections.
-     * @returns A promise that resolves to an array of connections.
-     */
-    getConnectionsByType: <T extends Entity>(entity: Entity, concept: string) => Promise<EConnection[]>;
     /**
      * Gets the concept names.
      * @returns A promise that resolves to an array concept names.
@@ -2230,37 +1993,6 @@ export declare type OS_CONFIRM_MODAL_RESPONSE = typeof OS_CONFIRM_MODAL_YES | ty
  */
 export declare const OS_CONFIRM_MODAL_YES = true;
 
-/**
- * @beta
- * Interface representing a client for interacting with the OctoStar API.
- */
-export declare interface OsAPIClient {
-    /**
-     * Fetch data from the API.
-     * @param options - Configuration options for the fetch request.
-     * @returns A promise that resolves with the fetched data of type T.
-     */
-    fetchData<T>(options: FetchOptions): Promise<T>;
-    /**
-     * Stream data from the API.
-     * @param options - Configuration options for the stream request.
-     * @returns A promise that resolves when the streaming is complete.
-     */
-    streamData(options: StreamOptions): Promise<void>;
-    /**
-     * Streams text data from the API.
-     * @param options - Configuration options for the stream request.
-     * @returns A promise that resolves when the streaming is complete.
-     */
-    streamText(options: StreamTextOptions): Promise<void>;
-    /**
-     * Streams JSON line data from the API.
-     * @param options - Configuration options for the stream request.
-     * @returns A promise that resolves when the streaming is complete.
-     */
-    streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
-}
-
 /**
  * Represents audit fields for OS (Operational Support) records.
  * @beta
@@ -2535,14 +2267,6 @@ export declare enum ProcessingStatusCode {
     UNKNOWN = "UNKNOWN"
 }
 
-/**
- * The options for the prompt.
- */
-export declare type PromptOptions = {
-    model?: string;
-    apiKey?: string;
-};
-
 /**
  * Represents a property of a concept.
  * @beta
@@ -2667,10 +2391,13 @@ export declare type QueryExecutor = {
 
 /**
  * @beta
- * A union type that represents all possible filter clauses in a query object.
- * It can be either a binary filter clause or a unary filter clause.
+ * Interface for a filter clause in a query object.
  */
-export declare type QueryObjectFilterClause = BinaryObjectFilterClause | UnaryObjectFilterClause;
+export declare interface QueryObjectFilterClause {
+    col: string;
+    op: BinaryOperator;
+    val: Comparator;
+}
 
 /**
  * @beta
@@ -2684,11 +2411,6 @@ export declare type QueryResponse = any[];
  */
 export declare type QueryResult = ApiResult<any[]>;
 
-declare type QueryResult_2 = {
-    language: string;
-    query: string;
-};
-
 /**
  * @beta
  * Type representing a successful query result.
@@ -2730,17 +2452,6 @@ export declare type ReasonedBoolean = {
     reason: string;
 };
 
-export declare interface RecordData extends ChartDataResponseResult {
-    data: Record<string, any>[];
-}
-
-export declare type RecordFetchOptions = {
-    all_columns: string[];
-    order_by_cols: string[];
-    row_limit: number;
-    server_page_length: number;
-};
-
 /**
  * Interface for providing records.
  * @beta
@@ -2876,15 +2587,6 @@ export declare type RelationshipCountResult = {
     expired?: boolean;
 };
 
-export declare type RemoteAppApi = {
-    subscribeToContext: SubscribeToContextFn;
-    unsubscribeFromContext: UnsubscribeFromContextFn;
-    subscribeToDragStart: SubscribeDragStartFn;
-    unsubscribeFromDragStart: UnsubscribeFromDragStartFn;
-    dropZoneRequest: DropZoneRequestFn;
-    setTransformResult: SetTransformResultFn;
-};
-
 /**
  * Properties for saving as modal.
  * @beta
@@ -2900,49 +2602,6 @@ export declare type SaveAsModalProps = {
     app?: WorkspaceItem;
 };
 
-export declare const SAVED_SEARCH_MESSAGE_TYPES: Readonly<{
-    getRecordsCount: "octostar:savedSearch:getRecordsCount";
-    getRecordsCountQuery: "octostar:savedSearch:getRecordsCountQuery";
-    getRecords: "octostar:savedSearch:getRecords";
-    getRecordsQuery: "octostar:savedSearch:getRecordsQuery";
-    getSavedSearchPasteContext: "octostar:savedSearch:getSavedSearchPasteContext";
-}>;
-
-export declare const SAVED_SEARCH_PREFIX = "octostar:savedSearch:";
-
-export declare interface SavedDatasource {
-    uid: string;
-    id: number;
-    name?: string;
-    table_name: string;
-    type: string;
-    main_dttm_col: string;
-}
-
-export declare interface SavedSearchAPIInterface {
-    getRecordsCount(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<BigNumber | number | null>;
-    getRecordsCountQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<number | null>;
-    getRecords(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: Partial<RecordFetchOptions>): Promise<RecordData | null>;
-    getRecordsQuery(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>, options?: RecordFetchOptions): Promise<QueryResult_2 | null>;
-    getSavedSearchPasteContext(savedSearchIdn: WorkspaceItemIdentifier<SavedSearchContent>): Promise<EntityPasteContext>;
-}
-
-export declare interface SavedSearchContent {
-    concept: string;
-    dataset: true;
-    filters: Filter[];
-    crossFilters: DataMask[];
-    datasourcesInScope: {
-        [uid: string]: SavedDatasource;
-    };
-    initialCount?: number;
-}
-
-export declare interface SavedSetContent {
-    lastFiredQuery: string;
-    uiState: Record<string, any>;
-}
-
 /**
  * @beta
  * Type representing a saved template, extending CustomTemplate.
@@ -2995,17 +2654,6 @@ export declare type SearchFilter = {
     imageUrl?: string;
 };
 
-/**
- * @beta
- * Interface representing the options given to search
- */
-export declare interface SearchOptions {
-    /**
-     * The maximum number of entities returned.
-     */
-    limit?: number;
-}
-
 /**
  * @beta
  * Interface representing the properties for the Search component.
@@ -3185,8 +2833,6 @@ export declare type ServiceDefinitions = {
  */
 export declare type ServiceRole = 'context_menu' | 'record_view' | 'set_view';
 
-export declare type SetTransformResultFn = (args: any[]) => Promise<void>;
-
 /**
  * @beta
  * Type representing the details of an ontology to be shown.
@@ -3241,71 +2887,25 @@ export declare enum SortOrder {
     HIDE = -1
 }
 
-/**
- * @beta
- * Options for streaming JSON line data from an API.
- */
-export declare interface StreamJsonOptions<T> extends FetchOptions {
-    /**
-     * The asynchronous function to process each JSON object.
-     */
-    jsonHandler: (value: T) => Promise<void>;
-}
-
-/**
- * @beta
- * Options for streaming data from an API.
- */
-export declare interface StreamOptions extends FetchOptions {
-    /**
-     * The asynchronous function to process each chunk of data.
-     */
-    handler: (chunk: Uint8Array) => Promise<void>;
-}
-
-/**
- * @beta
- * Options for streaming text data from an API.
- */
-export declare interface StreamTextOptions extends FetchOptions {
-    /**
-     * The asynchronous function to process each line of text.
-     */
-    handler: (line: string) => Promise<void>;
-}
-
 /**
  * @beta
  * Type representing a styler with methods for getting G6 node and edge styles.
- * See ColorByType.ts for an example
  */
 export declare type Styler = {
     /**
-     * Use this function to modify style of a node from outside the graph.
-     * You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
-     * This can lead do recursive clone error later on.
-     * Merging with actual style will be handled automatically!
-     * Use them just as a reference:
-     * - @param originStyle for eg original node radius (if its a circural node), so you want to eg multiply it by amount of connections.
-     * - @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.
-     * @param entity - The entity for which to get the node style.
-     * @param originStyle - The original style (the one passed to node during it's initialization). See '@antv/graphin' -> NodeStyle
-     * @param currentStyle - The current style. See '@antv/graphin' -> NodeStyle
-     * @returns A promise that resolves to the style patch. See '@antv/graphin' -> NodeStyle
+     * Gets the style for a G6 node.
+     * @param e - The entity for which to get the node style.
+     * @param curr - The current style.
+     * @returns A promise that resolves to the new style.
      */
-    getG6NodeStyle?: (entity: Entity, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
+    getG6NodeStyle?: (e: Entity, curr: TODO) => Promise<TODO>;
     /**
-     * Use this function to modify style of a edge from outside the graph.
-     * You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
-     * This can lead do recursive clone error later on.
-     * Merging with actual style will be handled automatically!
-     * Use them just as a reference, eg edge width to multiply.
-     * @param edge - The edge specification for which to get the edge style.
-     * @param originStyle - The original style (the one passed to edge during it's initialization). See '@antv/graphin' -> EdgeStyle
-     * @param currentStyle - The current style. See '@antv/graphin' -> EdgeStyle
-     * @returns A promise that resolves to the style patch. See '@antv/graphin' -> EdgeStyle
+     * Gets the style for a G6 edge.
+     * @param e - The edge specification for which to get the edge style.
+     * @param curr - The current style.
+     * @returns A promise that resolves to the new style.
      */
-    getG6EdgeStyle?: (edge: EdgeSpec, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
+    getG6EdgeStyle?: (e: EdgeSpec, curr: TODO) => Promise<TODO>;
 };
 
 /**
@@ -3385,10 +2985,6 @@ export declare type StylerOption = {
  */
 export declare type StylerProducer = (context: StylerContext) => Promise<Styler>;
 
-export declare type SubscribeDragStartFn = (id: string, callback: Callback<unknown>) => void;
-
-export declare type SubscribeToContextFn = (id: string, callback: Callback<unknown>) => void;
-
 /**
  * Represents a tag with a name and value.
  * @beta
@@ -3552,16 +3148,6 @@ export declare type TransformDefinitions = {
  */
 export declare type trigger = 'hover' | 'contextMenu' | 'click';
 
-/**
- * @beta
- * Represents a filter clause with unary operations in a query object.
- * It supports operations for checking null or not-null conditions.
- */
-export declare interface UnaryObjectFilterClause {
-    col: string;
-    op: 'IS NULL' | 'IS NOT NULL';
-}
-
 /**
  * @beta
  * Type representing an unsubscribe function.
@@ -3569,12 +3155,6 @@ export declare interface UnaryObjectFilterClause {
  */
 export declare type Unsubscribe = () => Promise<void>;
 
-export declare type UnsubscribeFn = (id: string) => void;
-
-export declare type UnsubscribeFromContextFn = UnsubscribeFn;
-
-export declare type UnsubscribeFromDragStartFn = UnsubscribeFn;
-
 /**
  * @beta
  * Type representing a user profile.
@@ -3744,12 +3324,6 @@ export declare interface WorkspaceChangeEmitter {
     onOpenWorkspacesChanged: AddListener<Workspace[]>;
 }
 
-export declare type WorkspaceConfig = Partial<{
-    description: string;
-    os_icon: string;
-    color: string;
-}>;
-
 /**
  *
  * @beta
@@ -3949,10 +3523,6 @@ export declare type WorkspaceItemTitleProps = DesktopActionContext & {
      * Selected items in left sidebar
      */
     selectedItems: WorkspaceItem[];
-    /**
-     * If the component it is being used inside a Markdown component
-     */
-    markdown?: boolean;
 };
 
 /**