Skip to main content

NPM Package Management

Burdenoff maintains 196 npm packages under the @burdenoff organization scope. These packages are segregated into private and public based on their development stage and intended usage.

Package Visibility Policy

Private Packages (101 packages)

Private packages are intended for internal use only and require authentication to install.

Criteria for Private Packages

  1. Alpha/Beta Packages: All packages with the @burdenoff/alpha- prefix
  2. Internal SDKs:
    • @burdenoff/fe-sdk - Internal frontend SDK
  3. Development Tools:
    • @burdenoff/be-ts-lint - Backend TypeScript linting configuration
    • @burdenoff/boiler-cli - Internal boilerplate CLI

Public Packages (95 packages)

Public packages are stable, production-ready packages available to the community without authentication.

Criteria for Public Packages

All packages without the alpha- prefix and not explicitly marked as private are public. This includes:

  • Stable CLI tools (@burdenoff/[product]-cli)
  • Stable MCP servers (@burdenoff/[product]-mcp)
  • Stable SDKs (@burdenoff/[product]-sdk)
  • Stable Node.js SDKs (@burdenoff/[product]-sdk-node)

Package Categories

CLI Packages

Command-line interfaces for interacting with Burdenoff products.

Private (Alpha):

  • @burdenoff/alpha-artistrybase-cli
  • @burdenoff/alpha-assethandler-cli
  • @burdenoff/alpha-bigconsole-cli
  • @burdenoff/alpha-botlit-cli
  • @burdenoff/alpha-brainyrich-cli
  • @burdenoff/alpha-buildmyiq-cli
  • @burdenoff/alpha-collabkin-cli
  • @burdenoff/alpha-comradecircle-cli
  • @burdenoff/alpha-cosmicintersection-cli
  • @burdenoff/alpha-crewfoundry-cli
  • @burdenoff/alpha-ecoimpacthub-cli
  • @burdenoff/alpha-eventfullymanaged-cli
  • @burdenoff/alpha-ggnomad-cli
  • @burdenoff/alpha-govcitizenhub-cli
  • @burdenoff/alpha-headshotmarketing-cli
  • @burdenoff/alpha-healthybowl-cli
  • @burdenoff/alpha-housingvista-cli
  • @burdenoff/alpha-intelwatchtower-cli
  • @burdenoff/alpha-kadaikodi-cli
  • @burdenoff/alpha-manufacturedops-cli
  • @burdenoff/alpha-movethewheels-cli
  • @burdenoff/alpha-mybodyshield-cli
  • @burdenoff/alpha-planmagnet-cli
  • @burdenoff/alpha-proserviceworld-cli
  • @burdenoff/alpha-semanticfed-cli
  • @burdenoff/alpha-technospam-cli
  • @burdenoff/alpha-theculturepost-cli
  • @burdenoff/alpha-theglobalfuel-cli
  • @burdenoff/alpha-timecampus-cli
  • @burdenoff/alpha-workspaces-cli

Public (Stable):

  • @burdenoff/artistrybase-cli
  • @burdenoff/assethandler-cli
  • @burdenoff/bigconsole-cli
  • @burdenoff/botlit-cli
  • @burdenoff/brainyrich-cli
  • @burdenoff/buildmyiq-cli
  • @burdenoff/collabkin-cli
  • @burdenoff/comradecircle-cli
  • @burdenoff/cosmicintersection-cli
  • @burdenoff/crewfoundry-cli
  • @burdenoff/ecoimpacthub-cli
  • @burdenoff/eventfullymanaged-cli
  • @burdenoff/ggnomad-cli
  • @burdenoff/govcitizenhub-cli
  • @burdenoff/headshotmarketing-cli
  • @burdenoff/healthybowl-cli
  • @burdenoff/housingvista-cli
  • @burdenoff/intelwatchtower-cli
  • @burdenoff/kadaikodi-cli
  • @burdenoff/manufacturedops-cli
  • @burdenoff/movethewheels-cli
  • @burdenoff/mybodyshield-cli
  • @burdenoff/planmagnet-cli
  • @burdenoff/proserviceworld-cli
  • @burdenoff/semanticfed-cli
  • @burdenoff/technospam-cli
  • @burdenoff/theculturepost-cli
  • @burdenoff/theglobalfuel-cli
  • @burdenoff/timecampus-cli
  • @burdenoff/workspaces-cli

MCP Server Packages

Model Context Protocol servers for AI integrations.

