Skip to main content

Dependencies

Shop Minis must only use approved dependencies. Only the packages listed on this page are allowed. Submissions with unapproved dependencies will be automatically rejected.

Anchor to Required dependenciesRequired dependencies

The following dependencies are required for your Mini to work. They will be installed automatically when you create your Mini.

Anchor to Optional dependenciesOptional dependencies

The following dependencies have been approved for use in Minis. Use the install command to add them to your Mini.

Running the install --check command will validate that your Mini only uses approved dependencies. You can use install --fix to fix any issues automatically.

Unapproved dependencies will cause automatic rejection

Your Mini will be automatically rejected if it includes any dependencies not listed above. This includes private npm packages (which are never allowed), dependencies vendored into your source code, and any modifications to approved dependencies. Only use the exact versions of approved dependencies listed on this page.

CommandLearn more about the install command

Anchor to Requesting optional dependenciesRequesting optional dependencies

If you need a dependency that's not on the list, request it as early as possible. The approval process takes days to weeks, and there is no guarantee of approval. We can only approve Minis that use allowed dependencies.

To request a new dependency, file an issue in the Shop Minis GitHub repository.

Caution

Shop Minis should be built specifically for the Shop platform, not ported from existing applications.

Anchor to Why a dependency request might be rejectedWhy a dependency request might be rejected

Dependency requests could be rejected for:

  • Excessive dependencies: Requesting many dependencies (10+)
  • Private packages: Private npm packages are never allowed
  • Security vulnerabilities: Dependencies with known security issues or poor security track records
  • Large bundle size: Dependencies that significantly increase the Mini's size without sufficient benefit
  • Maintenance concerns: Unmaintained or deprecated packages with no active development
  • Functionality overlap: Dependencies that duplicate functionality already available in approved packages or the Shop Minis SDK
  • Paid dependencies: Dependencies that require paid subscriptions or are closely tied to paid third-party platforms. We strongly prefer widely-adopted open source alternatives
Tip

Before requesting a dependency, check the closed issues to see if it has been previously rejected and consider whether an approved alternative exists.

Was this page helpful?