FluidFramework/PACKAGES.md

27 KiB

Package Layers

These are the logical layers into which our packages are grouped. The dependencies between layers are enforced by the layer-check command.

Common-Definitions

Packages Layer Dependencies
- @fluidframework/gitresources  

Core-Interfaces

Packages Layer Dependencies
- @fluidframework/core-interfaces  

Protocol-Definitions

Packages Layer Dependencies
- @fluidframework/protocol-definitions  

Driver-Definitions

Packages Layer Dependencies
- @fluidframework/driver-definitions
- @fluidframework/odsp-driver-definitions
- Core-Interfaces
 

Container-Definitions

Packages Layer Dependencies
- @fluidframework/container-definitions
 
- Core-Interfaces
- Driver-Definitions

Common-Utils

Packages Layer Dependencies
- @fluidframework/common-utils  

Core-Utils

Packages Layer Dependencies
- @fluidframework/core-utils  

Client-Utils

Packages Layer Dependencies
- @fluid-internal/client-utils
 
- Core-Interfaces
- Core-Utils

Protocol-Utils

Packages Layer Dependencies
- @fluidframework/protocol-base
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils

Telemetry-Utils

Packages Layer Dependencies
- @fluidframework/telemetry-utils
 
 
 
- Core-Interfaces
- Driver-Definitions
- Core-Utils
- Client-Utils

Driver-Utils

Packages Layer Dependencies
- @fluidframework/driver-utils
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils

Other-Utils

Packages Layer Dependencies
- @fluidframework/odsp-doclib-utils
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils

Tool-Utils

Packages Layer Dependencies
- @fluidframework/tool-utils
 
 
 
- Driver-Definitions
- Core-Utils
- Driver-Utils
- Other-Utils

Driver

Packages Layer Dependencies
- @fluidframework/debugger
- @fluidframework/driver-base
- @fluidframework/driver-web-cache
- @fluidframework/file-driver
- @fluidframework/odsp-driver
- @fluidframework/odsp-urlresolver
- @fluidframework/replay-driver
- Core-Interfaces
- Driver-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils
- Other-Utils

Loader

Packages Layer Dependencies
- @fluidframework/container-loader
- @fluid-private/test-loader-utils
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils

Runtime

Packages Layer Dependencies
- @fluid-experimental/attributable-map
- @fluid-experimental/ot
- @fluid-experimental/sharejs-json1
- @fluid-experimental/sequence-deprecated
- @fluid-experimental/tree
- @fluidframework/cell
- @fluidframework/counter
- @fluid-experimental/ink
- @fluidframework/map
- @fluidframework/matrix
- @fluidframework/merge-tree
- @fluidframework/ordered-collection
- @fluid-experimental/pact-map
- @fluidframework/register-collection
- @fluidframework/sequence
- @fluidframework/shared-object-base
- @fluidframework/shared-summary-block
- @fluidframework/task-manager
- @fluidframework/tree
- @fluidframework/container-runtime
- @fluidframework/container-runtime-definitions
- @fluidframework/datastore
- @fluidframework/datastore-definitions
- @fluidframework/id-compressor
- @fluidframework/runtime-definitions
- @fluidframework/runtime-utils
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Framework

Packages Layer Dependencies
- @fluid-experimental/data-objects
- @fluidframework/fluid-static
- @fluid-experimental/property-changeset
- @fluid-experimental/property-common
- @fluid-internal/platform-dependent (private)
- @fluid-experimental/property-dds
- @fluid-experimental/property-properties
- @fluid-experimental/last-edited
- @fluid-experimental/tree-react-api
- @fluidframework/agent-scheduler
- @fluidframework/aqueduct
- @fluid-experimental/attributor
- @fluidframework/app-insights-logger
- @fluidframework/fluid-telemetry
- @fluid-experimental/data-object-base
- @fluid-experimental/dds-interceptions
- @fluid-experimental/oldest-client-observer
- @fluid-experimental/presence (private)
- @fluidframework/request-handler
- @fluidframework/synthesize
- @fluidframework/undo-redo
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Loader
- Runtime
 
 
 
 
 
 
 
 
 
 
 
 
 