Private (Alpha):

  • @burdenoff/alpha-artistrybase-mcp
  • @burdenoff/alpha-assethandler-mcp
  • @burdenoff/alpha-bigconsole-mcp
  • @burdenoff/alpha-botlit-mcp
  • @burdenoff/alpha-brainyrich-mcp
  • @burdenoff/alpha-buildmyiq-mcp
  • @burdenoff/alpha-collabkin-mcp
  • @burdenoff/alpha-comradecircle-mcp
  • @burdenoff/alpha-cosmicintersection-mcp
  • @burdenoff/alpha-crewfoundry-mcp
  • @burdenoff/alpha-ecoimpacthub-mcp
  • @burdenoff/alpha-eventfullymanaged-mcp
  • @burdenoff/alpha-fluidgrids-mcp
  • @burdenoff/alpha-ggnomad-mcp
  • @burdenoff/alpha-govcitizenhub-mcp
  • @burdenoff/alpha-headshotmarketing-mcp
  • @burdenoff/alpha-healthybowl-mcp
  • @burdenoff/alpha-housingvista-mcp
  • @burdenoff/alpha-intelwatchtower-mcp
  • @burdenoff/alpha-kadaikodi-mcp
  • @burdenoff/alpha-manufacturedops-mcp
  • @burdenoff/alpha-movethewheels-mcp
  • @burdenoff/alpha-mybodyshield-mcp
  • @burdenoff/alpha-planmagnet-mcp
  • @burdenoff/alpha-proserviceworld-mcp
  • @burdenoff/alpha-semanticfed-mcp
  • @burdenoff/alpha-technospam-mcp
  • @burdenoff/alpha-theculturepost-mcp
  • @burdenoff/alpha-theglobalfuel-mcp
  • @burdenoff/alpha-timecampus-mcp
  • @burdenoff/alpha-vibecontrols-mcp
  • @burdenoff/alpha-workspaces-mcp

Public (Stable):

  • @burdenoff/artistrybase-mcp
  • @burdenoff/assethandler-mcp
  • @burdenoff/bigconsole-mcp
  • @burdenoff/botlit-mcp
  • @burdenoff/brainyrich-mcp
  • @burdenoff/buildmyiq-mcp
  • @burdenoff/collabkin-mcp
  • @burdenoff/comradecircle-mcp
  • @burdenoff/cosmicintersection-mcp
  • @burdenoff/crewfoundry-mcp
  • @burdenoff/ecoimpacthub-mcp
  • @burdenoff/eventfullymanaged-mcp
  • @burdenoff/fluidgrids-mcp
  • @burdenoff/ggnomad-mcp
  • @burdenoff/govcitizenhub-mcp
  • @burdenoff/headshotmarketing-mcp
  • @burdenoff/healthybowl-mcp
  • @burdenoff/housingvista-mcp
  • @burdenoff/intelwatchtower-mcp
  • @burdenoff/kadaikodi-mcp
  • @burdenoff/manufacturedops-mcp
  • @burdenoff/movethewheels-mcp
  • @burdenoff/mybodyshield-mcp
  • @burdenoff/planmagnet-mcp
  • @burdenoff/proserviceworld-mcp
  • @burdenoff/semanticfed-mcp
  • @burdenoff/technospam-mcp
  • @burdenoff/theculturepost-mcp
  • @burdenoff/theglobalfuel-mcp
  • @burdenoff/timecampus-mcp
  • @burdenoff/vibecontrols-mcp
  • @burdenoff/workspaces-mcp

SDK Packages

Software Development Kits for product integration.

Private (Alpha):

  • @burdenoff/alpha-artistrybase-sdk
  • @burdenoff/alpha-assethandler-sdk
  • @burdenoff/alpha-bigconsole-sdk
  • @burdenoff/alpha-botlit-sdk
  • @burdenoff/alpha-brainyrich-sdk
  • @burdenoff/alpha-buildmyiq-sdk-node
  • @burdenoff/alpha-collabkin-sdk
  • @burdenoff/alpha-comradecircle-sdk-node
  • @burdenoff/alpha-cosmicintersection-sdk
  • @burdenoff/alpha-crewfoundry-sdk
  • @burdenoff/alpha-ecoimpacthub-sdk-node
  • @burdenoff/alpha-eventfullymanaged-sdk
  • @burdenoff/alpha-fe-sdk (Frontend SDK - Alpha)
  • @burdenoff/alpha-fluidgrids-sdk
  • @burdenoff/alpha-fluidgrids-sdk-node
  • @burdenoff/alpha-ggnomad-sdk
  • @burdenoff/alpha-govcitizenhub-sdk-node
  • @burdenoff/alpha-headshotmarketing-sdk
  • @burdenoff/alpha-healthybowl-sdk
  • @burdenoff/alpha-housingvista-sdk
  • @burdenoff/alpha-intelwatchtower-sdk-node
  • @burdenoff/alpha-kadaikodi-sdk
  • @burdenoff/alpha-manufacturedops-sdk
  • @burdenoff/alpha-movethewheels-sdk
  • @burdenoff/alpha-mybodyshield-sdk-node
  • @burdenoff/alpha-planmagnet-sdk
  • @burdenoff/alpha-proserviceworld-sdk
  • @burdenoff/alpha-semanticfed-sdk
  • @burdenoff/alpha-semanticfed-sdk-node
  • @burdenoff/alpha-technospam-sdk
  • @burdenoff/alpha-theculturepost-sdk-node
  • @burdenoff/alpha-theglobalfuel-sdk
  • @burdenoff/alpha-timecampus-sdk
  • @burdenoff/alpha-timecampus-sdk-node
  • @burdenoff/alpha-workspaces-sdk

