fluid-framework 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # fluid-framework
 
+## 3.4.0
+
+### Minor Changes
+
+- Add experimental SharedTree sandboxing APIs ([#28382](https://github.com/microsoft/FluidFramework/pull/28382)) [e41dc04d41](https://github.com/microsoft/FluidFramework/commit/e41dc04d41d1cb21ccd48a2a1b44d817f1a33c0c)
+
+  The new alpha `Sandboxing.createHost` and `Sandboxing.createGuest` APIs synchronize a SharedTree [`ViewableTree`](https://fluidframework.com/docs/api/fluid-framework/viewabletree-interface) across a `MessagePort`.
+  The Host remains connected to Fluid services while the Guest exposes a normal schema-aware tree view on the other side of the message channel.
+
+  > [!IMPORTANT]
+  > To use Sandboxing, you must set the container runtime's [`oldestSupportedClient`](https://fluidframework.com/docs/api/container-runtime/loadcontainerruntimeparams-interface#oldestsupportedclient-propertysignature) option to `"3.4.0"` or later.
+
+  ```typescript
+  import { asBeta } from "@fluidframework/tree/beta";
+  import { FormatValidatorBasic, Sandboxing } from "@fluidframework/tree/alpha";
+
+  // Create the application-owned view that remains connected to Fluid services.
+  const hostView = asBeta(tree.viewWith(config));
+
+  // Create the message channel that crosses the sandbox boundary.
+  const channel = new MessageChannel();
+
+  // Connect the Host endpoint to the collaborative tree.
+  const host = Sandboxing.createHost({ main: hostView, port: channel.port1 });
+
+  // Create the independent Guest tree on the other side of the channel.
+  const guest = await Sandboxing.createGuest({
+    port: channel.port2,
+    treeOptions: { jsonValidator: FormatValidatorBasic },
+  });
+
+  // Open a schema-aware view for application code running in the sandbox.
+  const guestView = guest.tree.viewWith(config);
+  ```
+
+- Add an alpha incremental-summary field property ([#28285](https://github.com/microsoft/FluidFramework/pull/28285)) [5d1392bb81](https://github.com/microsoft/FluidFramework/commit/5d1392bb8170cb3dbdc6745b8e01227a20a4d75f)
+
+  The new alpha `summarizeIncrementally` property on [`FieldPropsAlpha`](https://fluidframework.com/docs/api/tree/fieldpropsalpha-interface) marks a field as an incremental-summary boundary without requiring direct use of allowed-types metadata or the [`incrementalSummaryHint`](https://fluidframework.com/docs/api/tree/#incrementalsummaryhint-variable) symbol.
+  This property is the preferred way to configure incremental summarization.
+  [`SchemaFactoryAlpha.requiredRecursive`](https://fluidframework.com/docs/api/tree/schemafactoryalpha-class#requiredrecursive-property) and [`optionalRecursive`](https://fluidframework.com/docs/api/tree/schemafactoryalpha-class#optionalrecursive-property) provide the same field configuration for recursive allowed types with relaxed compile-time constraints.
+  The [`SchemaFactoryAlpha.stagedOptional`](https://fluidframework.com/docs/api/tree/schemafactoryalpha-class#stagedoptional-property) and [`stagedOptionalRecursive`](https://fluidframework.com/docs/api/tree/schemafactoryalpha-class#stagedoptionalrecursive-property) field constructors also accept this option.
+
+  ```typescript
+  const sf = new SchemaFactoryAlpha("example");
+
+  class Document extends sf.objectAlpha("Document", {
+    sections: sf.required(sf.map(Section), { summarizeIncrementally: true }),
+  }) {}
+  ```
+
 ## 3.3.0
 
 ### Minor Changes

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

@@ -512,6 +512,7 @@ export interface FieldProps<TCustomMetadata = unknown> {
 export interface FieldPropsAlpha<TCustomMetadata = unknown> extends FieldProps<TCustomMetadata> {
     readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;
     readonly stagedOptionalUpgrade?: SchemaUpgrade;
+    readonly summarizeIncrementally?: boolean;
 }
 
 // @public @sealed
@@ -1802,6 +1803,39 @@ export interface RunTransactionParamsBeta {
     readonly label?: unknown;
 }
 
+// @alpha
+export namespace Sandboxing {
+    export function createGuest(options: GuestOptions): Promise<Guest>;
+    export function createHost(options: HostOptions): Host;
+    // @input
+    export interface EndpointOptions {
+        readonly handleProtocolError?: (error: Error) => void;
+        readonly logger?: ITelemetryBaseLogger;
+        readonly port: InstanceType<typeof MessagePort>;
+    }
+    // @sealed
+    export interface Guest {
+        dispose(): void;
+        readonly error: Error | undefined;
+        readonly tree: ViewableTree;
+        readonly updateHostPromise: Promise<void> | undefined;
+    }
+    // @input
+    export interface GuestOptions extends EndpointOptions {
+        readonly treeOptions: ForestOptions & ICodecOptions;
+    }
+    // @sealed
+    export interface Host {
+        dispose(): void;
+        readonly error: Error | undefined;
+        readonly updateGuestPromise: Promise<void> | undefined;
+    }
+    // @input
+    export interface HostOptions extends EndpointOptions {
+        readonly main: UntypedTreeView;
+    }
+}
+
 // @public @sealed
 export interface SchemaCompatibilityStatus {
     readonly canInitialize: boolean;

package/dist/alpha.d.ts

@@ -337,6 +337,7 @@ export {
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParamsAlpha, 
+	Sandboxing, 
 	SchemaFactoryAlpha, 
 	SchemaStaticsAlpha, 
 	SchemaType, 

package/lib/alpha.d.ts

@@ -337,6 +337,7 @@ export {
 	RevertibleAlpha, 
 	RevertibleAlphaFactory, 
 	RunTransactionParamsAlpha, 
+	Sandboxing, 
 	SchemaFactoryAlpha, 
 	SchemaStaticsAlpha, 
 	SchemaType, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -43,17 +43,17 @@
     }
   },
   "dependencies": {
-    "@fluidframework/container-definitions": "~3.3.0",
-    "@fluidframework/container-loader": "~3.3.0",
-    "@fluidframework/core-interfaces": "~3.3.0",
-    "@fluidframework/core-utils": "~3.3.0",
-    "@fluidframework/driver-definitions": "~3.3.0",
-    "@fluidframework/fluid-static": "~3.3.0",
-    "@fluidframework/map": "~3.3.0",
-    "@fluidframework/runtime-utils": "~3.3.0",
-    "@fluidframework/sequence": "~3.3.0",
-    "@fluidframework/shared-object-base": "~3.3.0",
-    "@fluidframework/tree": "~3.3.0"
+    "@fluidframework/container-definitions": "~3.4.0",
+    "@fluidframework/container-loader": "~3.4.0",
+    "@fluidframework/core-interfaces": "~3.4.0",
+    "@fluidframework/core-utils": "~3.4.0",
+    "@fluidframework/driver-definitions": "~3.4.0",
+    "@fluidframework/fluid-static": "~3.4.0",
+    "@fluidframework/map": "~3.4.0",
+    "@fluidframework/runtime-utils": "~3.4.0",
+    "@fluidframework/sequence": "~3.4.0",
+    "@fluidframework/shared-object-base": "~3.4.0",
+    "@fluidframework/tree": "~3.4.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
@@ -67,7 +67,7 @@
     "concurrently": "^10.0.3",
     "copyfiles": "^2.4.1",
     "eslint": "~9.39.1",
-    "fluid-framework-previous": "npm:fluid-framework@3.2.0",
+    "fluid-framework-previous": "npm:fluid-framework@3.3.0",
     "jiti": "^2.6.1",
     "rimraf": "^6.1.3",
     "typescript": "~6.0.3"