ibm-streams/src/views/streamsExplorer/helpfulResourcesView/provider.ts

IBM Streams Support for Visual Studio Code

import {
  TreeDataProvider,
  TreeItem,
  TreeItemCollapsibleState,
  Uri
} from 'vscode';
import { BuiltInCommands } from '../../../utils';

const resourceLinks = {
  'Getting started': {
    'Using the IBM Streams extension for Visual Studio Code':
      'http://ibmstreams.github.io/streamsx.documentation/docs/spl/quick-start/qs-1b/',
    'IBM Streams extension documentation':
      'https://ibmstreams.github.io/vscode-ide',
    'New to IBM Streams': 'https://developer.ibm.com/streamsdev/new-to-streams',
    Tutorials: 'https://ibmstreams.github.io/tutorials',
    Toolkits: {
      'Product toolkits':
        'https://www.ibm.com/support/knowledgecenter/en/SSCRJU_5.3/com.ibm.streams.toolkits.doc/toolkits/dita/toolkits/toolkits.html',
      'Public toolkits':
        'https://github.com/search?q=topic%3Atoolkit+org%3AIBMStreams&type=Repositories'
    },
    Samples: {
      'Samples catalog': 'https://ibmstreams.github.io/samples',
      'Sample Python notebooks':
        'https://github.com/IBMStreams/sample.starter_notebooks'
    }
  },
  'Product documentation': {
    'Documentation homepage':
      'http://ibmstreams.github.io/streamsx.documentation/index.html',
    'IBM Streams documentation in IBM Knowledge Center':
      'https://www.ibm.com/support/knowledgecenter/SSCRJU/SSCRJU_welcome.html',
    'IBM Streams in IBM Cloud Pak for Data':
      'https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/svc-welcome/streams.html',
    'IBM Streaming Analytics on IBM Cloud':
      'https://cloud.ibm.com/docs/StreamingAnalytics?topic=StreamingAnalytics-starterapps_deploy',
    'SPL toolkit API':
      'http://ibmstreams.github.io/streamsx.topology/doc/spldoc/html/index.html',
    'Python application API':
      'https://streamsxtopology.readthedocs.io/en/stable/index.html',
    'Java application API':
      'http://ibmstreams.github.io/streamsx.topology/doc/javadoc/index.html'
  },
  Support: {
    'Support forum':
      'https://www.ibm.com/mysupport/s/forumsproduct?language=en_US&name=Streams&id=0TO50000000IQN0GAO',
    'Stack Overflow': 'https://stackoverflow.com/questions/tagged/ibm-streams'
  },
  'Join the community': {
    'Developer community': 'http://ibm.biz/streams-community',
    'IBM Streams on GitHub': 'https://ibmstreams.github.io',
    'Follow us on Twitter': 'https://twitter.com/hashtag/IBMStreams?src=hash'
  }
};

/**
 * Tree item that represents a helpful resource
 */
interface HelpfulResourceTreeItem {
  label: string;
  url?: string;
  children?: HelpfulResourceTreeItem[] | null;
}

/**
 * A tree data provider that provides helpful resource data
 */
export default class HelpfulResourcesProvider
  implements TreeDataProvider<HelpfulResourceTreeItem> {
  public getChildren(
    element?: HelpfulResourceTreeItem
  ): HelpfulResourceTreeItem[] {
    return element ? element.children : this._createTreeItems(resourceLinks);
  }

  public getTreeItem(element: HelpfulResourceTreeItem): TreeItem {
    const { label, url, children } = element;
    let collapsibleState: TreeItemCollapsibleState;
    if (label === Object.keys(resourceLinks)[0]) {
      collapsibleState = TreeItemCollapsibleState.Expanded;
    } else {
      collapsibleState = children
        ? TreeItemCollapsibleState.Collapsed
        : TreeItemCollapsibleState.None;
    }
    return {
      label,
      collapsibleState,
      command: url
        ? {
            title: '',
            command: BuiltInCommands.Open,
            arguments: [Uri.parse(url)]
          }
        : null
    };
  }

  /**
   * Creates tree items from input data
   * @param data the data
   */
  private _createTreeItems(data: any): HelpfulResourceTreeItem[] {
    return Object.keys(data).map((label): any => {
      const value = data[label];
      return typeof value === 'string'
        ? {
            label,
            url: value
          }
        : {
            label,
            children: this._createTreeItems(value)
          };
    });
  }
}