@ibm-aspera/sdk 0.7.0 → 0.7.4

package/dist/commonjs/app/core.d.ts

@@ -1,6 +1,5 @@
 import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } from '../models/models';
-import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
+import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, TransferSpec, WebsocketEvent, ReadChunkAsArrayBufferResponse, ReadAsArrayBufferResponse, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } from '../models/models';
 /**
  * Check if IBM Aspera for Desktop connection works. This function is called by init
  * when initializing the SDK. This function can be used at any point for checking.
@@ -180,12 +179,9 @@ export declare const setBranding: (id: string, options: CustomBrandingOptions) =
  *
  * @param callback the function to call once the files are dropped
  * @param elementSelector the selector of the element on the page that should watch for drop events
- * @param connectOptions options for connect
+ * @param options options to configure which drag and drop events trigger the listener
  */
-export declare const createDropzone: (callback: (data: {
-    event: DragEvent;
-    files: DataTransferResponse;
-}) => void, elementSelector: string, connectOptions?: ConnectTypes.DragDropOptions) => void;
+export declare const createDropzone: (callback: (data: DropzoneEventData) => void, elementSelector: string, options?: DropzoneOptions) => void;
 /**
  * Remove dropzone.
  *

package/dist/commonjs/app/core.js

@@ -113,8 +113,7 @@ var init = function (options) {
     var _a, _b, _c;
     var appId = (_a = options === null || options === void 0 ? void 0 : options.appId) !== null && _a !== void 0 ? _a : (0, helpers_1.randomUUID)();
     index_1.asperaSdk.globals.appId = appId;
-    // For now ignore multi user support in Safari
-    if ((options === null || options === void 0 ? void 0 : options.supportMultipleUsers) && !(0, helpers_1.isSafari)()) {
+    if (options === null || options === void 0 ? void 0 : options.supportMultipleUsers) {
         index_1.asperaSdk.globals.supportMultipleUsers = true;
         index_1.asperaSdk.globals.sessionId = (0, helpers_1.randomUUID)();
     }
@@ -133,6 +132,7 @@ var init = function (options) {
             sdkLocation: options.connectSettings.sdkLocation,
             correlationId: options.connectSettings.correlationId,
             style: 'carbon',
+            version: options.connectSettings.version,
         });
         index_1.asperaSdk.globals.connectAW4 = {
             Connect: connect_sdk_js_1.Connect,
@@ -654,10 +654,27 @@ exports.setBranding = setBranding;
  *
  * @param callback the function to call once the files are dropped
  * @param elementSelector the selector of the element on the page that should watch for drop events
- * @param connectOptions options for connect
+ * @param options options to configure which drag and drop events trigger the listener
  */
