fluid-framework 2.80.0 → 2.81.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # fluid-framework
 
+## 2.81.0
+
+### Minor Changes
+
+- directory: Path parameter added to `cleared` event ([#26112](https://github.com/microsoft/FluidFramework/pull/26112)) [1ded6bf755](https://github.com/microsoft/FluidFramework/commit/1ded6bf75526eefd4d4565f4f9f6c795b8a77acf)
+
+  The `clear` event for SharedDirectory did not include a `path` parameter indicating which directory was cleared. Therefore, the `clear` event is deprecated and will be removed in a future release. Instead use the `cleared` event.
+
+  **Before:**
+
+  ```typescript
+  sharedDirectory.on("clear", (local, target) => {
+    // No way to know which subdirectory was cleared
+  });
+  ```
+
+  **After:**
+
+  ```typescript
+  sharedDirectory.on("cleared", (path, local, target) => {
+    // path tells you which directory was cleared (e.g., "/", "/subdir1", "/subdir2")
+  });
+  ```
+
+  This change provides better observability by allowing listeners to distinguish between clear operations on different subdirectories within the SharedDirectory hierarchy.
+
 ## 2.80.0
 
 ### Minor Changes

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

@@ -142,17 +142,14 @@ export interface BranchableTree extends ViewableTree {
 }
 
 // @alpha @sealed
-export type ChangeMetadata = CommitMetadata & ({
-    readonly isLocal: true;
-    getChange(): JsonCompatibleReadOnly;
-} | {
-    readonly isLocal: false;
-    readonly getChange?: undefined;
-});
+export type ChangeMetadata = LocalChangeMetadata | RemoteChangeMetadata;
 
 // @alpha
 export function checkCompatibility(viewWhichCreatedStoredSchema: TreeViewConfiguration, view: TreeViewConfiguration): Omit<SchemaCompatibilityStatus, "canInitialize">;
 
+// @alpha
+export function checkSchemaCompatibilitySnapshots(options: SchemaCompatibilitySnapshotsOptions): void;
+
 // @alpha
 export function cloneWithReplacements(root: unknown, rootKey: string, replacer: (key: string, value: unknown) => {
     clone: boolean;
@@ -1057,6 +1054,13 @@ export type Listeners<T extends object> = {
     [P in (string | symbol) & keyof T as IsListener<T[P]> extends true ? P : never]: T[P];
 };
 
+// @alpha @sealed
+export interface LocalChangeMetadata extends CommitMetadata {
+    getChange(): JsonCompatibleReadOnly;
+    getRevertible(onDisposed?: (revertible: RevertibleAlpha) => void): RevertibleAlpha | undefined;
+    readonly isLocal: true;
+}
+
 // @public @sealed
 export interface MakeNominal {
 }
@@ -1230,6 +1234,13 @@ export const RecordNodeSchema: {
     readonly [Symbol.hasInstance]: (value: TreeNodeSchema) => value is RecordNodeSchema<string, ImplicitAllowedTypes, true, unknown>;
 };
 
+// @alpha @sealed
+export interface RemoteChangeMetadata extends CommitMetadata {
+    readonly getChange?: undefined;
+    readonly getRevertible?: undefined;
+    readonly isLocal: false;
+}
+
 // @alpha
 export function replaceConciseTreeHandles<T>(tree: ConciseTree, replacer: HandleConverter<T>): ConciseTree<T>;
 
@@ -1306,6 +1317,17 @@ export interface RunTransactionParams {
     readonly preconditions?: readonly TransactionConstraintAlpha[];
 }
 
+// @alpha @input
+export interface SchemaCompatibilitySnapshotsOptions {
+    readonly fileSystem: SnapshotFileSystem;
+    readonly minVersionForCollaboration: string;
+    readonly mode: "test" | "update";
+    readonly schema: TreeViewConfiguration;
+    readonly snapshotDirectory: string;
+    readonly snapshotUnchangedVersions?: true;
+    readonly version: string;
+}
+
 // @public @sealed
 export interface SchemaCompatibilityStatus {
     readonly canInitialize: boolean;
@@ -1537,6 +1559,19 @@ export function singletonSchema<TScope extends string, TName extends string | nu
     readonly value: TName;
 }, Record<string, never>, true, Record<string, never>, undefined>;
 
+// @alpha @input
+export interface SnapshotFileSystem {
+    join(parentPath: string, childPath: string): string;
+    mkdirSync(dir: string, options: {
+        recursive: true;
+    }): void;
+    readdirSync(dir: string): readonly string[];
+    readFileSync(file: string, encoding: "utf8"): string;
+    writeFileSync(file: string, data: string, options: {
+        encoding: "utf8";
+    }): void;
+}
+
 // @alpha @system
 export namespace System_TableSchema {
     // @sealed @system

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

@@ -800,7 +800,9 @@ export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents &
 // @beta @sealed @legacy
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
     (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    // @deprecated
     (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
+    (event: "cleared", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
     (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
     (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
 }

package/dist/alpha.d.ts

@@ -236,6 +236,7 @@ export {
 	JsonSchemaType, 
 	JsonStringKeyPatternProperties, 
 	JsonTreeSchema, 
+	LocalChangeMetadata, 
 	MapNodeCustomizableSchema, 
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
@@ -250,9 +251,11 @@ export {
 	RecordNodeCustomizableSchema, 
 	RecordNodePojoEmulationSchema, 
 	RecordNodeSchema, 
+	RemoteChangeMetadata, 
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParams, 
+	SchemaCompatibilitySnapshotsOptions, 
 	SchemaFactoryAlpha, 
 	SchemaType, 
 	SharedTreeFormatOptions, 
@@ -269,6 +272,7 @@ export {
 	SimpleRecordNodeSchema, 
 	SimpleTreeIndex, 
 	SimpleTreeSchema, 
+	SnapshotFileSystem, 
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
@@ -301,6 +305,7 @@ export {
 	asAlpha, 
 	asTreeViewAlpha, 
 	checkCompatibility, 
+	checkSchemaCompatibilitySnapshots, 
 	cloneWithReplacements, 
 	comparePersistedSchema, 
 	configuredSharedTree, 

package/eslint.config.mts

@@ -1,8 +1,8 @@
-/* eslint-disable */
-/**
- * GENERATED FILE - DO NOT EDIT DIRECTLY.
- * To regenerate: pnpm tsx scripts/generate-flat-eslint-configs.ts --typescript
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
  */
+
 import type { Linter } from "eslint";
 import { strict } from "../../../common/build/eslint-config-fluid/flat.mts";
 

package/lib/alpha.d.ts

@@ -236,6 +236,7 @@ export {
 	JsonSchemaType, 
 	JsonStringKeyPatternProperties, 
 	JsonTreeSchema, 
+	LocalChangeMetadata, 
 	MapNodeCustomizableSchema, 
 	MapNodeCustomizableSchemaUnsafe, 
 	MapNodePojoEmulationSchema, 
@@ -250,9 +251,11 @@ export {
 	RecordNodeCustomizableSchema, 
 	RecordNodePojoEmulationSchema, 
 	RecordNodeSchema, 
+	RemoteChangeMetadata, 
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParams, 
+	SchemaCompatibilitySnapshotsOptions, 
 	SchemaFactoryAlpha, 
 	SchemaType, 
 	SharedTreeFormatOptions, 
@@ -269,6 +272,7 @@ export {
 	SimpleRecordNodeSchema, 
 	SimpleTreeIndex, 
 	SimpleTreeSchema, 
+	SnapshotFileSystem, 
 	System_TableSchema, 
 	TableSchema, 
 	TransactionCallbackStatus, 
@@ -301,6 +305,7 @@ export {
 	asAlpha, 
 	asTreeViewAlpha, 
 	checkCompatibility, 
+	checkSchemaCompatibilitySnapshots, 
 	cloneWithReplacements, 
 	comparePersistedSchema, 
 	configuredSharedTree, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.80.0",
+  "version": "2.81.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,25 +57,25 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.80.0",
-    "@fluidframework/container-loader": "~2.80.0",
-    "@fluidframework/core-interfaces": "~2.80.0",
-    "@fluidframework/core-utils": "~2.80.0",
-    "@fluidframework/driver-definitions": "~2.80.0",
-    "@fluidframework/fluid-static": "~2.80.0",
-    "@fluidframework/map": "~2.80.0",
-    "@fluidframework/runtime-utils": "~2.80.0",
-    "@fluidframework/sequence": "~2.80.0",
-    "@fluidframework/shared-object-base": "~2.80.0",
-    "@fluidframework/tree": "~2.80.0"
+    "@fluidframework/container-definitions": "~2.81.0",
+    "@fluidframework/container-loader": "~2.81.0",
+    "@fluidframework/core-interfaces": "~2.81.0",
+    "@fluidframework/core-utils": "~2.81.0",
+    "@fluidframework/driver-definitions": "~2.81.0",
+    "@fluidframework/fluid-static": "~2.81.0",
+    "@fluidframework/map": "~2.81.0",
+    "@fluidframework/runtime-utils": "~2.81.0",
+    "@fluidframework/sequence": "~2.81.0",
+    "@fluidframework/shared-object-base": "~2.81.0",
+    "@fluidframework/tree": "~2.81.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.62.0",
+    "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.62.0",
-    "@fluidframework/eslint-config-fluid": "~2.80.0",
+    "@fluidframework/build-tools": "^0.63.0",
+    "@fluidframework/eslint-config-fluid": "~2.81.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/node": "^18.19.0",
     "concurrently": "^9.2.1",

package/.eslintrc.cjs

@@ -1,12 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: ["@fluidframework/eslint-config-fluid/strict", "prettier"],
-	parserOptions: {
-		project: ["./tsconfig.json"],
-	},
-	rules: {},
-};