Build

Packages Layer Dependencies
- @fluidframework/build-common
- @fluidframework/eslint-config-fluid
- @fluid-internal/eslint-plugin-fluid
- @fluid-tools/benchmark
 
 
 
 

AzureClient

Packages Layer Dependencies

UberPackage

Packages Layer Dependencies
- fluid-framework
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Loader
- Runtime
- Framework

Azure-Service-Utils

Packages Layer Dependencies
- @fluidframework/azure-service-utils - Driver-Definitions

Server-Shared-Utils

Packages Layer Dependencies
- @fluidframework/server-services-client
 
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Protocol-Utils

Server-Libs

Packages Layer Dependencies
- @fluidframework/server-kafka-orderer
- @fluidframework/server-lambdas
- @fluidframework/server-lambdas-driver
- @fluidframework/server-local-server
- @fluidframework/server-memory-orderer
- @fluidframework/server-routerlicious-base
- @fluidframework/server-services
- @fluidframework/server-services-core
- @fluidframework/server-services-ordering-kafkanode
- @fluidframework/server-services-ordering-rdkafka
- @fluidframework/server-services-ordering-zookeeper
- @fluidframework/server-services-shared
- @fluidframework/server-services-telemetry
- @fluidframework/server-services-utils
- @fluidframework/server-test-utils
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Protocol-Utils
- Server-Shared-Utils
 
 
 
 
 
 
 
 
 
 

Server-Tools

Packages Layer Dependencies
- tinylicious
 
 
 
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Protocol-Utils
- Server-Shared-Utils
- Server-Libs

Azure-Service

Packages Layer Dependencies
- @fluidframework/azure-local-service - Server-Tools

GitRest

Packages Layer Dependencies
- @fluidframework/gitrest
- @fluidframework/gitrest-base
 
 
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Protocol-Utils
- Server-Shared-Utils
- Server-Libs

Historian

Packages Layer Dependencies
- @fluidframework/historian
- @fluidframework/historian-base
 
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Server-Shared-Utils
- Server-Libs

Routerlicious-Driver

Packages Layer Dependencies
- @fluidframework/routerlicious-driver
- @fluidframework/routerlicious-urlresolver
- @fluidframework/tinylicious-driver
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils
- Driver
- Server-Shared-Utils

Test-Utils

Packages Layer Dependencies
- @fluid-private/stochastic-test-utils
- @fluid-private/test-dds-utils
- @fluidframework/local-driver
- @fluid-private/test-drivers
- @fluid-internal/test-driver-definitions
- @fluid-private/test-pairwise-generator
- @fluidframework/test-runtime-utils
 
 
 
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Protocol-Utils
- Telemetry-Utils
- Driver-Utils
- Other-Utils
- Tool-Utils
- Driver
- Runtime
- Server-Shared-Utils
- Server-Libs
- Routerlicious-Driver

ServiceClients

Packages Layer Dependencies
- @fluidframework/azure-client
- @fluidframework/odsp-client
- @fluidframework/tinylicious-client
 
 
 
 
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Telemetry-Utils
- Driver-Utils
- Other-Utils
- Driver
- Loader
- Runtime
- Framework
- Routerlicious-Driver

Examples

