@octostar/platform-types 0.5.28 → 0.5.30

package/dist/platform-types.d.ts

@@ -1,9 +1,9 @@
-import { ButtonProps } from 'antd';
+import type { ButtonProps } from 'antd';
 import { ItemType } from 'rc-menu/lib/interface';
 import { ModalProps } from 'antd';
 import { Properties } from 'csstype';
 import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
-import { TabNode } from 'flexlayout-react';
+import type { TabNode } from 'flexlayout-react';
 
 /**
  * @beta
@@ -139,7 +139,7 @@ export declare type AppRegistry = {
     /**
      * Registers a tab component.
      */
-    registerTabComponent: ({ component, factory, }: {
+    registerTabComponent: ({ component, factory }: {
         component: string;
         factory: (node: TabNode) => ReactNode;
     }) => void;
@@ -170,9 +170,7 @@ export declare type AppServiceCallProps = {
     /** Optional options for the service call. */
     options?: AppServiceCallOptions;
     /** Contextual data for the service call. */
-    context: {
-        [key: string]: any;
-    };
+    context: Record<string, any>;
 };
 
 /**
@@ -253,7 +251,7 @@ export declare interface BinaryObjectFilterClause {
  * @beta
  * Type representing a binary operator.
  */
-export declare type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in' | 'not in' | 'regex' | 'like' | 'ilike';
+export declare type BinaryOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'IN' | 'NOT IN' | 'regex' | 'LIKE' | 'ILIKE';
 
 /**
  * @beta
@@ -291,6 +289,37 @@ export declare interface ChartDataResponseResult {
     to_dttm: number | null;
 }
 
+export declare type ChatApiResponse = {
+    response: {
+        content: string;
+        additional_kwargs: Record<string, unknown>;
+        response_metadata: {
+            model: string;
+            created_at: string;
+            done: boolean;
+            done_reason: string;
+            total_duration: number;
+            load_duration: number;
+            prompt_eval_count: number;
+            prompt_eval_duration: number;
+            eval_count: number;
+            eval_duration: number;
+            model_name: string;
+        };
+        type: string;
+        name: string | null;
+        id: string;
+        example: boolean;
+        tool_calls: unknown[];
+        invalid_tool_calls: unknown[];
+        usage_metadata: {
+            input_tokens: number;
+            output_tokens: number;
+            total_tokens: number;
+        };
+    };
+};
+
 export declare interface ChatMessage {
     /**
      * The id of the message. This is used to identify the message in the conversation.
@@ -428,7 +457,15 @@ export declare type ConceptFilter = {
     /**
      * The filters to apply to the records of the concept.
      */
-    filters: QueryObjectFilterClause[];
+    filters: (QueryObjectFilterClause & {
+        formattedLabel?: string;
+    })[];
+    /**
+     * Indicates if the item only should be returned.
+     * If true, only the item itself will be returned.
+     * If false, the item and its contents will be returned.
+     */
+    itemOnly?: boolean;
 };
 
 /**
@@ -689,6 +726,10 @@ export declare interface DeleteResponse {
  * @beta
  */
 export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter {
+    /**
+     * [Private] Gets the UI state manager.
+     */
+    getUiStateManager: () => Promise<UiStateManager>;
     /**
      * Refreshes the desktop.
      */
@@ -701,6 +742,13 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Gets the active workspace.
      */
     getActiveWorkspace: (prompt?: boolean) => Promise<string | undefined>;
+    /**
+     * Prompts the user for a file name.
+     * @param defaultFileName - The default/initial file name to show in the prompt
+     * @param context - The context of the prompt ('folder' or 'file')
+     * @returns The entered file name, or null if the user cancelled
+     */
+    promptForFileName: (defaultFileName?: string, context?: 'folder' | 'file') => Promise<string | null>;
     /**
      * Sets the active workspace.
      */
@@ -754,23 +802,23 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * Gets items in a workspace by name.
      */
-    getWorkspaceItems(os_item_name: string): Promise<WorkspaceItem[]>;
+    getWorkspaceItems: (os_item_name: string) => Promise<WorkspaceItem[]>;
     /**
      * Gets the OsAPIClient.
      */
-    getOsAPIClient(): Promise<OsAPIClient>;
+    getOsAPIClient: () => Promise<OsAPIClient>;
     /**
      * Gets the AI client.
      */
-    getAIClient(): Promise<AIClient>;
+    getAIClient: () => Promise<AIClient>;
     /**
      * Gets the FilesAPIClient.
      */
-    getFilesAPIClient(): Promise<FilesAPIClient>;
+    getFilesAPIClient: () => Promise<FilesAPIClient>;
     /**
      * Registers a context menu action.
      */
-    registerContextMenuAction(action: DesktopActionMenuItem): Promise<Unsubscribe>;
+    registerContextMenuAction: (action: DesktopActionMenuItem) => Promise<Unsubscribe>;
     /**
      * Applies a tag to an entity.
      */
@@ -785,10 +833,12 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     updateTag: (tag: OsTag) => Promise<OsTag>;
     /**
      * Gets an item by workspace identifier.
+     * [Warning: This method does not return the __uiState, Use useEntity hook or UiStateManager to get the __uiState]
      */
     getItem: <T>(ws: WorkspaceIdentifier<T>) => Promise<WorkspaceItem<T>>;
     /**
      * Gets items by workspace identifiers.
+     * [Warning: This method does not return the __uiState, Use useEntity hook or UiStateManager to get the __uiState]
      */
     getItems: (ws: WorkspaceIdentifier[]) => Promise<WorkspaceItem[]>;
     /**
@@ -812,17 +862,18 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      */
     getApp: (name: string) => Promise<WorkspaceItem | undefined>;
     /**
-     * Gets schema items by content type.
+     * Query workspace items by content type directly from the database.
+     * This ensures all items are retrieved, not just those loaded in memory.
+     *
+     * @param os_item_content_type - The content type to filter by
+     * @param workspace_ids - Optional list of workspace IDs to filter by. If not provided, searches across all open workspaces
+     * @returns Promise resolving to array of workspace items matching the content type
      */
-    getSchemaItems(os_item_content_type: string): Promise<WorkspaceItem[]>;
+    getItemsByContentType: (os_item_content_type: string, workspace_ids?: string[]) => Promise<WorkspaceItem[]>;
     /**
      * Creates a workspace by name.
      */
     createWorkspace: (name: string, config?: WorkspaceConfig) => Promise<WorkspaceItem>;
-    /**
-     * Creates a private workspace for user by name.
-     */
-    createPrivateWorkspace: (name: string, config?: WorkspaceConfig) => Promise<Workspace>;
     /**
      * Connects two entities with a relationship in a workspace.
      */
@@ -847,6 +898,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Exports an item or items with optional export options.
      */
     export: (item: WorkspaceItem | WorkspaceItem[], options?: ExportOptions) => Promise<void>;
+    /**
+     * Downloads a file from the given URL.
+     */
+    download: (url: string, filename?: string) => Promise<void>;
     /**
      * Fetches an entity from the index, or from the ontology if not found in the index.
      */
@@ -866,7 +921,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * Opens records with default action or as specified in the optional desktop action options.
      */
-    open(records: Entity | Entity[], options?: DesktopActionOptions): Promise<void>;
+    open: (records: Entity | Entity[], options?: DesktopActionOptions) => Promise<void>;
     /**
      * Deletes an item or items recursively.
      */
@@ -918,6 +973,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Shows a progress item.
      */
     showProgress: (progress: OsProgress) => Promise<void>;
+    /**
+     * Gets a system setting.
+     */
+    getSystemSetting: <T extends string | boolean>(key: string, defaultValue: T, show_protected?: boolean) => Promise<GetSystemSettingResponse<T>>;
     /**
      * Wraps a promise with a progress bar.
      */
@@ -946,6 +1005,18 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Gets a paste context with optional options.
      */
     getPasteContext: (options: PasteContextOptions) => Promise<Entity[]>;
+    /**
+     * Expands a set with optional options.
+     */
+    expandSet: (options: SetsOptions) => Promise<WorkspaceItem[]>;
+    /**
+     * Gets the open search query for a set with optional options.
+     */
+    getOpenSearchQuery: (options: SetsOptions) => Promise<Record<string, any>>;
+    /**
+     * Gets the count of a set with optional options.
+     */
+    getSetCount: (options: SetsOptions) => Promise<number>;
     /**
      * Shows a modal template.
      */
@@ -965,9 +1036,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * Gets workspace permissions by IDs.
      */
-    getWorkspacePermission: (os_worpsaces: string[]) => Promise<{
-        [os_workspace: string]: WorkspacePermission;
-    }>;
+    getWorkspacePermission: (os_worpsaces: string[]) => Promise<Record<string, WorkspacePermission>>;
     /**
      * Gets the user profile.
      */
@@ -975,9 +1044,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * Deploys an application with optional initial secrets.
      */
-    deployApp: (app: WorkspaceItem | App, initialSecrets?: {
-        [key: string]: string;
-    }) => Promise<WorkspaceItem>;
+    deployApp: (app: WorkspaceItem | App, initialSecrets?: Record<string, string>) => Promise<WorkspaceItem>;
     /**
      * Undeploys an application.
      */
@@ -1032,10 +1099,8 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     /**
      * "Cache" for workspaces, avoiding to return a modal error, if this workspace was fetched before
      */
-    workspaceStore: {
-        [os_workspace: string]: Workspace;
-    };
-    getWhitelabelingInfo(): Promise<{
+    workspaceStore: Record<string, Workspace>;
+    getWhitelabelingInfo: () => Promise<{
         OCTOSTAR_MAIN_LOGO: string;
         OCTOSTAR_FAVICON: string;
         OCTOSTAR_SPINNER: string;
@@ -1199,6 +1264,10 @@ export declare type DesktopActionOptions = {
      * Wait for the tab to open
      */
     awaitShowTab?: boolean;
+    /**
+     * Custom name of the tab.
+     */
+    tabName?: string;
 };
 
 /**
@@ -1379,6 +1448,10 @@ export declare type EntityBase = {
      * The type of the entity.
      */
     entity_type: string;
+    /**
+     * The workspace of the entity.
+     */
+    os_workspace?: string;
 };
 
 /**
@@ -1424,16 +1497,15 @@ export declare type EntityPasteContext = {
     fetch: (limit?: number) => Promise<Entity[]>;
 };
 
+export declare interface EntityUiState {
+    rename?: boolean;
+    [key: string]: any;
+}
+
 export declare type EvalContext = {
-    variables: {
-        [key: string]: any;
-    };
-    filters: {
-        [key: string]: DesktopActionFilter;
-    };
-    transforms: {
-        [key: string]: Function;
-    };
+    variables: Record<string, any>;
+    filters: Record<string, DesktopActionFilter>;
+    transforms: Record<string, Function>;
 };
 
 /**
@@ -1594,7 +1666,7 @@ export declare interface FilesAPIClient {
      * @param path - The path to check (empty string for workspace info)
      * @returns Complete entity data if found
      */
-    stat(os_workspace: string, path?: string): Promise<WorkspaceItem>;
+    stat: (os_workspace: string, path?: string) => Promise<WorkspaceItem>;
     /**
      * Main entry point for listing workspace or folder contents
      * Supports listing by path, parent folder ID, or root level
@@ -1606,7 +1678,7 @@ export declare interface FilesAPIClient {
      *                  - If neither is provided, lists root level contents
      * @returns Paginated list of files and folders
      */
-    listFolder(os_workspace: string, options: ListFolderOptions): Promise<FileListResponse>;
+    listFolder: (os_workspace: string, options: ListFolderOptions) => Promise<FileListResponse>;
     /**
      * Move a file or folder to a new path
      *
@@ -1625,7 +1697,7 @@ export declare interface FilesAPIClient {
      *          - entity_label: Display name of the entity
      *          - new_path: Full path to the entity after move/rename
      */
-    moveOrRename(os_workspace: string, path: string, options: MoveOptions): Promise<MoveResponse>;
+    moveOrRename: (os_workspace: string, path: string, options: MoveOptions) => Promise<MoveResponse>;
     /**
      * Create a new directory
      *
@@ -1633,7 +1705,7 @@ export declare interface FilesAPIClient {
      * @param path - The path to create
      * @returns The created entity
      */
-    mkdir(os_workspace: string, path: string): Promise<MkdirResponse>;
+    mkdir: (item: WorkspaceItem) => Promise<MkdirResponse>;
     /**
      * Delete a file or directory
      *
@@ -1641,14 +1713,21 @@ export declare interface FilesAPIClient {
      * @param path - The path to delete
      * @returns The deleted entity
      */
-    deleteFile(os_workspace: string, path: string): Promise<DeleteResponse>;
+    deleteFile: (os_workspace: string, path: string) => Promise<DeleteResponse>;
     /**
      * Delete a file or directory recursively
      *
      * @param os_workspace - The workspace ID
      * @param path - The path to delete
      */
-    deleteRecursive(os_workspace: string, path: string): Promise<DeleteResponse>;
+    deleteRecursive: (os_workspace: string, path: string) => Promise<DeleteResponse>;
+    /**
+     * Create a new file
+     *
+     * @param item - The file item to create
+     * @returns The created entity
+     */
+    createFile: (item: WorkspaceItem) => Promise<MkdirResponse>;
     /**
      * Get a download URL for a file
      *
@@ -1657,18 +1736,28 @@ export declare interface FilesAPIClient {
      * @param options - Optional parameters for the download
      * @returns The download URL
      */
-    getDownloadUrl(os_workspace: string, path: string, options?: DownloadOptions): Promise<string>;
+    getDownloadUrl: (os_workspace: string, path: string, options?: DownloadOptions) => Promise<string>;
     /**
      * Unzip a file by entity ID
      *
      * @param os_workspace - The workspace ID
      * @param entity_id - The entity ID
+     * @param options - Optional unzip configuration (e.g., destination)
      * @returns The tracking ID and status URL
      */
-    unzipByEntity(os_workspace: string, entity_id: string): Promise<{
+    unzipByEntity: (os_workspace: string, entity_id: string, options?: UnzipOptions) => Promise<{
         tracking_id: string;
         status_url: string;
     }>;
+    /**
+     * Get an upload URL for a file
+     *
+     * @param os_workspace - The workspace ID
+     * @param entity_id - The entity ID
+     * @param options - Upload options including content_type and optional TTL in minutes
+     * @returns The upload URL and fields
+     */
+    getUploadUrl: (os_workspace: string, entity_id: string, options: UploadOptions) => Promise<S3UploadResponse>;
 }
 
 /**
@@ -1706,9 +1795,7 @@ export declare type Filter = {
     scope: NativeFilterScope;
     filterType: string;
     targets: [Partial<NativeFilterTarget>];
-    controlValues: {
-        [key: string]: any;
-    };
+    controlValues: Record<string, any>;
     sortMetric?: string | null;
     adhoc_filters?: Record<any, any>[];
     granularity_sqla?: string;
@@ -1732,9 +1819,7 @@ export declare type FilterDefinition = ProvidedFilterDefinition | JavascriptFilt
  * @beta
  * Type representing a collection of filter definitions.
  */
-export declare type FilterDefinitions = {
-    [k: FilterName]: FilterDefinition;
-};
+export declare type FilterDefinitions = Record<FilterName, FilterDefinition>;
 
 /**
  * @beta
@@ -1832,6 +1917,14 @@ export declare interface GetAttachmentOptions<T extends AttachmentType> {
     responseType?: AttachmentResponseType;
 }
 
+export declare type GetSystemSettingResponse<T extends string | boolean = string | boolean> = {
+    default_value: T;
+    description: string;
+    security: boolean;
+    type: string;
+    value: T;
+};
+
 export declare type GraphDataSpec = {
     entities: Entity[];
     relationships: EntityEdge[];
@@ -1862,13 +1955,9 @@ export declare type HttpTransformDefinition = {
     /** The URL for the HTTP request, can be relative to the url of the deployed app */
     url: string;
     /** Optional headers for the HTTP request. */
-    headers?: {
-        [k: string]: string;
-    };
+    headers?: Record<string, string>;
     /** Optional data for the HTTP request. */
-    data?: string | {
-        [k: string]: any;
-    };
+    data?: string | Record<string, any>;
 };
 
 /**
@@ -2008,6 +2097,196 @@ export declare type ImportZipOptions = {
     include_dashboards?: boolean | 'if_missing';
 };
 
+export declare interface IndexSearchHitSource {
+    annotations?: {
+        data?: string;
+        crossFilters?: string;
+        'extract:metadata'?: string;
+        'extract:src'?: string;
+        'extract:txt'?: string;
+        'extract:txtLang'?: string;
+        'image:annotations'?: {
+            bbox?: string;
+            confidence?: number;
+            embedding?: Record<VectorKey, {
+                value?: number[];
+            }>;
+            label?: string;
+        }[];
+        'image:annotations-key'?: {
+            label?: string;
+        }[];
+        'image:annotations-sensitive'?: {
+            label?: string;
+        }[];
+        'image:annotations-setting'?: {
+            label?: string;
+        }[];
+        'ner:entities'?: {
+            person?: string[];
+            org?: string[];
+            loc?: string[];
+            norp?: string[];
+            gpe?: string[];
+            product?: string[];
+            phone?: string[];
+            email?: string[];
+            ip_address?: string[];
+            url?: string[];
+        };
+        'rag:chunks'?: {
+            metadata?: {
+                type?: string;
+                chunk_id?: number;
+                os_workspace?: string;
+                os_relationship_workspace?: string;
+                text?: string;
+            };
+            embedding?: Record<VectorKey, {
+                value?: number[];
+            }>;
+        }[];
+    };
+    document_fields: Entity & {
+        address?: string;
+        age?: number;
+        alias?: string;
+        align_model?: string;
+        area_code?: string;
+        arousal?: string;
+        author?: string;
+        blood_type?: string;
+        breed?: string;
+        build?: string;
+        callee_name?: string;
+        callee_number?: string;
+        caller_name?: string;
+        caller_number?: string;
+        category?: string;
+        citizenship?: string;
+        city?: string;
+        city_of_birth?: string;
+        color?: string;
+        complexion?: string;
+        contents?: string;
+        context?: string;
+        country?: string;
+        country_code?: string;
+        country_of_birth?: string;
+        creation_date?: string;
+        date_of_birth?: string;
+        date_of_death?: string;
+        dayofweek?: string;
+        dayofweeknumber?: number;
+        description?: string;
+        detection_model?: string;
+        distinguishing_marks?: string;
+        dominance?: string;
+        duration?: number;
+        email_address?: string;
+        email_from?: string;
+        email_to?: string;
+        embedding?: string;
+        embedding_model?: string;
+        face_area?: string;
+        first_name?: string;
+        fuel_type?: string;
+        gender?: string;
+        group?: string;
+        handedness?: string;
+        height?: number;
+        identifier?: string;
+        language?: string;
+        last_digits?: string;
+        last_name?: string;
+        latitude?: number;
+        legal_address?: string;
+        legal_city?: string;
+        legal_country?: string;
+        longitude?: number;
+        main_language?: string;
+        make?: string;
+        maximum_weight?: number;
+        means?: string;
+        metadata?: string;
+        middle_name?: string;
+        model?: string;
+        model_year?: number;
+        msidsn?: string;
+        name?: string;
+        number_of_criminals?: number;
+        offender_name?: string;
+        order?: number;
+        os_concept?: string;
+        os_content_size?: number;
+        os_created_at?: string;
+        os_created_by?: string;
+        os_entity_type_from?: string;
+        os_entity_type_to?: string;
+        os_entity_uid?: string;
+        os_entity_uid_from?: string;
+        os_entity_uid_to?: string;
+        os_flags?: number;
+        os_has_attachment?: boolean;
+        os_hidden_by?: string;
+        os_icon?: string;
+        os_item_content?: string;
+        os_item_content_type?: string;
+        os_item_name?: string;
+        os_item_type?: string;
+        os_last_updated_at?: string;
+        os_last_updated_by?: string;
+        os_parent_folder?: string;
+        os_parent_uid?: string;
+        os_permission?: number;
+        os_relationship_name?: string;
+        os_role?: string;
+        os_textsearchfield?: string;
+        os_username?: string;
+        owner_name?: string;
+        path?: string;
+        phone_number?: string;
+        plate_number?: string;
+        producer_name?: string;
+        registration_from_date?: string;
+        registration_to_date?: string;
+        residence_address?: string;
+        residence_city?: string;
+        residence_country?: string;
+        responsible_name?: string;
+        slug?: string;
+        source_entity_identifier?: string;
+        source_entity_type?: string;
+        source_entity_uid?: string;
+        source_name?: string;
+        speaking_accent?: string;
+        start_time?: string;
+        subtype?: string;
+        summary?: string;
+        timeofday?: number;
+        title?: string;
+        type?: string;
+        unladen_weight?: number;
+        username?: string;
+        valence?: string;
+        victim_name?: string;
+        weight?: number;
+        worker_name?: string;
+    };
+    relationships?: {
+        relationship?: {
+            os_relationship_name?: string;
+            os_entity_uid_from?: string;
+            os_entity_uid_to?: string;
+        };
+        target?: {
+            os_entity_uid?: string;
+            entity_type?: string;
+            entity_label?: string;
+        };
+    }[];
+}
+
 /**
  * Represents an inheritance relationship between concepts.
  * @beta
@@ -2036,6 +2315,10 @@ export declare type InlineCode = {
     code: string;
 };
 
+export declare function isWorkspaceFileItem(item: WorkspaceItem): item is WorkspaceItem & {
+    os_has_attachment: true;
+};
+
 /**
  * @beta
  * Type representing a JavaScript file styler definition.
@@ -2092,7 +2375,7 @@ export declare type JobManifest = {
     /** AI description for the job. */
     aiDescription?: string;
     /** Icon for the job. */
-    icon: string;
+    icon?: string;
     /** Custom color for the app. */
     color?: string;
     /** Optional image for the job. */
@@ -2128,9 +2411,7 @@ export declare type JobManifest = {
  * @beta
  * Type representing known counts of relationships.
  */
-export declare type KnownCounts = {
-    [relationship_name: string]: number;
-};
+export declare type KnownCounts = Record<string, number>;
 
 export declare type ListByParentFolder = {
     path?: never;
@@ -2149,39 +2430,35 @@ export declare type ListFolderOptions = (PathOption & CommonOptions) | (ParentFo
  * Represents a context management interface for handling state across components
  */
 export declare interface LiveContext<ContextData extends DefaultLiveContextData = DefaultLiveContextData> {
+    /**
+     * Unique identifier for the context instance
+     */
+    readonly id: string;
     /**
      * @beta
      * Retrieves the current context data
      * @returns The current context data
      */
-    getContext(): ContextData;
+    getContext: () => ContextData;
     /**
      * @beta
      * Updates the context with new data
      * @param context - New context data or function to update context
      */
-    setContext(context: LiveContextAPISetParams<ContextData>): Promise<void>;
+    setContext: (context: LiveContextAPISetParams<ContextData>) => void;
     /**
      * @beta
      * Subscribes to context changes with an automatically generated ID
      * @param contextListener - Callback function triggered on context changes
      * @returns Generated subscription ID
      */
-    subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
-    /**
-     * @beta
-     * Subscribes to context changes with a custom ID
-     * @param id - Custom subscription ID
-     * @param contextListener - Callback function triggered on context changes
-     * @returns The subscription ID
-     */
-    subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
+    subscribeToChanges: ((contextListener: LiveContextListener<ContextData>) => string) & ((id: string, contextListener: LiveContextListener<ContextData>) => string);
     /**
      * @beta
      * Unsubscribes from context changes
      * @param id - Subscription ID to remove
      */
-    unsubscribeFromChanges(id: string): void;
+    unsubscribeFromChanges: (id: string) => void;
     /**
      * @beta
      * Adds a context listener to another Context instance
@@ -2189,39 +2466,37 @@ export declare interface LiveContext<ContextData extends DefaultLiveContextData
      * @param mapContext - Optional function to transform context data
      * @returns Function to remove the context listener
      */
-    addContextListener<ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData): () => void;
+    addContextListener: <ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData) => () => void;
     /**
      * @beta
      * Removes a context listener
      * @param idOrContextAPI - ID or Context instance to disconnect from
      */
-    removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string): void;
+    removeContextListener: <ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string) => void;
     /**
      * @beta
      * Connects to target window for context synchronization
      * @returns The channel ID used for communication
      */
-    connect(): string;
+    connect: () => string;
     /**
      * @beta
      * Destroys the context and cleans up all listeners
      */
-    destroy(): void;
+    destroy: () => void;
 }
 
 export declare type LiveContextAPISetParams<ContextData extends Record<string, any> = Record<string, any>> = ContextData | ((currentContext: ContextData) => ContextData);
 
 export declare type LiveContextListener<ContextData extends Record<string, any> = Record<string, any>> = (context: ContextData) => void;
 
-export declare type ManifestSecrets = {
-    [key: string]: {
-        description: string;
-        default?: string;
-        required?: boolean;
-    };
-};
+export declare type ManifestSecrets = Record<string, {
+    description: string;
+    default?: string;
+    required?: boolean;
+}>;
 
-export declare type MkdirResponse = Entity;
+export declare type MkdirResponse = WorkspaceItem;
 
 /**
  * @beta
@@ -2246,9 +2521,11 @@ export declare type ModalTemplateProps = CustomTemplateIframeProps & {
 };
 
 export declare interface MoveOptions {
-    to_path: string;
+    to_path?: string;
+    entity_id?: string;
+    new_name?: string;
+    new_os_parent_folder?: string;
     force?: boolean;
-    redirect?: boolean;
 }
 
 export declare interface MoveResponse extends Entity {
@@ -2339,7 +2616,7 @@ export declare interface Ontology {
      * @param rel - The relationship or relationship name.
      * @returns A promise that resolves to an array of workspace relationships.
      */
-    getWorkspaceRelationshipRecords(entity: Entity, rel: string | Relationship): Promise<WorkspaceRelationship[]>;
+    getWorkspaceRelationshipRecords: (entity: Entity, rel: string | Relationship) => Promise<WorkspaceRelationship[]>;
     /**
      * Clears the relationship cache for a given entity and relationship.
      * @param entity - The entity for which to clear the cache.
@@ -2380,11 +2657,34 @@ export declare interface Ontology {
      */
     getConcepts: () => Promise<Map<string, Concept>>;
     /**
-     * Gets an entity.
-     * @param e - The entity to get.
+     * Gets an entity by ID.
+     *
+     * ⚠️ **NOTE**: This method has unusual behavior for missing entities.
+     * The method gets a database version of the entity, if one exists, otherwise returns the original entity.
+     * It is used in many parts of the system where the entity encountered may or may not be saved in the database.
+     *
+     * In the case where it's important to distinguish whether the input record was found in the database,
+     * include an identifiying attribute eg, '#original': true as such a field will not be present in the saved version.
+     *
+     * **Example Usage:**
+     * ```typescript
+     * const entityWithOriginal: Entity & { '#original': boolean } = {
+     *   entity_id: someId,
+     *   entity_type: someType,
+     *   entity_label: someLabel,
+     *   '#original': true,
+     * };
+     * const result = await ontologyAPI.getEntity<Entity & { '#original': boolean }>(entityWithOriginal);
+     * if (result['#original']) {
+     *   // Entity doesn't exist - the method returned our input object unchanged
+     * }
+     * // Entity exists - the method returned actual entity data (without #original flag)
+     * ```
+     *
+     * @param e - The entity to get (may include special flags like `#original`).
      * @param refresh - Whether to refresh the data.
      * @param skipSideEffects - Whether to skip side effects.
-     * @returns A promise that resolves to the entity.
+     * @returns A promise that resolves to either the actual entity data OR the input entity if not found.
      */
     getEntity: <T extends Entity>(e: Entity, refresh?: boolean, skipSideEffects?: boolean) => Promise<T>;
     /**
@@ -2437,7 +2737,19 @@ export declare interface Ontology {
      * Gets the system inheritance.
      * @returns A promise that resolves to an array of inheritances.
      */
-    getSysInheritance(): Promise<Inheritance[]>;
+    getSysInheritance: () => Promise<Inheritance[]>;
+    /**
+     * Gets the local entity edges.
+     * @param entities - The entities for which to get the edges.
+     * @returns A promise that resolves to an array of entity edges.
+     */
+    getLocalEntityEdges: (entities: Entity[]) => Promise<EntityEdge[]>;
+    /**
+     * Discovers edges on adding nodes.
+     * @param entities - The entities for which to discover edges.
+     * @returns A promise that resolves to an array of entity edges.
+     */
+    discoverEdgesOnAddingNodes: (newEntities: Entity[], oldEntities: Entity[]) => Promise<EntityEdge[]>;
     /**
      * Subscribes to changes for a given entity.
      * @param entity - The entity to subscribe to.
@@ -2629,13 +2941,23 @@ export declare type OsNotification = string | {
     /**
      * Additional details for the notification.
      */
-    detail?: {
-        [key: string]: any;
-    };
+    detail?: Record<string, any>;
     /**
      * Placement of the notification.
      */
     placement?: 'top' | 'bottom' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
+    /**
+     * URL to open when action button is clicked.
+     */
+    actionUrl?: string;
+    /**
+     * Label for the action button. Defaults to "Open" if actionUrl is provided.
+     */
+    actionLabel?: string;
+    /**
+     * Whether the notification should persist until manually closed.
+     */
+    persistent?: boolean;
 };
 
 /**
@@ -2659,6 +2981,14 @@ export declare type OsProgress = {
      * Status of the progress item.
      */
     status?: 'active' | 'success' | 'exception' | 'normal' | undefined;