Public (Stable):

  • @burdenoff/artistrybase-sdk
  • @burdenoff/assethandler-sdk
  • @burdenoff/bigconsole-sdk
  • @burdenoff/botlit-sdk
  • @burdenoff/brainyrich-sdk
  • @burdenoff/buildmyiq-sdk
  • @burdenoff/collabkin-sdk
  • @burdenoff/comradecircle-sdk
  • @burdenoff/cosmicintersection-sdk
  • @burdenoff/crewfoundry-sdk
  • @burdenoff/ecoimpacthub-sdk
  • @burdenoff/eventfullymanaged-sdk
  • @burdenoff/fluidgrids-sdk
  • @burdenoff/fluidgrids-sdk-node
  • @burdenoff/ggnomad-sdk
  • @burdenoff/govcitizenhub-sdk
  • @burdenoff/headshotmarketing-sdk
  • @burdenoff/healthybowl-sdk
  • @burdenoff/housingvista-sdk
  • @burdenoff/intelwatchtower-sdk
  • @burdenoff/kadaikodi-sdk
  • @burdenoff/manufacturedops-sdk
  • @burdenoff/movethewheels-sdk
  • @burdenoff/mybodyshield-sdk
  • @burdenoff/planmagnet-sdk
  • @burdenoff/proserviceworld-sdk
  • @burdenoff/semanticfed-sdk
  • @burdenoff/technospam-sdk
  • @burdenoff/theculturepost-sdk
  • @burdenoff/theglobalfuel-sdk
  • @burdenoff/timecampus-sdk
  • @burdenoff/timecampus-sdk-node
  • @burdenoff/workspaces-sdk

Development Tools

Private:

  • @burdenoff/be-ts-lint - Backend TypeScript linting configuration
  • @burdenoff/boiler-cli - Boilerplate generation CLI
  • @burdenoff/alpha-boiler-cli - Alpha version of boilerplate CLI
  • @burdenoff/fe-sdk - Frontend SDK (stable but private)

Installation

Public Packages

Install public packages directly:

npm install @burdenoff/[package-name]

Private Packages

Private packages require authentication:

  1. Set up NPM authentication:
npm login
# Or use an auth token
npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
  1. Install the package:
npm install @burdenoff/[package-name]

Publishing Guidelines

Before Publishing

  1. Version Bump: Follow Semantic Versioning

    npm version [major|minor|patch]
  2. Build: Ensure the package builds successfully

    npm run build
  3. Test: Run all tests

    npm test

Publishing

Private Packages

npm publish --access restricted

Public Packages

npm publish --access public

Automation

Publishing is automated via GitHub Actions CI/CD pipelines for most packages.

Managing Package Visibility

To change a package's visibility:

# Make a package private
npm access restricted @burdenoff/[package-name]

# Make a package public
npm access public @burdenoff/[package-name]

Bulk Visibility Management

Use the provided scripts in /Users/vignesh/official/algoshred/products/scripts/:

# Analyze current package visibility
./analyze-npm-package-visibility.sh

# Update package visibility based on policy
./update-npm-package-visibility.sh

Package Statistics

  • Total Packages: 196
  • Private Packages: 101 (51.5%)
  • Public Packages: 95 (48.5%)

Breakdown by Type

  • CLI Packages: 60 (30 alpha + 30 stable)
  • MCP Servers: 64 (32 alpha + 32 stable)
  • SDK Packages: 68 (35 alpha + 33 stable)
  • Development Tools: 4 (all private)

Access Control

NPM Token

The NPM access token for publishing is:

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

Security Note: This token is stored in:

  • GitHub Secrets (for CI/CD)
  • Local .npmrc files (for manual publishing)

Team Access

NPM organization access is managed through:

  • npm.com/org/@burdenoff
  • Team members have appropriate read/write permissions

Migration Path

Alpha to Stable

When an alpha package is ready for stable release:

  1. Create stable package:

    # Copy package content
    cp -r alpha-[product]-[type] [product]-[type]

    # Update package.json
    # Change name from @burdenoff/alpha-[product]-[type] to @burdenoff/[product]-[type]
  2. Publish as public:

    cd [product]-[type]
    npm publish --access public
  3. Update documentation:

    • Add to public packages list
    • Update README and guides
    • Announce to community
  4. Deprecate alpha (optional):

    npm deprecate @burdenoff/alpha-[product]-[type] "Use @burdenoff/[product]-[type] instead"

Best Practices

  1. Never expose sensitive data in public packages
  2. Test thoroughly before publishing
  3. Document breaking changes in CHANGELOG.md
  4. Use semantic versioning consistently
  5. Keep dependencies updated and secure
  6. Include TypeScript types for better DX
  7. Provide usage examples in README
  8. Tag releases in Git for traceability