@ibm-aspera/sdk 0.2.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,25 @@
+# IBM Aspera JavaScript SDK
+This JavaScript SDK allows web applications to integrate with IBM Aspera to perform high-speed Aspera file transfers.
+
+Documentation is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js/docs/)
+
+## Installation
+Install via npm:
+
+```shell
+$ npm install --save @ibm-aspera/sdk
+```
+
+Install from source:
+
+```shell
+$ git clone https://github.com/IBM/aspera-sdk-js.git
+$ cd aspera-sdk-js
+$ npm install
+```
+
+When installing from source, the `dist` directory includes a `js` directory that contains the bundled JavaScript SDK that can be included via `script` tag
+or copied to a web server for hosting.
+
+## Development
+To get started with development, take a look [here](https://github.com/IBM/aspera-sdk-js/blob/main/docs/DEVELOPMENT.md).

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

@@ -0,0 +1,219 @@
+import { AsperaSdkInfo, TransferResponse } from '../models/aspera-sdk.model';
+import { CustomBrandingOptions, DataTransferResponse, AsperaSdkSpec, AsperaSdkTransfer, FileDialogOptions, FolderDialogOptions, InitOptions, ModifyTransferOptions, ResumeTransferOptions, SafariExtensionEvent, TransferSpec, WebsocketEvent } 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.
+ *
+ * @returns a promise that resolves if server can connect or rejects if not
+ */
+export declare const testConnection: () => Promise<any>;
+/**
+ * Initialize drag and drop.
+ *
+ * @returns a promise that resolves if the initialization was successful or not
+ */
+export declare const initDragDrop: () => Promise<boolean>;
+/**
+ * Initialize IBM Aspera client. If client cannot (reject/catch), then
+ * client should attempt fixing server URL or trying again. If still fails disable UI elements.
+ *
+ * @param options initialization options:
+ *
+ * - `appId` the unique ID for the website. Transfers initiated during this session
+ * will be associated with this ID. It is recommended to use a unique ID to keep transfer
+ * information private from other websites.
+ *
+ * - `supportMultipleUsers` when enabled (defaults to false), the SDK will iterate over a port
+ * range and generate a session id to determine the running instance of the desktop app for the
+ * current user. This is needed when multiple users may be logged into the same machine
+ * simultaneously, for example on a Windows Server.
+ *
+ * @returns a promise that resolves if IBM Aspera Desktop is running properly or
+ * rejects if unable to connect
+ */
+export declare const init: (options?: InitOptions) => Promise<any>;
+/**
+ * Start a transfer
+ *
+ * @param transferSpec standard transferSpec for transfer
+ * @param asperaSdkSpec IBM Aspera settings when starting a transfer
+ *
+ * @returns a promise that resolves if transfer initiation is successful and rejects if transfer cannot be started
+ */
+export declare const startTransfer: (transferSpec: TransferSpec, asperaSdkSpec: AsperaSdkSpec) => Promise<AsperaSdkTransfer>;
+/**
+ * Register a callback event for getting transfer updates
+ *
+ * @param callback callback function to receive transfers
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+export declare const registerActivityCallback: (callback: (transfers: TransferResponse) => void) => string;
+/**
+ * Remove a callback from the transfer callback
+ *
+ * @param id the ID returned by `registerActivityCallback`
+ */
+export declare const deregisterActivityCallback: (id: string) => void;
+/**
+ * Register a callback event for when a user removes or cancels a transfer
+ * directly from IBM Aspera. This may also be called if IBM Aspera
+ * is configured to automatically remove completed transfers.
+ *
+ * @param callback callback function to receive transfers
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+export declare const registerRemovedCallback: (callback: (transfer: AsperaSdkTransfer) => void) => string;
+/**
+ * Remove a callback from the removed transfer callback
+ *
+ * @param id the ID returned by `registerRemovedCallback`
+ */
+export declare const deregisterRemovedCallback: (id: string) => void;
+/**
+ * Register a callback for getting updates about the connection status of IBM Aspera SDK.
+ *
+ * For example, to be notified of when the SDK loses connection with the application or connection
+ * is re-established. This can be useful if you want to handle the case where the user quits IBM Aspera
+ * after `init` has already been called, and want to prompt the user to relaunch the application.
+ *
+ * @param callback callback function to receive events
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+export declare const registerStatusCallback: (callback: (status: WebsocketEvent) => void) => string;
+/**
+ * Remove a callback from getting connection status events.
+ *
+ * @param id the ID returned by `registerStatusCallback`
+ */
+export declare const deregisterStatusCallback: (id: string) => void;
+/**
+ * Register a callback for getting updates about the Safari extension status.
+ *
+ * This can be useful if you want to handle the case where the user enable or disable the Safari extension.
+ *
+ * @param callback callback function to receive events
+ *
+ * @returns ID representing the callback for deregistration purposes
+ */
+export declare const registerSafariExtensionStatusCallback: (callback: (status: SafariExtensionEvent) => void) => string;
+/**
+ * Remove a callback from getting Safari extension status events.
+ *
+ * @param id the ID returned by `registerStatusCallback`
+ */
+export declare const deregisterSafariExtensionStatusCallback: (id: string) => void;
+/**
+ * Remove a transfer. This will stop the transfer if it is in progress.
+ *
+ * @param id transfer uuid
+ *
+ * @returns a promise that resolves if transfer is removed and rejects if transfer cannot be removed
+ */
+export declare const removeTransfer: (id: string) => Promise<any>;
+/**
+ * Stop a transfer.
+ *
+ * @param id transfer uuid
+ *
+ * @returns a promise that resolves if transfer is stopped and rejects if transfer cannot be stopped
+ */
+export declare const stopTransfer: (id: string) => Promise<any>;
+/**
+ * Resume a paused or failed transfer.
+ *
+ * @param id transfer uuid
+ * @param options resume transfer options
+ *
+ * @returns a promise that resolves with the new transfer object if transfer is resumed
+ */
+export declare const resumeTransfer: (id: string, options?: ResumeTransferOptions) => Promise<AsperaSdkTransfer>;
+/**
+ * Displays a file browser dialog for the user to select files.
+ *
+ * @param options file dialog options
+ *
+ * @returns a promise that resolves with the selected file(s) and rejects if user cancels dialog
+ */
+export declare const showSelectFileDialog: (options?: FileDialogOptions) => Promise<DataTransferResponse>;
+/**
+ * Displays a folder browser dialog for the user to select folders.
+ *
+ * @param options folder dialog options
+ *
+ * @returns a promise that resolves with the selected folder(s) and rejects if user cancels dialog
+ */
+export declare const showSelectFolderDialog: (options?: FolderDialogOptions) => Promise<DataTransferResponse>;
+/**
+ * Opens the IBM Aspera preferences page.
+ *
+ * @returns a promise that resolves when the preferences page is opened.
+ */
+export declare const showPreferences: () => Promise<any>;
+/**
+ * Get all transfers associated with the current application.
+ *
+ * @returns a promise that resolves with an array of transfers.
+ */
+export declare const getAllTransfers: () => Promise<AsperaSdkTransfer[]>;
+/**
+ * Get a specific transfer by ID.
+ *
+ * @param id transfer uuid
+ *
+ * @returns a promise that resolves with the transfer.
+ */
+export declare const getTransfer: (id: string) => Promise<AsperaSdkTransfer>;
+/**
+ * Opens and highlights the downloaded file in Finder or Windows Explorer. If multiple files,
+ * then only the first file will be selected.
+ *
+ * @param id transfer uuid
+ *
+ * @returns a promise that resolves if the file can be shown and rejects if not
+ */
+export declare const showDirectory: (id: string) => Promise<any>;
+/**
+ * Modify the speed of a running transfer.
+ *
+ * @param id transfer uuid
+ * @param options transfer rate options
+ *
+ * @returns a promise that resolves if the transfer rate can be modified and rejects if not
+ */
+export declare const modifyTransfer: (id: string, options: ModifyTransferOptions) => Promise<AsperaSdkTransfer>;
+/**
+ * Set the custom branding template to be used by IBM Aspera. If the app is already
+ * configured to use a different branding, then the branding template you specify will be
+ * stored by the app, allowing the end user to switch at any point.
+ *
+ * @param id custom branding template id. This should be consistent across page loads.
+ * @param options custom branding options
+ *
+ * @returns a promise that resolves if the branding was properly set.
+ */
+export declare const setBranding: (id: string, options: CustomBrandingOptions) => Promise<any>;
+/**
+ * Create a dropzone for the given element selector.
+ *
+ * @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
+ */
+export declare const createDropzone: (callback: (data: {
+    event: any;
+    files: DataTransferResponse;
+}) => void, elementSelector: string) => void;
+/**
+ * Remove dropzone.
+ *
+ * @param elementSelector the selector of the element on the page that should remove
+ */
+export declare const removeDropzone: (elementSelector: string) => void;
+/**
+ * Get metadata about the IBM Aspera installation.
+ *
+ * @returns a promise that returns information about the user's IBM Aspera installation.
+ */
+export declare const getInfo: () => Promise<AsperaSdkInfo>;