Get Package

npm.get_package
ActionBusiness appsconnection required

Calls the npm Registry API with the connection's credentials.

Read a package's metadata, its dist-tags and its published versions.

Connection

Required
Yes — the node will not save without one
Auth type
Bearer token
Providers
npm Registry
Secret shape
optional — the npm token, or {"api_token": "…"}; reads need none
Config it needs
base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
package
The package name, scope included — the slash in a scoped name is escaped for you.
stringYes——express

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "package": "express"
}

Output

One shape.

result

FieldTypeExample
name
The package name.
string—
description
The package description.
string—
dist_tags
Every dist-tag and the version it points at.
object—
latest
The version the 'latest' dist-tag points at.
string—
versions
Every published version, as version strings.
array—
version_count
How many versions have been published.
number—
created
When the package was first published.
string—
modified
When the package was last published to.
string—
license
The package's licence identifier.
string—
homepage
The package's homepage.
string—
keywords
The package's keywords.
array—
maintainers
The package's maintainers.
array—
repository
Where the source lives.
object—
bugs
Where to report bugs.
object—
time
Publish timestamp per version, plus created/modified.
object—
{
  "bugs": {},
  "created": "",
  "description": "",
  "dist_tags": {},
  "homepage": "",
  "keywords": [],
  "latest": "",
  "license": "",
  "maintainers": [],
  "modified": "",
  "name": "",
  "repository": {},
  "time": {},
  "version_count": 0,
  "versions": []
}

Notes

  • The per-version manifests are left out: a mature package's raw document is megabytes. Use npm.get_version for one version's manifest.

See Get Package run in a workflow.

In a technical demo we add the npm Registry connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.