@fluidframework/container-runtime-definitions
Advanced tools
@fluidframework/container-runtime-definitions - npm Package Compare versions
+4
-15
| # @fluidframework/container-runtime-definitions | ||
| ## 2.72.0 | ||
| Dependency updates only. | ||
| ## 2.71.0 | ||
@@ -100,3 +104,2 @@ | ||
| These changes were originally announced in version 0.25.0. See the following issues for more details: | ||
| - [#1537](https://github.com/microsoft/FluidFramework/issues/1537) | ||
@@ -130,3 +133,2 @@ - [#2931](https://github.com/microsoft/FluidFramework/pull/2931) | ||
| #### Alternatives | ||
| - Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)` | ||
@@ -172,3 +174,2 @@ - Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect use `IContainer.disconnect`. | ||
| Marks the following types which were reachable from it as alpha: | ||
| - IConnectionDetails | ||
@@ -197,3 +198,2 @@ - IDeltaSender | ||
| This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json: | ||
| - `"moduleResolution": "Node16"` with `"module": "Node16"` | ||
@@ -217,3 +217,2 @@ - `"moduleResolution": "Bundler"` with `"module": "ESNext"` | ||
| ### Key changes | ||
| 1. A new API IContainerRuntimeBase.generateDocumentUniqueId() is exposed. This API will opportunistically generate IDs in short format (non-negative numbers). If it can't achieve that, it will return UUID strings. UUIDs generated will have low entropy in groups and will compress well. It can be leveraged anywhere in container where container unique IDs are required. I.e. any place that uses uuid() and stores data in container is likely candidate to start leveraging this API. | ||
@@ -224,11 +223,8 @@ 2. Data store internal IDs (IDs that are auto generated by FF system) will opportunistically be generated in shorter form. Data stores created in detached container will always have short IDs, data stores created in attached container will opportunistically be short (by using newly added IContainerRuntimeBase.generateDocumentUniqueId() capability) | ||
| ### Implementation details | ||
| 1. Container level ID Compressor can now be enabled with delay. With such setting, only new IContainerRuntimeBase.generateDocumentUniqueId() is exposed (ID Compressor is not exposed in such case, as leveraging any of its other capabilities requires future container sessions to load ID Compressor on container load, for correctness reasons). Once Container establishes connection and any changes are made in container, newly added API will start generating more compact IDs (in most cases). | ||
| ### Breaking changes | ||
| 1. DDS names can no longer start with "\_" symbol - this is reserved for FF needs. I've validated that's not an issue for AzureClient (it only creates root object by name, everything else is referred by handle). Our main internal partners almost never use named DDSs (I can find only 4 instances in Loop). | ||
| ### Backward compatibility considerations | ||
| 1. Data store internal IDs could collide with earlier used names data stores. Earlier versions of FF framework (before DataStore aliasing feature was added) allowed customers to supply IDs for data stores. And thus, files created with earlier versions of framework could have data store IDs that will be similar to names FF will use for newly created data stores ("A", ... "Z", "a"..."z", "AA", etc.). While such collision is possible, it's very unlikely (almost impossible) if user-provided names were at least 4-5 characters long. | ||
@@ -238,3 +234,2 @@ 2. If application runs to these problems, or wants to reduce risks, consider disabling ID compressor via IContainerRuntimeOptions.enableRuntimeIdCompressor = "off". | ||
| ### Minor changes | ||
| 1. IContainerRuntime.createDetachedRootDataStore() is removed. Please use IContainerRuntime.createDetachedDataStore and IDataStore.trySetAlias() instead | ||
@@ -258,3 +253,2 @@ 2. IContainerRuntimeOptions.enableRuntimeIdCompressor has been changes from boolean to tri-state. | ||
| The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0) | ||
| - @fluidframework/gitresources | ||
@@ -328,3 +322,2 @@ - @fluidframework/server-kafka-orderer | ||
| This included the following changes from the protocol-definitions release: | ||
| - Updating signal interfaces for some planned improvements. The intention is split the interface between signals | ||
@@ -344,3 +337,2 @@ submitted by clients to the server and the resulting signals sent from the server to clients. | ||
| The `resolveHandle(...)` and `get IFluidHandleContext()` methods have been deprecated on the following interfaces: | ||
| - `IContainerRuntime` | ||
@@ -356,3 +348,2 @@ - `IContainerRuntimeBase` | ||
| Dependencies on the following Fluid server package have been updated to version 2.0.1: | ||
| - @fluidframework/gitresources: 2.0.1 | ||
@@ -403,3 +394,2 @@ - @fluidframework/server-kafka-orderer: 2.0.1 | ||
| imported from the **@fluidframework/core-interfaces** package: | ||
| - interface IDisposable | ||
@@ -469,3 +459,2 @@ - interface IErrorEvent | ||
| - The following functions and classes were deprecated in previous releases and have been removed: [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2) | ||
| - `PureDataObject.getFluidObjectFromDirectory` | ||
@@ -472,0 +461,0 @@ - `IProvideContainerRuntime` and its `IContainerRuntime` member. |
+10
-10
| { | ||
| "name": "@fluidframework/container-runtime-definitions", | ||
| "version": "2.71.0", | ||
| "version": "2.72.0", | ||
| "description": "Fluid Runtime definitions", | ||
@@ -44,7 +44,7 @@ "homepage": "https://fluidframework.com", | ||
| "dependencies": { | ||
| "@fluid-internal/client-utils": "~2.71.0", | ||
| "@fluidframework/container-definitions": "~2.71.0", | ||
| "@fluidframework/core-interfaces": "~2.71.0", | ||
| "@fluidframework/driver-definitions": "~2.71.0", | ||
| "@fluidframework/runtime-definitions": "~2.71.0" | ||
| "@fluid-internal/client-utils": "~2.72.0", | ||
| "@fluidframework/container-definitions": "~2.72.0", | ||
| "@fluidframework/core-interfaces": "~2.72.0", | ||
| "@fluidframework/driver-definitions": "~2.72.0", | ||
| "@fluidframework/runtime-definitions": "~2.72.0" | ||
| }, | ||
@@ -54,7 +54,7 @@ "devDependencies": { | ||
| "@biomejs/biome": "~1.9.3", | ||
| "@fluid-tools/build-cli": "^0.58.3", | ||
| "@fluid-tools/build-cli": "^0.60.0", | ||
| "@fluidframework/build-common": "^2.0.3", | ||
| "@fluidframework/build-tools": "^0.58.3", | ||
| "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.70.0", | ||
| "@fluidframework/eslint-config-fluid": "^7.0.0", | ||
| "@fluidframework/build-tools": "^0.60.0", | ||
| "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.71.0", | ||
| "@fluidframework/eslint-config-fluid": "~2.72.0", | ||
| "@microsoft/api-extractor": "7.52.11", | ||
@@ -61,0 +61,0 @@ "concurrently": "^8.2.1", |
New alerts
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
Fixed alerts
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
126635
0.02%Dependency changes
+ Added
@fluid-internal/client-utils@2.72.0(transitive)+ Added
@fluidframework/container-definitions@2.72.0(transitive)+ Added
@fluidframework/core-interfaces@2.72.0(transitive)+ Added
@fluidframework/core-utils@2.72.0(transitive)+ Added
@fluidframework/driver-definitions@2.72.0(transitive)+ Added
@fluidframework/id-compressor@2.72.0(transitive)+ Added
@fluidframework/runtime-definitions@2.72.0(transitive)+ Added
@fluidframework/telemetry-utils@2.72.0(transitive)- Removed
@fluid-internal/client-utils@2.71.0(transitive)- Removed
@fluidframework/container-definitions@2.71.0(transitive)- Removed
@fluidframework/core-interfaces@2.71.0(transitive)- Removed
@fluidframework/core-utils@2.71.0(transitive)- Removed
@fluidframework/driver-definitions@2.71.0(transitive)- Removed
@fluidframework/id-compressor@2.71.0(transitive)- Removed
@fluidframework/runtime-definitions@2.71.0(transitive)- Removed
@fluidframework/telemetry-utils@2.71.0(transitive)