+    /**
+     * Percentage of the progress item.
+     */
+    percent?: number;
+    /**
+     * Persist until complete for the progress item.
+     */
+    persistUntilComplete?: boolean;
 };
 
 /**
@@ -2761,18 +3091,7 @@ export declare type Point = {
  * Represents the status of a processing operation.
  * @beta
  */
-export declare interface ProcessingStatus {
-    /**
-     * The id of the entity being processed.
-     */
-    entity_id: string;
-    /**
-     * The type of the entity being processed.
-     */
-    entity_type: string;
-    /**
-     * The status code of the processing operation.
-     */
+export declare interface ProcessingStatus extends EntityBase {
     status_code: ProcessingStatusCode;
     /**
      * The reason for the processing operation.
@@ -2823,11 +3142,19 @@ export declare enum ProcessingStatusCode {
  * The options for the prompt.
  */
 export declare type PromptOptions = {
+    noThink?: boolean;
     model?: string;
     apiKey?: string;
     stream?: boolean;
     enableRag?: boolean;
     cohereKey?: string;
+    temperature?: number;
+    /** Importing Entity from model.ts breaks the build. */
+    context?: {
+        entity_id: string;
+        entity_label: string;
+        entity_type: string;
+    }[];
 };
 
 /**
@@ -3010,7 +3337,7 @@ export declare interface RecordProvider {
      * Retrieves a message related to the records.
      * @returns A promise that resolves to the message, or undefined if no message is available.
      */
-    getMessage(): Promise<string | undefined>;
+    getMessage: () => Promise<string | undefined>;
 }
 
 /**
@@ -3133,6 +3460,20 @@ declare type RootOption = {
     os_parent_folder?: never;
 };
 
+export declare interface S3Headers {
+    key: string;
+    policy: string;
+    'x-amz-algorithm': string;
+    'x-amz-credential': string;
+    'x-amz-date': string;
+    'x-amz-signature': string;
+}
+
+export declare interface S3UploadResponse {
+    fields: S3Headers;
+    url: string;
+}
+
 /**
  * Properties for saving as modal.
  * @beta
@@ -3146,6 +3487,10 @@ export declare type SaveAsModalProps = {
      * Application related to the item.
      */
     app?: WorkspaceItem;
+    /**
+     * Default path for the item.
+     */
+    defaultPath?: string;
 };
 
 export declare const SAVED_SEARCH_MESSAGE_TYPES: Readonly<{
@@ -3168,11 +3513,11 @@ export declare interface SavedDatasource {
 }
 
 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>;
+    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 {
@@ -3180,9 +3525,7 @@ export declare interface SavedSearchContent {
     dataset: true;
     filters: Filter[];
     crossFilters: DataMask[];
-    datasourcesInScope: {
-        [uid: string]: SavedDatasource;
-    };
+    datasourcesInScope: Record<string, SavedDatasource>;
     initialCount?: number;
 }
 
@@ -3254,6 +3597,7 @@ export declare interface SearchOptions {
      * The maximum number of entities returned.
      */
     limit?: number;
+    workspace_ids?: string[];
 }
 
 /**
@@ -3285,6 +3629,14 @@ export declare interface SearchProps {
      * disable save search
      */
     disableSaveSearch?: boolean;
+    /**
+     * Title of the information message shown in the search results, presented as an alert.
+     */
+    searchInfoTitle?: string;
+    /**
+     * Description of the information message shown in the search results, presented as an alert.
+     */
+    searchInfoDescription?: React.ReactNode;
 }
 
 /**
@@ -3393,10 +3745,10 @@ export declare type SendQueryOptions = {
     context?: string;
     /** Whether to send the query with low priority. */
     lowPriority?: boolean;
+    /** Whether to suppress the global SQL Exception toast. */
+    suppressSQLExceptionToast?: boolean;
     /** Query params. */
-    params?: {
-        [key: string]: string | number | boolean | string[] | number[] | boolean[] | null;
-    };
+    params?: Record<string, string | number | boolean | string[] | number[] | boolean[] | null>;
 };
 
 /**
@@ -3421,9 +3773,7 @@ export declare type ServiceDefinition = {
     /** Optional order for the service. */
     order?: number;
     /** Optional parameters for the service. */
