npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

@zowe/zowe-explorer-api

v3.1.1

Published

Extensibility API for Zowe Explorer.

Downloads

4,860

Readme

Extensibility API for Zowe Explorer

version downloads

Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the Zowe Explorer VS Code extension with alternative z/OS interaction protocols and new capabilities.

The API is used by extenders of the Zowe Explorer VS Code extension, including the IBM z/OS FTP for Zowe Explorer and IBM CICS for Zowe Explorer VS Code extensions, as well as several commercial extensions.

The API is organized into modules that are exposed through the top-level index.ts file for convenient access.

  • /profiles: Provides access to common Zowe CLI profile management APIs, as well as abstractions for providing alternative z/OS interactions that use protocols other than z/OSMF, based on alternative Zowe CLI profile types.
  • /tree: Provides abstractions for accessing and extending the Zowe Explorer VS Code tree views.
  • /logger: Logs messages in a standard format, which is used by Zowe Explorer and will be consistent across Zowe components.

Profiles API

The /profiles module has no dependency to VS Code and could be used in Zowe CLI extensions as well as VS Code extensions. If you want to use it without pulling in dependencies to VS Code that are needed by the /tree module, you can import it like this:

import { ZoweExplorerApi } from "@zowe/zowe-explorer-api/lib/profiles";

The main API provided by the /profiles module is called ZoweExplorerApi. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts. The /profiles module itself contains Zowe Explorer's default implementation using z/OSMF in packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts

Zowe Explorer itself exports a IApiRegisterClient object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in packages/zowe-explorer-ftp-extension/src/extension.ts. To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's package.json must contain

"extensionDependencies": [
  "Zowe.vscode-extension-for-zowe"
]

Tree API

Importing from the /tree module requires that your NPM package has a dependency to VS Code as it performs

import * as vscode from "vscode";

imports.

See this documentation on Extending Zowe Explorer to learn more about the Tree APIs available.

Logger API

See this special extension document for more information about using the Logger API.

Providing feedback or help contributing

Extensibility API for Zowe Explorer is part of the Zowe Explorer monorepo on Github. You find the sources there in the /packages/zowe-explorer-api sub-folder.

To submit a bug report or enhancement request, open an issue in the Zowe Explorer repository.