-var createDropzone = function (callback, elementSelector, connectOptions) {
+var createDropzone = function (callback, elementSelector, options) {
+    var _a, _b, _c, _d, _e, _f;
+    var resolvedOptions = {
+        dragEnter: (_a = options === null || options === void 0 ? void 0 : options.dragEnter) !== null && _a !== void 0 ? _a : false,
+        dragOver: (_b = options === null || options === void 0 ? void 0 : options.dragOver) !== null && _b !== void 0 ? _b : false,
+        dragLeave: (_c = options === null || options === void 0 ? void 0 : options.dragLeave) !== null && _c !== void 0 ? _c : false,
+        drop: (_d = options === null || options === void 0 ? void 0 : options.drop) !== null && _d !== void 0 ? _d : true,
+        allowPropagation: (_e = options === null || options === void 0 ? void 0 : options.allowPropagation) !== null && _e !== void 0 ? _e : true,
+        allowDefaultBehavior: (_f = options === null || options === void 0 ? void 0 : options.allowDefaultBehavior) !== null && _f !== void 0 ? _f : false,
+    };
     if (index_1.asperaSdk.useConnect) {
+        var connectOptions = {
+            dragenter: resolvedOptions.dragEnter,
+            dragover: resolvedOptions.dragOver,
+            dragleave: resolvedOptions.dragLeave,
+            drop: resolvedOptions.drop,
+            allowPropagation: resolvedOptions.allowPropagation,
+            disablePreventDefault: resolvedOptions.allowDefaultBehavior,
+        };
         index_1.asperaSdk.globals.connect.setDragDropTargets(elementSelector, connectOptions, function (result) {
             callback({
                 event: result.event,
@@ -671,43 +688,91 @@ var createDropzone = function (callback, elementSelector, connectOptions) {
         (0, helpers_1.errorLog)(messages_1.messages.unableToFindElementOnPage);
         return;
     }
-    var dragEvent = function (event) {
-        event.preventDefault();
+    var handleEventDefaults = function (event) {
+        if (!resolvedOptions.allowDefaultBehavior) {
+            event.preventDefault();
+        }
+        if (!resolvedOptions.allowPropagation) {
+            event.stopPropagation();
+        }
     };
-    var dropEvent = function (event) {
+    var handleRequiredEventDefaults = function (event) {
         event.preventDefault();
-        if (event.dataTransfer && event.dataTransfer.files && event.dataTransfer.files.length && event.dataTransfer.files[0]) {
-            var files = [];
-            for (var i = 0; i < event.dataTransfer.files.length; i++) {
-                var file = event.dataTransfer.files[i];
-                files.push({
-                    lastModified: file.lastModified,
-                    name: file.name,
-                    size: file.size,
-                    type: file.type
-                });
-            }
-            var payload = {
-                files: files,
-                app_id: index_1.asperaSdk.globals.appId,
-            };
-            if (index_1.asperaSdk.isReady) {
-                client_1.client.request('dropped_files', payload)
-                    .then(function (data) { return callback({ event: event, files: data }); })
-                    .catch(function (error) {
-                    (0, helpers_1.errorLog)(messages_1.messages.unableToReadDropped, error);
-                });
-            }
-            else if (index_1.asperaSdk.httpGatewayIsReady) {
-                (0, core_1.handleHttpGatewayDrop)(event.dataTransfer.items, callback, event);
-            }
+        if (!resolvedOptions.allowPropagation) {
+            event.stopPropagation();
         }
     };
+    var registeredListeners = [];
+    if (resolvedOptions.dragEnter) {
+        registeredListeners.push({
+            event: 'dragenter',
+            callback: function (event) {
+                handleEventDefaults(event);
+                callback({ event: event });
+            },
+        });
+    }
+    if (resolvedOptions.dragLeave) {
+        registeredListeners.push({
+            event: 'dragleave',
+            callback: function (event) {
+                handleEventDefaults(event);
+                callback({ event: event });
+            },
+        });
+    }
+    if (resolvedOptions.drop || resolvedOptions.dragOver) {
+        registeredListeners.push({
+            event: 'dragover',
+            callback: function (event) {
+                handleRequiredEventDefaults(event);
+                if (resolvedOptions.dragOver) {
+                    callback({ event: event });
+                }
+            },
+        });
+    }
+    if (resolvedOptions.drop) {
+        registeredListeners.push({
+            event: 'drop',
+            callback: function (event) {
+                handleRequiredEventDefaults(event);
+                if (event.dataTransfer && event.dataTransfer.files && event.dataTransfer.files.length && event.dataTransfer.files[0]) {
+                    var files = [];
+                    for (var i = 0; i < event.dataTransfer.files.length; i++) {
+                        var file = event.dataTransfer.files[i];
+                        files.push({
+                            lastModified: file.lastModified,
+                            name: file.name,
+                            size: file.size,
+                            type: file.type
+                        });
+                    }
+                    var payload = {
+                        files: files,
+                        app_id: index_1.asperaSdk.globals.appId,
+                    };
+                    if (index_1.asperaSdk.isReady) {
+                        client_1.client.request('dropped_files', payload)
+                            .then(function (data) { return callback({ event: event, files: data }); })
+                            .catch(function (error) {
+                            (0, helpers_1.errorLog)(messages_1.messages.unableToReadDropped, error);
+                        });
+                    }
+                    else if (index_1.asperaSdk.httpGatewayIsReady) {
+                        (0, core_1.handleHttpGatewayDrop)(event.dataTransfer.items, callback, event);
+                    }
+                }
+            },
+        });
+    }
     elements.forEach(function (element) {
-        element.addEventListener('dragover', dragEvent);
-        element.addEventListener('drop', dropEvent);
-        index_1.asperaSdk.globals.dropZonesCreated.set(elementSelector, [{ event: 'dragover', callback: dragEvent }, { event: 'drop', callback: dropEvent }]);
+        registeredListeners.forEach(function (_a) {
+            var event = _a.event, listener = _a.callback;
+            element.addEventListener(event, listener);
+        });
     });
+    index_1.asperaSdk.globals.dropZonesCreated.set(elementSelector, registeredListeners);
 };
 exports.createDropzone = createDropzone;
 /**
@@ -718,14 +783,15 @@ exports.createDropzone = createDropzone;
 var removeDropzone = function (elementSelector) {
     var foundDropzone = index_1.asperaSdk.globals.dropZonesCreated.get(elementSelector);
     if (foundDropzone) {
+        var elements_1 = document.querySelectorAll(elementSelector);
         foundDropzone.forEach(function (data) {
-            var elements = document.querySelectorAll(elementSelector);
-            if (elements && elements.length) {
-                elements.forEach(function (element) {
+            if (elements_1 && elements_1.length) {
+                elements_1.forEach(function (element) {
                     element.removeEventListener(data.event, data.callback);
                 });
             }
         });
+        index_1.asperaSdk.globals.dropZonesCreated.delete(elementSelector);
     }
 };
 exports.removeDropzone = removeDropzone;

package/dist/commonjs/http-gateway/core.d.ts

@@ -1,4 +1,4 @@
-import { FileDialogOptions, DataTransferResponse, TransferSpec, AsperaSdkTransfer, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse } from '../models/models';
+import { FileDialogOptions, DataTransferResponse, DropzoneEventData, TransferSpec, AsperaSdkTransfer, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse } from '../models/models';
 import { HttpGatewayInfo } from './models';
 /**
  * HTTP Gateway Core Logic
@@ -64,10 +64,7 @@ export declare const createHtmlInputElement: () => HTMLInputElement;
  * Handle drop events and store files for HTTP Gateway
  * This works on top of desktop.
  */
-export declare const handleHttpGatewayDrop: (items: DataTransferItemList, callback: (data: {
-    event: DragEvent;
-    files: DataTransferResponse;
-}) => void, event: DragEvent) => void;
+export declare const handleHttpGatewayDrop: (items: DataTransferItemList, callback: (data: DropzoneEventData) => void, event: DragEvent) => void;
 /**
  * Open native browser file or folder picker for files
  *

package/dist/commonjs/index.d.ts

@@ -5,7 +5,7 @@ import { getInstallerUrls, isSafari } from './helpers/helpers';
 export declare const asperaSdk: AsperaSdk;
 declare const launch: () => void;
 export { isSafari, init, testConnection, startTransfer, launch, registerActivityCallback, deregisterActivityCallback, removeTransfer, showDirectory, stopTransfer, resumeTransfer, getAllTransfers, getTransfer, getFilesList, showSelectFileDialog, showSelectFolderDialog, showPreferences, modifyTransfer, createDropzone, removeDropzone, initDragDrop, getInstallerInfo, registerStatusCallback, deregisterStatusCallback, setBranding, getInfo, readAsArrayBuffer, readChunkAsArrayBuffer, getInstallerUrls, getCapabilities, getChecksum, };
-export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, GetChecksumOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, OverwritePolicy, PaginatedFilesResponse, Pagination, Path, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse, ResumePolicy, ResumeTransferOptions, SafariExtensionEvent, SdkCapabilities, TransferSpec, TransferStatus, WebsocketEvent, } from './models/models';
+export type { AsperaSdkSpec, AsperaSdkTransfer, BrowserStyleFile, ChecksumFileResponse, CustomBrandingOptions, CustomTheme, CustomThemeItems, DataTransferResponse, DropzoneEventData, DropzoneEventType, DropzoneOptions, FileDialogOptions, FileError, FileFilter, FileStat, FileStatus, FolderDialogOptions, GetChecksumOptions, InitOptions, InstallerInfo, InstallerInfoResponse, InstallerOptions, InstallerUrlInfo, ModifyTransferOptions, OverwritePolicy, PaginatedFilesResponse, Pagination, Path, ReadAsArrayBufferResponse, ReadChunkAsArrayBufferResponse, ResumePolicy, ResumeTransferOptions, SafariExtensionEvent, SdkCapabilities, TransferSpec, TransferStatus, WebsocketEvent, } from './models/models';
 export type { ActivityMessage, ActivityMessageTypes, AsperaSdkClientInfo, AsperaSdkInfo, TransferResponse, } from './models/aspera-sdk.model';
 export { AsperaSdk, AsperaSdkGlobals } from './models/aspera-sdk.model';
 export type { HttpGatewayInfo } from './http-gateway/models';

package/dist/commonjs/models/aspera-sdk.model.d.ts

@@ -1,4 +1,4 @@
-import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } from './models';
+import { CustomBrandingOptions, DataTransferResponse, DropzoneEventData, DropzoneEventType, DropzoneOptions, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, InstallerInfoResponse, InstallerOptions, ModifyTransferOptions, Pagination, PaginatedFilesResponse, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent, InstallerUrlInfo, SdkCapabilities, GetChecksumOptions, ChecksumFileResponse } from './models';
 import { HttpGatewayInfo } from '../http-gateway/models';
 import * as ConnectTypes from '@ibm-aspera/connect-sdk-js/dist/esm/core/types';
 import { Connect, ConnectInstaller } from '@ibm-aspera/connect-sdk-js';
@@ -23,8 +23,8 @@ export declare class AsperaSdkGlobals {
     sessionId?: string;
     /** Map of drop zones created by querySelector */
     dropZonesCreated: Map<string, {
-        event: string;
-        callback: (event: any) => void;
+        event: DropzoneEventType;
+        callback: (event: DragEvent) => void;
     }[]>;
     /** HTTP Gateway URL after successful passing */
     httpGatewayUrl?: string;
@@ -208,10 +208,7 @@ export declare class AsperaSdk {
     /** Function to set custom branding for IBM Aspera */
     setBranding: (id: string, options: CustomBrandingOptions) => Promise<any>;
     /** Create dropzone for drop events of files */
-    createDropzone: (callback: (data: {
-        event: any;
-        files: DataTransferResponse;
-    }) => void, elementSelector: string) => void;
+    createDropzone: (callback: (data: DropzoneEventData) => void, elementSelector: string, options?: DropzoneOptions) => void;
     /** Remove dropzone for drop events of files */
     removeDropzone: (elementSelector: string) => void;
     /** Function to get latest installer information */

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

@@ -58,6 +58,57 @@ export interface DataTransferResponse {
         files: BrowserStyleFile[];
     };
 }
+/** Drag and drop event types supported by the dropzone. */
+export type DropzoneEventType = 'dragenter' | 'dragleave' | 'dragover' | 'drop';
+/** Callback data for dropzone drag and drop events. */
+export interface DropzoneEventData {
+    event: DragEvent;
+    files?: DataTransferResponse;
+}
+/** Options to configure the behavior of a dropzone created with {@link createDropzone}. */
+export interface DropzoneOptions {
+    /**
+     * Whether the listener is invoked when a drag enters the dropzone element.
+     * Useful for applying visual feedback on the drop target.
+     * Default: false.
+     */
+    dragEnter?: boolean;
+    /**
+     * Whether the listener is invoked while a drag is held over the dropzone element.
+     * Default: false.
+     */
+    dragOver?: boolean;
+    /**
+     * Whether the listener is invoked when a drag leaves the dropzone element.
+     * Useful for reverting visual feedback applied on `dragEnter`.
+     * Default: false.
+     */
+    dragLeave?: boolean;
+    /**
+     * Whether the listener is invoked when files are dropped onto the dropzone element.
+     * The dropped files are provided via the callback's `files` property.
+     * Default: true.
+     */
+    drop?: boolean;
+    /**
+     * Whether drag and drop events propagate to parent elements after being handled.
+     * When false, `event.stopPropagation()` is called on all enabled events (`dragenter`, `dragleave`,
+     * `dragover`, `drop`). Note that `dragover` is always registered internally when `drop` is true,
+     * so this setting also affects that internal listener even if `dragOver` is not enabled.
+     * Set to false when the dropzone is nested inside another draggable or interactive element.
+     * Default: true.
+     */
+    allowPropagation?: boolean;
+    /**
+     * Whether the browser's default action is preserved on `dragenter` and `dragleave` events.
+     * When false (default), the SDK calls `event.preventDefault()` on these events automatically.
+     * When true, the caller is responsible for calling `event.preventDefault()` in the listener.
+     * Note: `dragover` and `drop` always call `event.preventDefault()` regardless of this setting,
+     * as it is required for drops to function correctly in the browser.
+     * Default: false.
+     */
+    allowDefaultBehavior?: boolean;
+}
 export interface BrowserStyleFile {
     /** Last modified date of the file in milliseconds since the UNIX epoch */
     lastModified: number;
@@ -795,6 +846,8 @@ export interface InitOptions {
         correlationId?: string;
         /** Indicate if default Connect installer window should not be shown */
         hideIncludedInstaller?: boolean;
+        /** Connect installer version to offer for downloads. This option is ignored if `sdkLocation` is specified. Only supports versions `4.x.x`. */
+        version?: string;
     };
 }
 export interface InstallerUrlInfo {