-    params?: {
-        [k: string]: any;
-    };
+    params?: Record<string, any>;
     /** Optional roles for the service. */
     role?: ServiceRole[] | ServiceRole;
     /** Filters accepted by the service. */
@@ -3441,9 +3791,7 @@ export declare type ServiceDefinition = {
  * @beta
  * Type representing a collection of service definitions.
  */
-export declare type ServiceDefinitions = {
-    [serviceName: string]: ServiceDefinition;
-};
+export declare type ServiceDefinitions = Record<string, ServiceDefinition>;
 
 /**
  * @beta
@@ -3451,6 +3799,45 @@ export declare type ServiceDefinitions = {
  */
 export declare type ServiceRole = 'context_menu' | 'record_view' | 'set_view';
 
+export declare type SetsOptions = {
+    /**
+     * Workspace items for the context.
+     */
+    workspace_items?: WorkspaceItem[];
+    /**
+     * Limit for the context.
+     */
+    limit?: number;
+    /**
+     * Offset for the context.
+     */
+    offset?: number;
+    /**
+     * Datasource for the context.
+     */
+    datasource?: string;
+    /**
+     * Recursive for the context.
+     */
+    recursive?: boolean;
+    /**
+     * Include count for the context.
+     */
+    include_count?: boolean;
+    /**
+     * Include root for the context.
+     */
+    include_root?: boolean;
+    /**
+     * Include all fields for the context.
+     */
+    include_all_fields?: boolean;
+    /**
+     * OS exact concept filter for the context.
+     */
+    os_exact_concept_filter?: string[];
+};
+
 export declare type SetTransformResultFn = (args: any[]) => Promise<void>;
 
 /**
@@ -3617,9 +4004,7 @@ export declare type StylerDefinition = JavascriptFileStylerDefinition | Javascri
  * @beta
  * Type representing a collection of styler definitions.
  */
-export declare type StylerDefinitions = {
-    [stylerName: string]: StylerDefinition;
-};
+export declare type StylerDefinitions = Record<string, StylerDefinition>;
 
 /**
  * @beta
@@ -3797,9 +4182,7 @@ export declare type TransformDefinition = ProvidedTransformDefinition | HttpTran
  * @beta
  * Type representing a collection of transform definitions.
  */
-export declare type TransformDefinitions = {
-    [transformName: string]: TransformDefinition;
-};
+export declare type TransformDefinitions = Record<string, TransformDefinition>;
 
 /**
  * @beta
@@ -3807,6 +4190,13 @@ export declare type TransformDefinitions = {
  */
 export declare type trigger = 'hover' | 'contextMenu' | 'click';
 
+export declare interface UiStateManager {
+    setUiState(entity: Entity, ui_state: Partial<EntityUiState>, patch?: boolean): void;
+    getUiState(entity: Entity): EntityUiState | undefined;
+    clearUiState(entity: Entity): void;
+    subscribeToUiStateChanges(entity: Entity, callback: (state: EntityUiState | undefined) => void): () => void;
+}
+
 /**
  * @beta
  * Represents a filter clause with unary operations in a query object.
@@ -3814,7 +4204,7 @@ export declare type trigger = 'hover' | 'contextMenu' | 'click';
  */
 export declare interface UnaryObjectFilterClause {
     col: string;
-    op: 'IS NULL' | 'IS NOT NULL';
+    op: 'IS NULL' | 'IS NOT NULL' | 'IN' | 'NOT IN';
 }
 
 /**
@@ -3830,6 +4220,15 @@ export declare type UnsubscribeFromContextFn = UnsubscribeFn;
 
 export declare type UnsubscribeFromDragStartFn = UnsubscribeFn;
 
+export declare interface UnzipOptions {
+    extract_to_new_folder?: boolean;
+}
+
+export declare interface UploadOptions {
+    content_type: string;
+    ttl_minutes?: number;
+}
+
 /**
  * @beta
  * Type representing a user profile.
@@ -3851,6 +4250,16 @@ export declare type UserProfile = {
  */
 export declare type uuid = string;
 
+declare type VectorKey = `vector_${string}_${number}_${string}`;
+
+/**
+ * Represents a virtual entity not in the database.
+ * @beta
+ */
+export declare type VirtualEntity = Entity & {
+    '#virtual': true;
+};
+
 /**
  * Represents a watcher.
  * @beta
@@ -3950,6 +4359,14 @@ export declare type WithProgressBarOptions = {
      * Error message for the progress bar.
      */
     errorToast?: string | boolean;
+    /**
+     * Key for the progress bar.
+     */
+    key?: string;
+    /**
+     * Persist until complete for the progress bar.
+     */
+    persistUntilComplete?: boolean;
 };
 
 /**
@@ -3999,11 +4416,35 @@ export declare interface WorkspaceChangeEmitter {
     onOpenWorkspacesChanged: AddListener<Workspace[]>;
 }
 
+/**
+ * Options for creating a workspace.
+ * @beta
+ */
 export declare type WorkspaceConfig = Partial<{
+    /**
+     * Description of the workspace.
+     */
     description: string;
+    /**
+     * Icon of the workspace.
+     */
     os_icon: string;
+    /**
+     * Color of the workspace.
+     */
     color: string;
-    id?: string;
+    /**
+     * ID of the workspace.
+     */
+    entity_id?: string;
+    /**
+     * Whether to create the workspace quietly, without opening it.
+     */
+    '#quietly'?: boolean;
+    /**
+     * Whether the workspace is a set.
+     */
+    os_is_set?: boolean;
 }>;
 
 /**
@@ -4028,6 +4469,14 @@ export declare type WorkspaceIdentifier<T = any> = uuid | WorkspaceItem<T>;
  * @beta
  */
 export declare type WorkspaceItem<T = any> = WorkspaceRecord & {
+    /**
+     * Whether the item is a set.
+     */
+    os_is_set?: boolean;
+    /**
+     * The concept of the workspace item.
+     */
+    os_concept?: string;
     /**
      * The type-specific content of the workspace item.
      */
@@ -4101,6 +4550,30 @@ export declare interface WorkspaceItemConfig {
     last_updated: number;
 }
 
+export declare type WorkspaceItemDocumentFields = Entity & Partial<{
+    os_item_content_type: string;
+    os_parent_folder: string;
+    os_deleted_by: string | null;
+    os_icon: string | null;
+    description: string | null;
+    os_item_content: string | null;
+    os_last_updated_at: string;
+    os_hidden_at: string | null;
+    os_created_by: string;
+    os_custom_icon: string | null;
+    os_concept: string;
+    os_has_attachment: boolean;
+    os_last_updated_by: string;
+    os_deleted_at: string | null;
+    os_textsearchfield: string | null;
+    os_item_type: string;
+    os_hidden_by: string;
+    os_entity_uid: string;
+    os_content_size: number | null;
+    os_created_at: string;
+    os_item_name: string;
+}>;
+
 /**
  * @beta
  * Type representing a workspace item identifier, which is the same as a workspace identifier.
@@ -4209,6 +4682,10 @@ export declare type WorkspaceItemTitleProps = DesktopActionContext & {
      * If the component it is being used inside a Markdown component
      */
     markdown?: boolean;
+    /**
+     * Title for the item.
+     */
+    title?: ReactNode;
 };
 
 /**
@@ -4279,9 +4756,7 @@ export declare type WorkspaceRecordInfo = {
  * @beta
  * Type representing a collection of workspace records.
  */
-export declare type WorkspaceRecords = {
-    [key: string]: WorkspaceRecordInfo;
-};
+export declare type WorkspaceRecords = Record<string, WorkspaceRecordInfo>;
 
 /**
  * @beta
@@ -4332,6 +4807,8 @@ export declare type WorkspaceSettings = {
     isMaster?: boolean;
     /** The icon for the workspace. */
     os_icon?: string;
+    /** The color for the workspace. */
+    color?: string;
 };
 
 export { }