@octostar/platform-types 0.5.30 → 0.5.34

package/dist/platform-types.d.ts

@@ -761,6 +761,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Copies an item.
      */
     copy: (source: WorkspaceItem, target: WorkspaceItem, options?: CopyOptions) => Promise<WorkspaceItem[]>;
+    /**
+     * Lists the workspaces currently open on the desktop.
+     */
+    listOpenWorkspaces: () => Promise<WorkspaceItem[]>;
     /**
      * Lists all workspaces with optional permissions.
      */
@@ -775,6 +779,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * @returns a promise that resolves to the current ontology
      */
     getOntology: () => Promise<Ontology>;
+    /**
+     * Checks if an entity is a set.
+     */
+    checkIsSet: (entity: WorkspaceItem) => Promise<boolean>;
     /**
      * Fetches an attachment based on the provided workspace identifier and path or ID.
      *
@@ -861,6 +869,12 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Gets the named app if it is on the desktop and in a running state.
      */
     getApp: (name: string) => Promise<WorkspaceItem | undefined>;
+    /**
+     * Gets the context of an app by its octostar channel id.
+     * @param octostarChannelId the id assigned to the app by the octostar platform
+     * @returns the context if the app is found otherwise undefined
+     */
+    getAppContext: (octostarChannelId: string) => Promise<Record<string, any>>;
     /**
      * Query workspace items by content type directly from the database.
      * This ensures all items are retrieved, not just those loaded in memory.
@@ -878,6 +892,9 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Connects two entities with a relationship in a workspace.
      */
     connect: (relationship: Relationship | string, from: Entity, to: Entity, os_workspace?: string) => Promise<WorkspaceItem>;
+    moveOrRename: (item: WorkspaceItem & {
+        [ORIGINAL_OS_PARENT_FOLDER]?: string;
+    }) => Promise<MoveResponse>;
     /**
      * Saves an item with optional save options.
      */
@@ -949,6 +966,10 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Shows a tab with given properties.
      */
     showTab: (props: ShowTabProps) => Promise<void>;
+    /**
+     * Renames a tab by its id.
+     */
+    renameTab: (tabId: string, newName: string) => Promise<void>;
     /**
      * Closes a tab with given properties.
      */
@@ -1002,13 +1023,17 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      */
     showSaveAsModal: (props: SaveAsModalProps) => Promise<WorkspaceItem | undefined>;
     /**
-     * Gets a paste context with optional options.
+     * @deprecated This method is deprecated and will be removed in a future version. Use {@link createSetsFromItems} or {@link expandSet} instead.
      */
     getPasteContext: (options: PasteContextOptions) => Promise<Entity[]>;
     /**
      * Expands a set with optional options.
      */
     expandSet: (options: SetsOptions) => Promise<WorkspaceItem[]>;
+    /**
+     * Converts items to sets.
+     */
+    createSetsFromItems: (items: WorkspaceItem[]) => Promise<WorkspaceItem[]>;
     /**
      * Gets the open search query for a set with optional options.
      */
@@ -1302,6 +1327,11 @@ export declare interface DesktopSettings {
      * Listener for changes in open workspace IDs list (list gets updated on eg close / open event)
      */
     onOpenWorkspaceIdsChanged: AddListener<string[]>;
+    /**
+     * Gets developer settings for micro-frontends.
+     * Returns settings like API server URL overrides.
+     */
+    getDeveloperSettings: () => Promise<DeveloperSettings>;
 }
 
 /**
@@ -1319,6 +1349,21 @@ export declare type DesktopStylerContext = {
     selected?: GraphSpec;
 };
 
+/**
+ * Developer settings exposed to micro-frontends.
+ * @beta
+ */
+export declare interface DeveloperSettings {
+    /**
+     * Override URL for the API server.
+     */
+    octostarAPIServer?: string;
+    /**
+     * Override URL for the search app.
+     */
+    searchAppUrl?: string;
+}
+
 export declare interface DownloadOptions {
     content_type?: string;
     content_disposition?: 'inline' | 'attachment';
@@ -2053,6 +2098,8 @@ export declare type IframeTransformDefinition = {
     icon: string;
     /** Whether to reuse the tab for the iframe. */
     reuse_tab?: boolean;
+    /** The template string to get the tab name. Supports Nunjucks templates (e.g., "{{ record.entity_label }}"). */
+    tab_name?: string;
 };
 
 /**
@@ -2528,8 +2575,8 @@ export declare interface MoveOptions {
     force?: boolean;
 }
 
-export declare interface MoveResponse extends Entity {
-    new_path: string;
+export declare interface MoveResponse extends WorkspaceItem {
+    new_path?: string;
 }
 
 /**
@@ -2746,10 +2793,14 @@ export declare interface Ontology {
     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.
+     * @param newEntities - The new entities being added.
+     * @param oldEntities - The existing entities already in the graph.
+     * @returns A promise that resolves to an object containing entity edges and enriched entities (with labels).
      */
-    discoverEdgesOnAddingNodes: (newEntities: Entity[], oldEntities: Entity[]) => Promise<EntityEdge[]>;
+    discoverEdgesOnAddingNodes: (newEntities: Entity[], oldEntities: Entity[]) => Promise<{
+        edges: EntityEdge[];
+        enrichedEntities: Entity[];
+    }>;
     /**
      * Subscribes to changes for a given entity.
      * @param entity - The entity to subscribe to.
@@ -2788,6 +2839,8 @@ export declare type OntologyTags = {
     tag_value: string;
 };
 
+export declare const ORIGINAL_OS_PARENT_FOLDER = "#original_os_parent_folder";
+
 /**
  * Option to get out of the confirmation modal.
  * @beta
@@ -2841,6 +2894,18 @@ export declare interface OsAPIClient {
      * @returns A promise that resolves when the streaming is complete.
      */
     streamJson<T>(options: StreamJsonOptions<T>): Promise<void>;
+    /**
+     * Gets the configured base URL
+     * @returns A promise that resoves to the api base URL
+     */
+    getBaseUrl(): Promise<string>;
+    /**
+     * Fetch method that matches the standard fetch API.
+     * @param input - The resource to fetch (RequestInfo | URL).
+     * @param init - Optional request initialization options.
+     * @returns A promise that resolves with the Response object.
+     */
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
 }
 
 /**
@@ -2958,6 +3023,10 @@ export declare type OsNotification = string | {
      * Whether the notification should persist until manually closed.
      */
     persistent?: boolean;
