@ibm-aspera/sdk 0.2.7 → 0.2.8

package/example/package.json

@@ -1,29 +0,0 @@
-{
-  "name": "aspera-sdk-js-test",
-  "version": "0.0.1",
-  "type": "module",
-  "scripts": {
-    "start": "vite",
-    "build": "rm -rf dist && tsc -b && vite build --base /aspera-sdk-js/"
-  },
-  "dependencies": {
-    "@carbon/icons-react": "^11.57.0",
-    "@carbon/react": "^1.79.0",
-    "highlight.js": "^11.11.1",
-    "markdown-it": "^14.1.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "react-router": "^7.4.1"
-  },
-  "devDependencies": {
-    "@types/markdown-it": "^14.1.2",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
-    "@vitejs/plugin-basic-ssl": "^2.0.0",
-    "@vitejs/plugin-react": "^4.3.4",
-    "globals": "^15.15.0",
-    "sass": "^1.86.2",
-    "typescript": "~5.7.2",
-    "vite": "^6.2.0"
-  }
-}

package/example/public/404.html

@@ -1,5 +0,0 @@
-<script>
-  const path = window.location.pathname.slice(1);
-  localStorage.setItem('c', path);
-  window.location.href='../';
-</script>

package/example/public/sdk-code.js

@@ -1,334 +0,0 @@
-/**
- * This JS file is used for code snippet examples.
- * TypeScript file declrarations of toString
- * do not maintain comments or newlines.
- */
-
-window.selectedFiles = [];
-
-function initializeAspera(supportMulti) {
-  /**
-   * An ID for your application. For multi user applications
-   * this can include the user ID or other identifier
-   */
-  const appId = 'my-application-unique-id';
-
-  /**
-   * Indicate if machine runs the app with multiple user's at once
-   * like a virtual machine.
-   */
-  const supportMultipleUsers = !!supportMulti;
-
-  asperaSdk.init({appId, supportMultipleUsers}).then(() => {
-    // The SDK started. Transfers and file picker can now be used.
-    alert('SDK started');
-  }).catch(error => {
-    // The SDK could not start. The app may not be running.
-    console.error('SDK could not start', error);
-    alert(`Init failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function testAspera() {
-  asperaSdk.testConnection().then(response => {
-    // The test was successful. The app is running
-    alert(`Test successful\n\n${JSON.stringify(response, undefined, 2)}`);
-  }).catch(error => {
-    // The test failed. The app is not running or cannot be reached.
-    console.error('Test failed', error);
-    alert(`Test failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  })
-}
-
-function selectItemsAspera(selectFolders) {
-  /**
-   * showSelectFolderDialog will only allow picking folders.
-   * showSelectFileDialog will only allow picking files.
-   * They both return the same response type. So swapping
-   * out the function is safe.
-   */
-  (selectFolders ? asperaSdk.showSelectFolderDialog() : asperaSdk.showSelectFileDialog()).then(response => {
-    /**
-     * File list for transferSpec is returned in `response.dataTransfer.files` array
-     * where name is the path to the selected item.
-     */
-    alert(`Selected items:\n\n${JSON.stringify(response, undefined, 2)}`);
-    response.dataTransfer.files.forEach(item => window.selectedFiles.push(item));
-  }).catch(error => {
-    // If code -32002 then user canceled selecting. Otherwise another failure.
-    if (error.debugData?.code === -32002) {
-      alert('User canceled selecting items');
-    } else {
-      console.error('Selecting items failed', error);
-      alert(`Selecting items failed\n\n${JSON.stringify(error, undefined, 2)}`);
-    }
-  });
-}
-
-function startTransferAspera(transferSpec) {
-  /** The AsperaSpec defines rules on how the client app should work with transfers */
-  const asperaSpec = {use_absolute_destination_path: false};
-
-  asperaSdk.startTransfer(transferSpec, asperaSpec).then(response => {
-    // Transfer accepted and is starting
-    alert(`Transfer started:\n\n${JSON.stringify(response, undefined, 2)}`);
-  }).catch(error => {
-    // Transfer not accepted by the Aspera app
-    console.error('Start transfer failed', error);
-    alert(`Start transfer failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function setupDropAspera(dropZone) {
-  /**
-   * dropZone is a CSS style selector for an element that should be
-   * registered to watch for file drop events.
-   *
-   * You only need to init once and then can register each dropZone
-   * inidividually. Depending on how many drop zones may need to loop
-   * or split init and set dropzones.
-   */
-
-  // For safety you can prevent at highest level drop default actions
-  // This is useful to avoid browser opening file if not dropped in the
-  // Dropzone
-  window.addEventListener('drop', event => {
-    event.preventDefault();
-  });
-  window.addEventListener('dragover', event => {
-    event.preventDefault();
-  });
-
-  /** The callback for when files are dropped */
-  const dropCallback = response => {
-    response.event.stopPropagation();
-    /**
-     * File list for transferSpec is returned in `response.files.dataTransfer.files` array
-     * where name is the path to the selected item.
-     */
-    alert(`Dropped items:\n\n${JSON.stringify(response.files, undefined, 2)}`);
-    response.files.dataTransfer.files.forEach(item => window.selectedFiles.push(item));
-  };
-
-  /**
-   * While not needed normally. You can also remove the dropdzone.
-   * This will remove the listener and no longer accept drops to that element.
-   */
-  const cancelDropzone = () => {
-    asperaSdk.removeDropzone(dropZone);
-  };
-
-  asperaSdk.initDragDrop().then(() => {
-    // Drag and drop can now be safely registered
-    // Register the dropZone
-    asperaSdk.createDropzone(dropCallback, dropZone);
-  }).catch(error => {
-    // Drag and drop init failed. This is rare.
-    console.error('Drag and drop could not start', error);
-    alert(`Drag and drop failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function monitorTransfersAspera() {
-  /**
-   * Setup all monitor callbacks and store transfers with latest
-   * data in the transferStore to render on a UI.
-   */
-
-  // Create local store to hold all transfers
-  /** @type {Map<string, AsperaSdkTransfer>} */
-  const transferStore = new Map();
-
-  /**
-   * Create a function to parse transfers and place in map.
-   * Monitor and get all return similar responses.
-   * @param {AsperaSdkTransfer[]} transfers
-   */
-  const parseTransfers = transfers => {
-    transfers.forEach(item => {
-      transferStore.set(item.uuid, item);
-    });
-  }
-
-  // On load get all transfers. This needs to be done after init.
-  asperaSdk.getAllTransfers().then(transfers => {
-    parseTransfers(transfers);
-  }).catch(error => {
-    console.error('Could not get all transfers on load', error);
-  });
-
-  // Register event listener for new transfers
-  asperaSdk.registerActivityCallback(response => {
-    parseTransfers(response.transfers);
-  });
-
-  // Register event listener for transfers removed from app
-  asperaSdk.registerRemovedCallback(transfer => {
-    transferStore.delete(transfer.uuid);
-  });
-
-  // Used for demo. Normally use this store to render on the UI
-  return transferStore;
-}
-
-function removeTransferAspera(transferId) {
-  /** Remove a transfer from the monitor in app and from SDK responses */
-  asperaSdk.removeTransfer(transferId).then(response => {
-    // Transfer was removed. Remove it from local store
-    alert('Transfer removed');
-    console.info('Transfer removed', response);
-  }).catch(error => {
-    // Transfer could not be removed
-    console.error('Transfer removal failed', error);
-    alert(`Transfer removal failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function stopTransferAspera(transferId) {
-  /** Stop an active transfer. You can resume this transfer later. */
-  asperaSdk.stopTransfer(transferId).then(() => {
-    // Transfer was stopped. Next update from activity should indicate this.
-    alert('Transfer stopped');
-    console.info('Transfer stopped', response);
-  }).catch(error => {
-    // Transfer could not be stopped
-    console.error('Transfer stopping failed', error);
-    alert(`Transfer stopping failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function resumeTransferAspera(transferId) {
-  /** Resume a stopped transfer. */
-  asperaSdk.resumeTransfer(transferId).then(response => {
-    // Transfer was resumed. Next update from activity should indicate this.
-    alert('Transfer resumed');
-    console.info('Transfer resumed', response);
-  }).catch(error => {
-    // Transfer could not be resumed
-    console.error('Transfer resuming failed', error);
-    alert(`Transfer resuming failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function showDirectoryAspera(transferId) {
-  /** Open the local directory of the downloaded item. */
-  asperaSdk.showDirectory(transferId).then(response => {
-    console.info('Show directory', response);
-  }).catch(error => {
-    // Transfer info could not be retrieved
-    console.error('Show local directory failed', error);
-    alert(`Show local directory failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function transferInfoAspera(transferId) {
-  /** Get all details on a specific transfer. */
-  asperaSdk.getTransfer(transferId).then(response => {
-    alert('Transfer info retrieved. See console for object.');
-    console.info('Get transfer', response);
-  }).catch(error => {
-    // Transfer info could not be retrieved
-    console.error('Transfer info get failed', error);
-    alert(`Transfer info get failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function getInfoAspera() {
-  /** Get metadata about the IBM Aspera installation. */
-  asperaSdk.getInfo().then(response => {
-    alert(`Get info response\n\n${JSON.stringify(response, undefined, 2)}`);
-    console.info('Get info response', response);
-  }).catch(error => {
-    console.error('Get info failed', error);
-    alert(`Get info failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function showPreferencesAspera() {
-  /** Open preference window for IBM Aspera. */
-  asperaSdk.showPreferences().catch(error => {
-    console.error('Show preferences failed', error);
-    alert(`Show preferences failed\n\n${JSON.stringify(error, undefined, 2)}`);
-  });
-}
-
-function registerStatusCallbackAspera() {
-  /**
-   * Register status callback. This will monitor if the app is closed or reopens.
-   * This test currently just consoles all changes.
-   */
-  alert('Registered app status changes. Monitor the console for events.');
-
-  asperaSdk.registerStatusCallback(status => {
-    console.info('Status changed', status);
-  });
-}
-
-function registerSafariExtensionStatusCallbackAspera() {
-  /**
-   * Register status callback for the Safari Extension.
-   * This will monitor if the extension has changes.
-   * `isSafari` is provided by the Aspera SDK.
-   *
-   * This test currently just consoles all changes.
-   */
-
-  if (asperaSdk.isSafari()) {
-    alert('Registered safari extension changes. Monitor the console for events.');
-
-    asperaSdk.registerSafariExtensionStatusCallback(status => {
-      console.info('Status changed for Safari Extension', status);
-    });
-  } else {
-    alert('Register safari extension not set since not in Safari');
-  }
-}
-
-function installerAspera() {
-  /**
-   * Basic JavaScript to get the installers and
-   * load it into the DOM.
-   * After successful init you should usually remove this.
-   */
-
-  asperaSdk.getInstallerInfo().then(response => {
-    const header = document.createElement('h4');
-    header.innerText = 'IBM Aspera Installer';
-    header.style = 'margin-bottom: 20px; color: #fff;';
-
-    const launchButton = document.createElement('button');
-    launchButton.innerText = 'Launch'
-    launchButton.style = 'display: block; width: 100%; margin-bottom: 16px; padding: 8px';
-    launchButton.type = 'button';
-    launchButton.onclick = () => {
-      // Provide a way to launch the SDK if already installed
-      asperaSdk.launch();
-    }
-
-    const buttons = response.entries.map(entry => {
-      // Loop over each entry and make a button to click it to open download
-      // Normally just one item. But some may have more. So iterate the entries
-      const button = document.createElement('button');
-      button.type = 'button';
-      button.style = 'display: block; width: 100%; margin-bottom: 16px; padding: 8px';
-      button.innerText = `Install (${entry.platform} - ${entry.type})`;
-      button.onclick = () => {
-        window.open(entry.url, '_blank', 'noopener,noreferrer');
-      };
-
-      return button;
-    });
-
-    buttons.unshift(launchButton);
-
-    // Create the wrapper element and add it to body as fixed element
-    const wrapper = document.createElement('div');
-    wrapper.id = 'aspera-installer-test';
-    wrapper.style = 'position: fixed; bottom: 0px; right: 32px; height: 260px; width: 280px; background-color: #444; padding: 16px 20px;';
-    wrapper.append(header, ...buttons);
-
-    document.body.append(wrapper);
-  }).catch(error => {
-    console.error('Installer info get failed', error);
-  });
-}

package/example/src/App/App.scss

@@ -1,40 +0,0 @@
-.aspera-root {
-  height: 100vh;
-
-  .content-root {
-    position: absolute;
-    top: 3rem;
-    bottom: 0;
-    right: 0;
-    left: 0;
-    overflow-y: auto;
-  }
-
-  .content-header {
-    .cds--tabs {
-      border-top: 1px solid var(--cds-border-subtle);
-      border-bottom: 1px solid var(--cds-border-subtle);
-      padding: 0 3rem;
-
-      .cds--tabs__nav-item {
-        min-width: 7rem;
-      }
-    }
-
-    h1 {
-      padding: 0;
-    }
-
-    &-title {
-      display: flex;
-      justify-content: space-between;
-      align-items: end;
-      padding: 2rem 3rem 1rem 3rem;
-      flex-wrap: wrap;
-    }
-  }
-
-  .route-root {
-    padding: 2rem 3rem;
-  }
-}

package/example/src/App/index.tsx

@@ -1,174 +0,0 @@
-import './App.scss';
-import { init, launch, testConnection } from '@ibm-aspera/sdk';
-import { Header, HeaderGlobalAction, HeaderGlobalBar, HeaderName, Theme, Tab, TabList, Tabs, Button } from '@carbon/react';
-import { LogoGithub, Notification, NotificationOff, Sdk } from '@carbon/icons-react';
-import { Route, Routes, useLocation, useNavigate } from 'react-router';
-import { useEffect, useState } from 'react';
-import hljs from 'highlight.js/lib/core';
-import javascript from 'highlight.js/lib/languages/javascript';
-import Initialize from '../Views/Initialize';
-import Test from '../Views/Test';
-import StartTransfer from '../Views/StartTransfer';
-import MonitorTransfers from '../Views/MonitorTransfers';
-import SelectItems from '../Views/SelectItems';
-import Installer from '../Views/Installer';
-import DragDrop from '../Views/DragDrop';
-import Other from '../Views/Other';
-import Home from '../Views/Home';
-import AllTogether from '../Views/AllTogether';
-
-export const tabItems = [
-  {route: '/', name: 'Home', component: <Home />},
-  {route: '/init', name: 'Initialize', component: <Initialize />, row: 1},
-  {route: '/test', name: 'Test', component: <Test />, row: 1},
-  {route: '/installer', name: 'Installing', component: <Installer />, row: 4},
-  {route: '/select-items', name: 'Select items', component: <SelectItems />, row: 3},
-  {route: '/start-transfer', name: 'Start transfer', component: <StartTransfer />, row: 2},
-  {route: '/manage-transfer', name: 'Manage transfers', component: <MonitorTransfers />, row: 2},
-  {route: '/drag-drop', name: 'Drag & drop', component: <DragDrop />, row: 3},
-  {route: '/other', name: 'Other', component: <Other />, row: 1},
-  {route: '/all', name: 'All together', component: <AllTogether />},
-];
-
-export default function App() {
-  const [disableAlert, setDisableAlert] = useState(false);
-  const navigate = useNavigate();
-  const location = useLocation();
-  hljs.registerLanguage('javascript', javascript);
-  let initialized = false;
-
-  useEffect(() => {
-    // Prevent drag and drop testing from reloading page
-    window.addEventListener('drop', event => {
-      event.preventDefault();
-    });
-    window.addEventListener('dragover', event => {
-      event.preventDefault();
-    });
-
-    window.addEventListener('keyup', event => {
-      // If ESCAPE is pressed remove the installer window if set. Hidden option for power users.
-      if (event.key === 'Escape') {
-        document.querySelector('#aspera-installer-test')?.remove();
-      }
-    })
-
-    const path = localStorage.getItem('path');
-
-    if (path) {
-      localStorage.removeItem('path');
-      navigate(path);
-    }
-  }, []);
-
-  const openGithub = (): void => {
-    window.open('https://github.com/IBM/aspera-sdk-js', '_blank', 'noopener,noreferrer');
-  };
-
-  const openSDKdocs = (): void => {
-    window.open('docs', '_blank', 'noopener,noreferrer');
-  };
-
-  const toggleAlert = (): void => {
-    const newValue = !disableAlert;
-
-    if (newValue) {
-      window.alert = (data) => {
-        console.info(data);
-      };
-    } else {
-      window.location.reload();
-    }
-
-    setDisableAlert(newValue);
-  }
-
-  const openPath = (path: string): void => {
-    navigate(path);
-  };
-
-  const header = (
-    <Header aria-label="Carbon Tutorial">
-      <HeaderName prefix="IBM Aspera">JavaScript SDK Test Application</HeaderName>
-      <HeaderGlobalBar>
-        <HeaderGlobalAction aria-label={disableAlert ? 'Enable alerts (needs reload)' : 'Disable alerts'} tooltipAlignment="end" className="action-icons" onClick={toggleAlert}>
-          {disableAlert ? <Notification size={20} /> : <NotificationOff size={20} />}
-        </HeaderGlobalAction>
-        <HeaderGlobalAction aria-label="Github" tooltipAlignment="end" className="action-icons" onClick={openGithub}>
-          <LogoGithub size={20} />
-        </HeaderGlobalAction>
-        <HeaderGlobalAction aria-label="SDK Docs" tooltipAlignment="end" className="action-icons" onClick={openSDKdocs}>
-          <Sdk size={20} />
-        </HeaderGlobalAction>
-      </HeaderGlobalBar>
-    </Header>
-  );
-
-  const startApp = (): void => {
-    let testResolved = false;
-
-    const initCallback = (): void => {
-      if (initialized) {
-        return;
-      }
-
-      // Seeing issue in Safari where calling init doesn't catch or then...
-      setTimeout(() => {
-        init({appId: 'my-application-unique-id'}).then(() => {
-          initialized = true;
-        }).catch((error: unknown) => {
-          console.error('SDK could not start from quick launch', error);
-        })
-      }, 3000);
-    };
-
-    testConnection().then(() => {
-      testResolved = true;
-      initCallback();
-    }).catch(() => {
-      testResolved = true;
-      launch();
-      initCallback();
-    });
-
-    setTimeout(() => {
-      // Test never resolved. Launch
-      if (!testResolved) {
-        launch();
-        initCallback();
-      }
-    }, 2000);
-  };
-
-  const currentTabIndex = tabItems.findIndex(item => item.route === location.pathname);
-
-  const tabs = (
-    <Tabs selectedIndex={currentTabIndex}>
-      <TabList contained>
-        {tabItems.map(item => <Tab key={item.route} onClick={() => openPath(item.route)}>{item.name}</Tab>)}
-      </TabList>
-    </Tabs>
-  );
-
-  return (
-    <Theme theme="g100" className="aspera-root">
-      {header}
-      <div className="content-root">
-        <div className="content-header">
-          <div className="content-header-title">
-            <h1>{tabItems[currentTabIndex]?.name || '404'}</h1>
-            <div className="content-header-title--actions">
-              <Button kind="ghost" type="button" onClick={startApp}>Launch and start</Button>
-            </div>
-          </div>
-          {tabs}
-        </div>
-        <div className="route-root">
-          <Routes>
-            {tabItems.map(item => <Route index={item.route === '/'} key={item.route} path={item.route === '/' ? undefined : item.route} element={item.component} />)}
-          </Routes>
-        </div>
-      </div>
-    </Theme>
-  );
-}

package/example/src/Views/AllTogether.tsx

@@ -1,26 +0,0 @@
-import './Views.scss';
-import { tabItems } from '../App';
-
-export default function AllTogether() {
-  const getItem = (item: {route: string; name: string; component: React.ReactNode}): React.ReactNode => {
-    return (
-      <div className="item-area" key={item.route}>
-        {item.component}
-      </div>
-    );
-  }
-
-  const rows = tabItems.filter(item => !!item.row).map(item => item.row).sort();
-
-  return (
-    <div className="example-pages all-together">
-      {[...new Set(rows)].map(row => {
-        return (
-        <div className={`item-row ${row === 1 ? 'flat-space' : ''}`} key={row}>
-          {tabItems.filter(item => item.row === row).map(item => getItem(item))}
-        </div>
-        );
-      })}
-    </div>
-  );
-};

package/example/src/Views/DragDrop.tsx

@@ -1,23 +0,0 @@
-import './Views.scss';
-import { Button, CodeSnippet } from '@carbon/react';
-import { useEffect } from 'react';
-import hljs from 'highlight.js';
-
-export default function DragDrop() {
-  useEffect(() => {
-    document.querySelector('.cds--snippet-container > pre > code')?.classList.add('language-javascript');
-    hljs.highlightAll();
-  }, []);
-
-  return (
-    <div className="example-pages">
-      <h2>Code example</h2>
-      <CodeSnippet type="multi" feedback="Copied to clipboard" maxCollapsedNumberOfRows={25}>{window.setupDropAspera.toString()}</CodeSnippet>
-      <h2>Try it out</h2>
-      <Button onClick={() => window.setupDropAspera('#drop-zone')}>Setup Drag & drop</Button>
-      <div className="drop-zone" id="drop-zone">
-        Drag and drop files here
-      </div>
-    </div>
-  );
-};

package/example/src/Views/Home.tsx

@@ -1,10 +0,0 @@
-import './Views.scss';
-import readme from '../../../README.md?raw';
-import MarkdownIt from 'markdown-it';
-
-export default function Home() {
-  const converter = new MarkdownIt();
-  let htmlData = converter.render(readme);
-
-  return <div className="markdown-render" dangerouslySetInnerHTML={{__html: htmlData}} />;
-};

package/example/src/Views/Initialize.tsx

@@ -1,21 +0,0 @@
-import './Views.scss';
-import { Button, CodeSnippet } from '@carbon/react';
-import { useEffect } from 'react';
-import hljs from 'highlight.js';
-
-export default function Initialize() {
-  useEffect(() => {
-    document.querySelector('.cds--snippet-container > pre > code')?.classList.add('language-javascript');
-    hljs.highlightAll();
-  }, []);
-
-  return (
-    <div className="example-pages">
-      <h2>Code example</h2>
-      <CodeSnippet type="multi" feedback="Copied to clipboard" maxCollapsedNumberOfRows={25}>{window.initializeAspera.toString()}</CodeSnippet>
-      <h2>Try it out</h2>
-      <Button onClick={() => window.initializeAspera(false)}>Initialize SDK</Button>
-      <Button onClick={() => window.initializeAspera(true)}>Initialize SDK (multi user)</Button>
-    </div>
-  );
-};