Packages Layer Dependencies
- @fluid-example/attributable-map (private)
- @fluid-example/collaborative-textarea (private)
- @fluid-example/contact-collection (private)
- @fluid-example/data-object-grid (private)
- @fluid-example/presence-tracker (private)
- @fluid-example/task-selection (private)
- @fluid-example/tree-comparison (private)
- @fluid-example/bubblebench-baseline (private)
- @fluid-example/bubblebench-common (private)
- @fluid-example/bubblebench-experimental-tree (private)
- @fluid-example/bubblebench-ot (private)
- @fluid-example/bubblebench-shared-tree (private)
- @fluid-example/odspsnapshotfetch-perftestapp (private)
- @fluid-internal/tablebench (private)
- @fluid-example/app-insights-logger (private)
- @fluid-example/canvas (private)
- @fluid-example/clicker (private)
- @fluid-example/codemirror (private)
- @fluid-example/diceroller (private)
- @fluid-example/inventory-app (private)
- @fluid-example/monaco (private)
- @fluid-example/multiview-constellation-model (private)
- @fluid-example/multiview-constellation-view (private)
- @fluid-example/multiview-container (private)
- @fluid-example/multiview-coordinate-model (private)
- @fluid-example/multiview-coordinate-interface (private)
- @fluid-example/multiview-plot-coordinate-view (private)
- @fluid-example/multiview-slider-coordinate-view (private)
- @fluid-example/multiview-triangle-view (private)
- @fluid-example/prosemirror (private)
- @fluid-example/smde (private)
- @fluid-example/table-document
- @fluid-example/todo (private)
- @fluid-example/webflow (private)
- @fluid-example/app-integration-external-data (private)
- @fluid-example/shared-tree-demo (private)
- @fluid-example/bundle-size-tests (private)
- @fluid-example/example-utils (private)
- @fluid-example/migration-tools (private)
- @fluid-example/webpack-fluid-loader (private)
- @fluid-example/app-integration-live-schema-upgrade (private)
- @fluid-example/version-migration-same-container (private)
- @fluid-example/version-migration-separate-container (private)
- @fluid-example/tree-shim (private)
- @fluid-example/app-integration-container-views (private)
- @fluid-example/app-integration-external-views (private)
- @fluid-example/view-framework-sampler (private)
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils
- Other-Utils
- Tool-Utils
- Driver
- Loader
- Runtime
- Framework
- UberPackage
- Server-Libs
- Routerlicious-Driver
- Test-Utils
- ServiceClients
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Tools

Packages Layer Dependencies
- @fluid-private/changelog-generator-wrapper (private)
- @fluidframework/devtools
- @fluid-internal/devtools-browser-extension (private)
- @fluidframework/devtools-core
- @fluid-example/devtools-example (private)
- @fluid-internal/devtools-view (private)
- @fluid-tools/fetch-tool
- @fluidframework/fluid-runner
- @fluid-internal/replay-tool (private)
- @fluid-tools/markdown-magic (private)
- @fluid-tools/build-cli
- @fluidframework/build-tools
- @fluidframework/bundle-size-tools
- @fluid-tools/version-tools
- @fluid-tools/api-markdown-documenter
- @fluid-internal/getkeys (private)
- @fluidframework/test-tools
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Other-Utils
- Tool-Utils
- Driver
- Loader
- Runtime
- Framework
- Routerlicious-Driver
- Test-Utils
- Examples
 
 

Tests

Packages Layer Dependencies
- @fluid-experimental/azure-scenario-runner
- @fluidframework/azure-end-to-end-tests
- @fluid-experimental/odsp-end-to-end-tests
- @fluid-internal/functional-tests (private)
- @fluid-internal/local-server-tests (private)
- @fluid-internal/mocha-test-setup
- @fluid-internal/test-snapshots (private)
- @fluid-private/test-end-to-end-tests
- @fluid-internal/test-service-load
- @fluidframework/test-utils
- @fluid-private/test-version-utils
- @types/jest-environment-puppeteer (private)
 
 
 
 
 
 
 
 
- Core-Interfaces
- Driver-Definitions
- Container-Definitions
- Core-Utils
- Client-Utils
- Telemetry-Utils
- Driver-Utils
- Other-Utils
- Tool-Utils
- Driver
- Loader
- Runtime
- Framework
- Build
- Server-Libs
- Server-Tools
- Routerlicious-Driver
- Test-Utils
- ServiceClients
- Tools

Azure-Examples

Packages Layer Dependencies
- @fluid-example/app-integration-external-controller (private)
 
 
 
 
- Telemetry-Utils
- Runtime
- UberPackage
- Routerlicious-Driver
- ServiceClients

Routerlicious-Server

Packages Layer Dependencies
- @fluidframework/server-routerlicious
 
 
 
 
- Common-Definitions
- Protocol-Definitions
- Common-Utils
- Server-Shared-Utils
- Server-Libs