Portal Community
Atlas Forms

Distributing Your Library

Action libraries can be distributed via npm (private registry or public), InstallHub (BizFirstGO's package distribution system), or MarketHub (the public marketplace). Each channel serves a different audience and access control model.

Distribution Channels

ChannelAudienceAccess ControlDiscovery
Private npm registryYour organisation onlynpm auth tokensInternal docs
Public npmAnyoneNonenpmjs.com search
InstallHubBizFirstGO tenantsTenant subscriptionInstallHub catalog
MarketHubPublic marketplacePer-package pricingMarketHub search + discovery

Build and Publish to npm

# Build TypeScript to dist/
npm run build

# Verify the package contents
npm pack --dry-run

# Publish to your private registry
npm publish --registry https://npm.myorg.com

# Or publish to public npm
npm publish --access public

Version Compatibility

Your library's peerDependencies declare which Atlas Forms version range you support. Follow semantic versioning:

{
  "peerDependencies": {
    "@atlas-forms/types-js": "^1.0.0",
    "@atlas-forms/control-registry-js": "^1.0.0"
  }
}
// ^1.0.0 means: compatible with any 1.x version (major version pinned)

When Atlas Forms releases a breaking change (major version bump), you must release a new major version of your library with updated peer dependencies and any handler changes needed.

Publishing to InstallHub

InstallHub is BizFirstGO's internal package distribution system. To publish:

  1. Create an InstallHub package definition (JSON manifest describing the package, its dependencies, and install actions)
  2. Bundle your npm package + the InstallHub manifest
  3. Submit to the InstallHub admin portal
  4. After review and approval, tenants can install via the InstallHub catalog

Publishing to MarketHub

MarketHub is the public marketplace for Atlas Forms extensions. Requirements:

← Action Scope Next: Testing Custom Actions →