+    /**
+     * Test identifier to be applied as data-testid attribute for E2E testing.
+     */
+    data_test_id?: string;
 };
 
 /**
@@ -3455,6 +3524,17 @@ export declare type RemoteAppApi = {
     setTransformResult: SetTransformResultFn;
 };
 
+export declare type RenameTabProps = {
+    /**
+     * ID of the tab.
+     */
+    tabId: string;
+    /**
+     * New name for the tab.
+     */
+    newName: string;
+};
+
 declare type RootOption = {
     path?: never;
     os_parent_folder?: never;
@@ -3491,6 +3571,14 @@ export declare type SaveAsModalProps = {
      * Default path for the item.
      */
     defaultPath?: string;
+    /**
+     * Exclude workspaces from the modal.
+     */
+    excludeWorkspaces?: string[];
+    /**
+     * Omit the filename from the modal.
+     */
+    omitFilename?: boolean;
 };
 
 export declare const SAVED_SEARCH_MESSAGE_TYPES: Readonly<{
@@ -3836,6 +3924,18 @@ export declare type SetsOptions = {
      * OS exact concept filter for the context.
      */
     os_exact_concept_filter?: string[];
+    /**
+     * When limit1 and limit2 are provided,
+     * the user will be prompted to choose the number of records to add
+     * if the count is greater than limit1.
+     */
+    limit1?: number;
+    /**
+     * When limit1 and limit2 are provided,
+     * the user will be prompted to choose the number of records to add
+     * if the count is greater than limit1.
+     */
+    limit2?: number;
 };
 
 export declare type SetTransformResultFn = (args: any[]) => Promise<void>;
@@ -4260,10 +4360,6 @@ export declare type VirtualEntity = Entity & {
     '#virtual': true;
 };
 
-/**
- * Represents a watcher.
- * @beta
- */
 export declare type Watcher = {
     /**
      * Application ID.
@@ -4336,6 +4432,15 @@ export declare type Whoami = {
      * Whether the user is a superuser (having the ADMIN_ALL_WORKSPACES username or role)
      */
     is_superuser: boolean;
+    /**
+     * Seconds until frontend should call whoami again to keep session alive.
+     * Null for legacy tokens without session management.
+     */
+    refresh_in_seconds: number | null;
+    /**
+     * Unix timestamp when session hits hard cap (absolute limit). Null for legacy tokens.
+     */
+    session_expires_at: number | null;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-types",
-  "version": "0.5.30",
+  "version": "0.5.34",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",
@@ -8,7 +8,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "",
+    "url": "https://github.com/Octostarco/octostar-frontend.git",
     "directory": "packages/octostar-platform-types"
   },
   "license": "MIT",
@@ -41,8 +41,8 @@
     "rimraf": "^5.0.5",
     "typedoc": "^0.26.5",
     "typescript": "~5.7.2",
-    "@repo/eslint-config": "0.0.0",
-    "@repo/typescript-config": "0.0.0"
+    "@repo/typescript-config": "0.0.0",
+    "@repo/eslint-config": "0.0.0"
   },
   "peerDependencies": {
     "antd": "^5.27.2",