Bump fluid-framework from 1.4.0 to 2.91.0 in /packages/live-share-canvas

[dependabot]

Bumps fluid-framework from 1.4.0 to 2.91.0.

Release notes

Sourced from fluid-framework's releases.

Fluid Framework v2.91.0 (minor)

Contents

• ✨ New Features
  • [Adds withDefault API to allow defining default values for required and optional fields (#26502)](#user-content-adds-withdefault-api-to-allow-defining-default-values-for-required-and-optional-fields-26502)

✨ New Features

Adds withDefault API to allow defining default values for required and optional fields (#26502)

The withDefault API is now available on SchemaFactoryAlpha. It allows you to specify default values for fields, making them optional in constructors even when the field is marked as required in the schema. This provides a better developer experience by reducing boilerplate when creating objects.

The withDefault API wraps a field schema and defines a default value to use when the field is not provided during construction. The default value must be of an allowed type of the field. You can provide defaults in two ways:

• A value: When a value is provided directly, the data is copied for each use to ensure independence between instances
• A generator function: A function that is called each time to produce a fresh value

Defaults are evaluated eagerly during node construction.

Required fields with defaults

import { SchemaFactoryAlpha, TreeAlpha } from "@fluidframework/tree/alpha";
const sf = new SchemaFactoryAlpha("example");
class Person extends sf.objectAlpha("Person", {
name: sf.required(sf.string),
age: sf.withDefault(sf.required(sf.number), -1),
role: sf.withDefault(sf.required(sf.string), "guest"),
}) {}
// Before: all fields were required
// const person = new Person({ name: "Alice", age: -1, role: "guest" });
// After: fields with defaults are optional
const person = new Person({ name: "Alice" });
// person.age === -1
// person.role === "guest"
// You can still provide values to override the defaults
const admin = new Person({ name: "Bob", age: 30, role: "admin" });

Optional fields with custom defaults

Optional fields (sf.optional) already default to undefined, but withDefault allows you to specify a different default value:

... (truncated)

Changelog

Sourced from fluid-framework's changelog.

2.91.0

Minor Changes

• Adds withDefault API to allow defining default values for required and optional fields (#26502) 44fdd9421e4

  The withDefault API is now available on SchemaFactoryAlpha. It allows you to specify default values for fields, making them optional in constructors even when the field is marked as required in the schema. This provides a better developer experience by reducing boilerplate when creating objects.

  The withDefault API wraps a field schema and defines a default value to use when the field is not provided during construction. The default value must be of an allowed type of the field. You can provide defaults in two ways:

  • A value: When a value is provided directly, the data is copied for each use to ensure independence between instances
  • A generator function: A function that is called each time to produce a fresh value

  Defaults are evaluated eagerly during node construction.

  Required fields with defaults

  import { SchemaFactoryAlpha, TreeAlpha } from "@fluidframework/tree/alpha";
  const sf = new SchemaFactoryAlpha("example");
  class Person extends sf.objectAlpha("Person", {
  name: sf.required(sf.string),
  age: sf.withDefault(sf.required(sf.number), -1),
  role: sf.withDefault(sf.required(sf.string), "guest"),
  }) {}
  // Before: all fields were required
  // const person = new Person({ name: "Alice", age: -1, role: "guest" });
  // After: fields with defaults are optional
  const person = new Person({ name: "Alice" });
  // person.age === -1
  // person.role === "guest"
  // You can still provide values to override the defaults
  const admin = new Person({ name: "Bob", age: 30, role: "admin" });

  Optional fields with custom defaults

  Optional fields (sf.optional) already default to undefined, but withDefault allows you to specify a different default value:

  class Config extends sf.object("Config", {
    timeout: sf.withDefault(sf.optional(sf.number), 5000),

... (truncated)

Commits

• c9659f0 build: generate release notes and changelogs for 2.91.0 (#26744)
• 9c9800b Add some utilities for explict typing of erased types (#26683)
• 44fdd94 feat(tree): add api for providing defaults on required and optional fields (#...
• 31d98d5 build: Use pnpm catalogs (#26634)
• b0a1006 build: update @​biomejs/biome to 2.x (#26617)
• 9302761 build: bump client versions to 2.91.0 (#26610)
• 1d7a94f docs: generate release notes and changelogs for 2.90.0 (#26609)
• 924c17e Add composable labels for transactions (#26405)
• 06736bd Promote TextAsTree to alpha (#26568)
• eb4ef62 Promote snapshotSchemaCompatibility to beta (#26288)
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)