@ibm-aspera/sdk 0.9.0 → 0.16.0

package/dist/commonjs/models/models.d.ts

@@ -28,6 +28,14 @@ export interface FolderDialogOptions {
     /** Allow user to select multiple folders */
     multiple?: boolean;
 }
+export interface SaveFileDialogOptions {
+    /** Filter the files displayed by file extension. */
+    allowedFileTypes?: any;
+    /** The filename to pre-fill the dialog with. */
+    suggestedName?: string;
+    /** The name of the dialog window. */
+    title?: string;
+}
 /**
  * Options related to fetching the latest Aspera installer information.
  *
@@ -165,6 +173,60 @@ export interface ChecksumFileResponse {
     /** The algorithm used */
     checksumMethod: 'md5' | 'sha1' | 'sha256' | 'sha512';
 }
+/** The type of a directory entry */
+export type EntryType = 'file' | 'directory';
+/** Filters to narrow directory listing results */
+export interface DirectoryListFilters {
+    /** Only return entries of this type. Omit to return all. */
+    type?: EntryType;
+    /** Glob pattern matched against the file name only (e.g., "*.pdf"). */
+    namePattern?: string;
+    /** Whether to include hidden files and directories in the results. */
+    hidden?: boolean;
+}
+/** Options for testing SSH port connectivity to a transfer server. */
+export interface TestSshPortsOptions {
+    /** Domain name of the transfer server */
+    remote_host: string;
+    /** SSH port */
+    ssh_port?: number;
+    /** Timeout value in seconds */
+    timeout_sec?: number;
+}
+/** Options for reading directory contents */
+/** Valid page names for the preferences page. */
+export type PreferencesPage = 'general' | 'transfers' | 'network' | 'bandwidth' | 'security';
+/** Options for opening the preferences page to a specific tab. */
+export interface ShowPreferencesPageOptions {
+    /** The preferences page (tab) to open. */
+    page: PreferencesPage;
+}
+export interface ReadDirectoryOptions {
+    /** Absolute path to the directory to enumerate. Must have been previously allowed via dialog selection or drag-drop. */
+    path: string;
+    /** Maximum recursion depth. 0 = direct children only (non-recursive). Omit for full recursive traversal. */
+    depth?: number;
+    /** Optional filters to narrow the results. */
+    filters?: DirectoryListFilters;
+}
+/** A single entry in a directory listing */
+export interface DirectoryEntry {
+    /** Path relative to the traversal root, using forward slashes on all platforms. */
+    relativePath: string;
+    /** The entry type: "file" or "directory". */
+    type: EntryType;
+    /** Size in bytes. 0 for directories. */
+    size: number;
+    /** Last modified timestamp in milliseconds since the UNIX epoch. */
+    lastModified: number;
+}
+/** Response from reading directory contents */
+export interface ReadDirectoryResponse {
+    /** The directory entries matching the request criteria. */
+    entries: DirectoryEntry[];
+    /** The total number of entries returned. If this equals the server maximum, results may have been truncated. */
+    totalCount: number;
+}
 export interface ModifyTransferOptions {
     /**
      * @deprecated Use `lock_min_rate_kbps` instead.
@@ -893,4 +955,46 @@ export interface SdkCapabilities {
      * but not HTTP Gateway.
      */
     showPreferences: boolean;
+    /**
+     * Whether the transfer client supports showing the transfer manager.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
+     * but not HTTP Gateway.
+     */
+    showTransferManager: boolean;
+    /**
+     * Whether the transfer client supports showing the transfer rate monitor.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
+     * but not HTTP Gateway.
+     */
+    showTransferMonitor: boolean;
+    /**
+     * Whether the transfer client supports authenticating a transfer specification.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
+     * but not HTTP Gateway.
+     */
+    authenticate: boolean;
+    /**
+     * Whether the transfer client supports testing SSH port connectivity.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
+     * but not HTTP Gateway.
+     */
+    testSshPorts: boolean;
+    /**
+     * Whether the transfer client supports showing the save file dialog.
+     *
+     * This is supported when using Connect or IBM Aspera for desktop with the required RPC methods,
+     * but not HTTP Gateway.
+     */
+    showSaveFileDialog: boolean;
+    /**
+     * Whether the SDK can read directory contents.
+     *
+     * This is supported when using IBM Aspera for desktop with the required RPC methods,
+     * but not Connect or HTTP Gateway.
+     */
+    readDirectory: boolean;
 }