@octostar/platform-types 0.5.26 → 0.5.28

package/dist/platform-types.d.ts

@@ -763,6 +763,14 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
      * Gets the AI client.
      */
     getAIClient(): Promise<AIClient>;
+    /**
+     * Gets the FilesAPIClient.
+     */
+    getFilesAPIClient(): Promise<FilesAPIClient>;
+    /**
+     * Registers a context menu action.
+     */
+    registerContextMenuAction(action: DesktopActionMenuItem): Promise<Unsubscribe>;
     /**
      * Applies a tag to an entity.
      */
@@ -1118,14 +1126,14 @@ export declare type DesktopActionMenuItem = {
      * Sift-compatible filter to determine which entity records this action applies to.
      * The resulting list of matching records is passed to the action.
      */
-    filter: FilterQuery<Entity>;
+    filter?: FilterQuery<Entity>;
     /**
      * Async function that will be called with the filtered list of entity records.
      * Should return an Unsubscribe function to allow cleanup if needed.
      *
      * If the promise rejects, the menu item will be automatically removed and the error logged.
      */
-    action: (records: Entity[]) => Promise<Unsubscribe>;
+    action?: (records: Entity[]) => Promise<Unsubscribe>;
     /**
      * AI description for the app manifest or service.
      */
@@ -1578,7 +1586,7 @@ export declare interface FileListResponse {
 /**
  * Files service for interacting with the file system
  */
-export declare interface Files {
+export declare interface FilesAPIClient {
     /**
      * Check if file/folder/workspace exists and return its complete entity data
      *
@@ -1588,23 +1596,36 @@ export declare interface Files {
      */
     stat(os_workspace: string, path?: string): Promise<WorkspaceItem>;
     /**
-     * List immediate children (files and folders) of a given path
+     * Main entry point for listing workspace or folder contents
+     * Supports listing by path, parent folder ID, or root level
      *
-     * @param os_workspace - The workspace ID
-     * @param path - The path to list children for (empty string for workspace root)
-     * @param options - Optional parameters for pagination
-     * @returns Object containing arrays of folders and files with pagination info
+     * @param os_workspace - The workspace identifier
+     * @param options - Configuration object that determines listing strategy:
+     *                  - If options.path is provided, lists contents at that path
+     *                  - If options.os_parent_folder is provided, lists contents of that folder
+     *                  - If neither is provided, lists root level contents
+     * @returns Paginated list of files and folders
      */
-    list_folder(os_workspace: string, options: ListFolderOptions): Promise<FileListResponse>;
+    listFolder(os_workspace: string, options: ListFolderOptions): Promise<FileListResponse>;
     /**
      * Move a file or folder to a new path
      *
-     * @param os_workspace - The workspace ID
-     * @param path - The path to move
-     * @param options - Optional parameters for the move
-     * @returns The moved entity
+     @param os_workspace - The workspace identifier
+     * @param path - Current path of the file or folder to move/rename
+     * @param options - Move configuration
+     * @param options.to_path - Target path for the move/rename operation:
+     *                         - For moving: Specify the destination folder path (e.g., "target/folder/path")
+     *                         - For renaming: Specify the full path including new name (e.g., "same/folder/path/new-name.txt")
+     *                         - For workspace rename: Use empty source path and only new name as to_path
+     * @param options.force - When true, handles naming conflicts by auto-appending numbers (e.g., "file (1).txt")
+     *                       When false, returns 409 Conflict if target path already exists
+     *
+     * @returns Object containing:
+     *          - entity_id: Unique identifier of the moved/renamed entity
+     *          - entity_label: Display name of the entity
+     *          - new_path: Full path to the entity after move/rename
      */
-    move(os_workspace: string, path: string, options: MoveOptions): Promise<MoveResponse>;
+    moveOrRename(os_workspace: string, path: string, options: MoveOptions): Promise<MoveResponse>;
     /**
      * Create a new directory
      *
@@ -1637,6 +1658,17 @@ export declare interface Files {
      * @returns The download URL
      */
     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
+     * @returns The tracking ID and status URL
+     */
+    unzipByEntity(os_workspace: string, entity_id: string): Promise<{
+        tracking_id: string;
+        status_url: string;
+    }>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-types",
-  "version": "0.5.26",
+  "version": "0.5.28",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",

package/dist/docs/interfaces/Files.html

@@ -1,38 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Files | @octostar/platform-types - v0.5.26</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.26</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="Files.html">Files</a></li></ul><h1>Interface Files</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Files service for interacting with the file system</p>
-</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Files</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#deleteFile.deleteFile-1">deleteFile</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#deleteRecursive.deleteRecursive-1">deleteRecursive</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#getDownloadUrl.getDownloadUrl-1">getDownloadUrl</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#list_folder.list_folder-1">list_folder</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#mkdir.mkdir-1">mkdir</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#move.move-1">move</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Files.html#stat.stat-1">stat</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L72">files.ts:72</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Files.html#deleteFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File</span></a>
-<a href="Files.html#deleteRecursive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Recursive</span></a>
-<a href="Files.html#getDownloadUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Download<wbr/>Url</span></a>
-<a href="Files.html#list_folder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list_<wbr/>folder</span></a>
-<a href="Files.html#mkdir" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mkdir</span></a>
-<a href="Files.html#move" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move</span></a>
-<a href="Files.html#stat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stat</span></a>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="deleteFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File</span><a href="#deleteFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteFile.deleteFile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleteFile.deleteFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a file or directory</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to delete</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The deleted entity</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L125">files.ts:125</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecursive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Recursive</span><a href="#deleteRecursive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteRecursive.deleteRecursive-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Recursive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleteRecursive.deleteRecursive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a file or directory recursively</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to delete</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="DeleteResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L133">files.ts:133</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDownloadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Download<wbr/>Url</span><a href="#getDownloadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDownloadUrl.getDownloadUrl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Download<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getDownloadUrl.getDownloadUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a download URL for a file</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to get the download URL for</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="DownloadOptions.html" class="tsd-signature-type tsd-kind-interface">DownloadOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional parameters for the download</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The download URL</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L143">files.ts:143</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="list_folder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list_<wbr/>folder</span><a href="#list_folder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="list_folder.list_folder-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list_<wbr/>folder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#list_folder.list_folder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List immediate children (files and folders) of a given path</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/ListFolderOptions.html" class="tsd-signature-type tsd-kind-type-alias">ListFolderOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional parameters for pagination</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FileListResponse.html" class="tsd-signature-type tsd-kind-interface">FileListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Object containing arrays of folders and files with pagination info</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L90">files.ts:90</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="mkdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mkdir</span><a href="#mkdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mkdir.mkdir-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mkdir</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span><a href="#mkdir.mkdir-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new directory</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to create</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Entity.html" class="tsd-signature-type tsd-kind-type-alias">Entity</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The created entity</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L116">files.ts:116</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="move" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move</span><a href="#move" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="move.move-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">move</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#move.move-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Move a file or folder to a new path</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to move</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="MoveOptions.html" class="tsd-signature-type tsd-kind-interface">MoveOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional parameters for the move</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="MoveResponse.html" class="tsd-signature-type tsd-kind-interface">MoveResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The moved entity</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L103">files.ts:103</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stat</span><a href="#stat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stat.stat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">os_workspace</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span><a href="#stat.stat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if file/folder/workspace exists and return its complete entity data</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">os_workspace</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The workspace ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to check (empty string for workspace info)</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkspaceItem.html" class="tsd-signature-type tsd-kind-type-alias">WorkspaceItem</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Complete entity data if found</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/8aa865c6a554ac427413d4ef388d036a1b95efd1/packages/octostar-platform-types/src/files.ts#L80">files.ts:80</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#deleteFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File</span></a><a href="#deleteRecursive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Recursive</span></a><a href="#getDownloadUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Download<wbr/>Url</span></a><a href="#list_folder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list_<wbr/>folder</span></a><a href="#mkdir" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mkdir</span></a><a href="#move" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move</span></a><a href="#stat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stat</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.26</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>