fluid-framework 2.70.0 → 2.71.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # fluid-framework
 
+## 2.71.0
+
+### Minor Changes
+
+- Add IndependentTree API ([#25785](https://github.com/microsoft/FluidFramework/pull/25785)) [21c4245a25](https://github.com/microsoft/FluidFramework/commit/21c4245a25f60f939434b65c5555b13a4d54ea17)
+
+  New `IndependentTreeAlpha` and `IndependentTreeBeta` APIs provide similar utility to the existing alpha [`IndependentView`](https://fluidframework.com/docs/api/tree#independentview-function) API, except providing access to the [`ViewableTree`](https://fluidframework.com/docs/api/fluid-framework/viewabletree-interface).
+
+  This allows for multiple views (in sequence, not concurrently) to be created to test things like schema upgrades and incompatible view schema much more easily (see example below).
+  For `IndependentTreeAlpha`, this also provides access to `exportVerbose` and `exportSimpleSchema` from [`ITreeAlpha`](https://fluidframework.com/docs/api/tree/itreealpha-interface).
+
+  An example of how to use `createIndependentTreeBeta` to create multiple views to test a schema upgrade:
+
+  ```typescript
+  const tree = createIndependentTreeBeta();
+
+  const stagedConfig = new TreeViewConfiguration({
+    schema: SchemaFactoryAlpha.types([
+      SchemaFactory.number,
+      SchemaFactoryAlpha.staged(SchemaFactory.string),
+    ]),
+  });
+  const afterConfig = new TreeViewConfigurationAlpha({
+    schema: [SchemaFactory.number, SchemaFactory.string],
+  });
+
+  // Initialize tree
+  {
+    const view = tree.viewWith(stagedConfig);
+    view.initialize(1);
+    view.dispose();
+  }
+
+  // Do schema upgrade
+  {
+    const view = tree.viewWith(afterConfig);
+    view.upgradeSchema();
+    view.root = "A";
+    view.dispose();
+  }
+
+  // Can still view tree with staged schema
+  {
+    const view = tree.viewWith(stagedConfig);
+    assert.equal(view.root, "A");
+    view.dispose();
+  }
+  ```
+
 ## 2.70.0
 
 ### Minor Changes

package/api-report/fluid-framework.alpha.api.md

@@ -214,6 +214,20 @@ export const contentSchemaSymbol: unique symbol;
 // @alpha
 export function createIdentifierIndex<TSchema extends ImplicitFieldSchema>(view: TreeView<TSchema>): IdentifierIndex;
 
+// @alpha
+export function createIndependentTreeAlpha<const TSchema extends ImplicitFieldSchema>(options?: ForestOptions & (({
+    idCompressor?: IIdCompressor_2 | undefined;
+} & {
+    content?: undefined;
+}) | (ICodecOptions & {
+    content: ViewContent;
+} & {
+    idCompressor?: undefined;
+}))): ViewableTree & Pick<ITreeAlpha, "exportVerbose" | "exportSimpleSchema">;
+
+// @beta
+export function createIndependentTreeBeta<const TSchema extends ImplicitFieldSchema>(options?: ForestOptions): ViewableTree;
+
 // @alpha
 export function createSimpleTreeIndex<TFieldSchema extends ImplicitFieldSchema, TKey extends TreeIndexKey, TValue>(view: TreeView<TFieldSchema>, indexer: (schema: TreeNodeSchema) => string | undefined, getValue: (nodes: TreeIndexNodes<TreeNode>) => TValue, isKeyValid: (key: TreeIndexKey) => key is TKey): SimpleTreeIndex<TKey, TValue>;
 
@@ -328,6 +342,8 @@ export class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends
     get allowedTypesIdentifiers(): ReadonlySet<string>;
     // (undocumented)
     get persistedMetadata(): JsonCompatibleReadOnlyObject | undefined;
+    // (undocumented)
+    get simpleAllowedTypes(): ReadonlyMap<string, SimpleAllowedTypeAttributes>;
 }
 
 // @alpha @sealed @system
@@ -976,6 +992,7 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
 // @public @sealed
 export interface Listenable<TListeners extends object> {
     off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
+    // (undocumented)
     on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
 }
 
@@ -1382,17 +1399,22 @@ export type SharedTreeOptions = Partial<CodecWriteOptions> & Partial<SharedTreeF
 // @beta @input
 export type SharedTreeOptionsBeta = ForestOptions;
 
+// @alpha @sealed
+export interface SimpleAllowedTypeAttributes {
+    readonly isStaged: boolean | undefined;
+}
+
 // @alpha @sealed
 export interface SimpleArrayNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Array, TCustomMetadata> {
-    readonly allowedTypesIdentifiers: ReadonlySet<string>;
+    readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes>;
 }
 
 // @alpha @sealed
 export interface SimpleFieldSchema {
-    readonly allowedTypesIdentifiers: ReadonlySet<string>;
     readonly kind: FieldKind;
     readonly metadata: FieldSchemaMetadata;
     readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;
+    readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes>;
 }
 
 // @alpha @sealed
@@ -1402,7 +1424,7 @@ export interface SimpleLeafNodeSchema extends SimpleNodeSchemaBaseAlpha<NodeKind
 
 // @alpha @sealed
 export interface SimpleMapNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Map, TCustomMetadata> {
-    readonly allowedTypesIdentifiers: ReadonlySet<string>;
+    readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes>;
 }
 
 // @alpha
@@ -1431,7 +1453,7 @@ export interface SimpleObjectNodeSchema<out TCustomMetadata = unknown> extends S
 
 // @alpha @sealed
 export interface SimpleRecordNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Record, TCustomMetadata> {
-    readonly allowedTypesIdentifiers: ReadonlySet<string>;
+    readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes>;
 }
 
 // @alpha

package/api-report/fluid-framework.beta.api.md

@@ -133,6 +133,9 @@ export interface ContainerSchema {
     readonly initialObjects: Record<string, SharedObjectKind>;
 }
 
+// @beta
+export function createIndependentTreeBeta<const TSchema extends ImplicitFieldSchema>(options?: ForestOptions): ViewableTree;
+
 // @public @sealed @system
 interface DefaultProvider extends ErasedType<"@fluidframework/tree.FieldProvider"> {
 }
@@ -667,6 +670,7 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
 // @public @sealed
 export interface Listenable<TListeners extends object> {
     off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
+    // (undocumented)
     on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
 }
 

package/api-report/fluid-framework.legacy.beta.api.md

@@ -133,6 +133,9 @@ export interface ContainerSchema {
     readonly initialObjects: Record<string, SharedObjectKind>;
 }
 
+// @beta
+export function createIndependentTreeBeta<const TSchema extends ImplicitFieldSchema>(options?: ForestOptions): ViewableTree;
+
 // @public @sealed @system
 interface DefaultProvider extends ErasedType<"@fluidframework/tree.FieldProvider"> {
 }
@@ -945,6 +948,7 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
 // @public @sealed
 export interface Listenable<TListeners extends object> {
     off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
+    // (undocumented)
     on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
 }
 

package/api-report/fluid-framework.legacy.public.api.md

@@ -562,6 +562,7 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
 // @public @sealed
 export interface Listenable<TListeners extends object> {
     off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
+    // (undocumented)
     on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
 }
 

package/api-report/fluid-framework.public.api.md

@@ -528,6 +528,7 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
 // @public @sealed
 export interface Listenable<TListeners extends object> {
     off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
+    // (undocumented)
     on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
 }
 

package/dist/alpha.d.ts

@@ -176,6 +176,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema,
 	// #endregion
@@ -249,6 +250,7 @@ export {
 	SharedTreeFormatOptions, 
 	SharedTreeFormatVersion, 
 	SharedTreeOptions, 
+	SimpleAllowedTypeAttributes, 
 	SimpleArrayNodeSchema, 
 	SimpleFieldSchema, 
 	SimpleLeafNodeSchema, 
@@ -297,6 +299,7 @@ export {
 	configuredSharedTree, 
 	contentSchemaSymbol, 
 	createIdentifierIndex, 
+	createIndependentTreeAlpha, 
 	createSimpleTreeIndex, 
 	evaluateLazySchema, 
 	extractPersistedSchema, 

package/dist/beta.d.ts

@@ -176,6 +176,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema
 	// #endregion

package/dist/legacy.d.ts

@@ -183,6 +183,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema,
 	// #endregion

package/lib/alpha.d.ts

@@ -176,6 +176,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema,
 	// #endregion
@@ -249,6 +250,7 @@ export {
 	SharedTreeFormatOptions, 
 	SharedTreeFormatVersion, 
 	SharedTreeOptions, 
+	SimpleAllowedTypeAttributes, 
 	SimpleArrayNodeSchema, 
 	SimpleFieldSchema, 
 	SimpleLeafNodeSchema, 
@@ -297,6 +299,7 @@ export {
 	configuredSharedTree, 
 	contentSchemaSymbol, 
 	createIdentifierIndex, 
+	createIndependentTreeAlpha, 
 	createSimpleTreeIndex, 
 	evaluateLazySchema, 
 	extractPersistedSchema, 

package/lib/beta.d.ts

@@ -176,6 +176,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema
 	// #endregion

package/lib/legacy.d.ts

@@ -183,6 +183,7 @@ export {
 	adaptEnum, 
 	asBeta, 
 	configuredSharedTreeBeta, 
+	createIndependentTreeBeta, 
 	enumFromStrings, 
 	singletonSchema,
 	// #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.70.0",
+  "version": "2.71.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,17 +57,17 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.70.0",
-    "@fluidframework/container-loader": "~2.70.0",
-    "@fluidframework/core-interfaces": "~2.70.0",
-    "@fluidframework/core-utils": "~2.70.0",
-    "@fluidframework/driver-definitions": "~2.70.0",
-    "@fluidframework/fluid-static": "~2.70.0",
-    "@fluidframework/map": "~2.70.0",
-    "@fluidframework/runtime-utils": "~2.70.0",
-    "@fluidframework/sequence": "~2.70.0",
-    "@fluidframework/shared-object-base": "~2.70.0",
-    "@fluidframework/tree": "~2.70.0"
+    "@fluidframework/container-definitions": "~2.71.0",
+    "@fluidframework/container-loader": "~2.71.0",
+    "@fluidframework/core-interfaces": "~2.71.0",
+    "@fluidframework/core-utils": "~2.71.0",
+    "@fluidframework/driver-definitions": "~2.71.0",
+    "@fluidframework/fluid-static": "~2.71.0",
+    "@fluidframework/map": "~2.71.0",
+    "@fluidframework/runtime-utils": "~2.71.0",
+    "@fluidframework/sequence": "~2.71.0",
+    "@fluidframework/shared-object-base": "~2.71.0",
+    "@fluidframework/tree": "~2.71.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
@@ -75,7 +75,7 @@
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/eslint-config-fluid": "^6.1.0",
+    "@fluidframework/eslint-config-fluid": "^7.0.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/node": "^18.19.0",
     "concurrently": "^8.2.1",
@@ -129,8 +129,8 @@
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob _api-extractor-temp dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\"",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "eslint": "eslint --quiet --format stylish src",
+    "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
     "lint": "fluid-build . --task lint",