Skip to content

npm package scopes

Tyler Butler edited this page May 12, 2021 · 6 revisions

npm package scopes

@fluidframework

Packages that are part of the platform itself, including platform DDSes, protocol definitions, shared interfaces, as well as reference implementations of components of the system (e.g. Routerlicious). This is the "default" scope for packages in the FluidFramework repo. All packages in this scope are currently in a preview state, indicated by their pre-1.0 version number.

@fluid-internal

Packages that are only used internally within the Fluid Framework repo, such as test tools. Note: these packages should be private and not published, but if they're published to a public registry it's OK.

@fluid-experimental

Packages that are experimental and should not be used in critical scenarios. We use this scope when we're not sure if a package should be included in the platform SDK. Some platform packages will start in this scope and be renamed and published under the @fluidframework scope once the package is no longer considered experimental.

Unscoped packages

fluid-framework

This is a package that re-exports the official "public API" for GA. Everything exposed through this package should also be exposed in an @fluidframework package.

tinylicious

This is the server version of the tinylicious package. Installed/run via npx tinylicious.

Clone this wiki locally