@fluidframework/fluid-static 2.51.0 → 2.52.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/fluid-static
 
+## 2.52.0
+
+Dependency updates only.
+
 ## 2.51.0
 
 ### Minor Changes

package/README.md

@@ -23,6 +23,15 @@ To get started, install the package by running the following command:
 npm i @fluidframework/fluid-static
 ```
 
+## Importing from this package
+
+This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
+For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+
+To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/fluid-static` like normal.
+
+To access the `legacy` APIs, import via `@fluidframework/fluid-static/legacy`.
+
 ## API Documentation
 
 API documentation for **@fluidframework/fluid-static** is available at <https://fluidframework.com/docs/apis/fluid-static>.

package/api-extractor/api-extractor-lint-legacy.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/legacy.d.ts"
+}

package/api-extractor/api-extractor-lint-legacy.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/legacy.d.ts"
+}

package/api-extractor/api-extractor.current.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+}

package/api-extractor/api-extractor.legacy.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
+}

package/api-report/fluid-static.legacy.alpha.api.md

@@ -0,0 +1,100 @@
+## Alpha API Report File for "@fluidframework/fluid-static"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type CompatibilityMode = "1" | "2";
+
+// @public
+export type ContainerAttachProps<T = unknown> = T;
+
+// @public
+export interface ContainerSchema {
+    readonly dynamicObjectTypes?: readonly SharedObjectKind[];
+    readonly initialObjects: Record<string, SharedObjectKind>;
+}
+
+// @alpha @legacy
+export function createTreeContainerRuntimeFactory(props: {
+    readonly schema: TreeContainerSchema;
+    readonly compatibilityMode: CompatibilityMode;
+    readonly rootDataStoreRegistry?: IFluidDataStoreRegistry;
+    readonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;
+    readonly minVersionForCollabOverride?: MinimumVersionForCollab;
+}): IRuntimeFactory;
+
+// @public
+export interface IConnection {
+    readonly id: string;
+    readonly mode: "write" | "read";
+}
+
+// @public @sealed
+export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
+    attach(props?: ContainerAttachProps): Promise<string>;
+    readonly attachState: AttachState;
+    connect(): void;
+    readonly connectionState: ConnectionState;
+    create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
+    disconnect(): void;
+    dispose(): void;
+    readonly disposed: boolean;
+    readonly initialObjects: InitialObjects<TContainerSchema>;
+    readonly isDirty: boolean;
+}
+
+// @public @sealed
+export interface IFluidContainerEvents extends IEvent {
+    (event: "connected", listener: () => void): void;
+    (event: "disconnected", listener: () => void): void;
+    (event: "saved", listener: () => void): void;
+    (event: "dirty", listener: () => void): void;
+    (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
+}
+
+// @public
+export interface IMember {
+    readonly connections: IConnection[];
+    readonly id: string;
+}
+
+// @public
+export type InitialObjects<T extends ContainerSchema> = {
+    [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
+};
+
+// @public
+export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
+    getMembers(): ReadonlyMap<string, M>;
+    getMyself(): Myself<M> | undefined;
+}
+
+// @public
+export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
+    // @eventProperty
+    (event: "membersChanged", listener: () => void): void;
+    // @eventProperty
+    (event: "memberAdded", listener: MemberChangedListener<M>): void;
+    // @eventProperty
+    (event: "memberRemoved", listener: MemberChangedListener<M>): void;
+}
+
+// @public
+export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
+
+// @public
+export type Myself<M extends IMember = IMember> = M & {
+    readonly currentConnection: string;
+};
+
+// @alpha @legacy
+export interface TreeContainerSchema extends ContainerSchema {
+    // (undocumented)
+    readonly initialObjects: {
+        readonly tree: SharedObjectKind<ITree>;
+    };
+}
+
+```

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

@@ -0,0 +1,83 @@
+## Public API Report File for "@fluidframework/fluid-static"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type CompatibilityMode = "1" | "2";
+
+// @public
+export type ContainerAttachProps<T = unknown> = T;
+
+// @public
+export interface ContainerSchema {
+    readonly dynamicObjectTypes?: readonly SharedObjectKind[];
+    readonly initialObjects: Record<string, SharedObjectKind>;
+}
+
+// @public
+export interface IConnection {
+    readonly id: string;
+    readonly mode: "write" | "read";
+}
+
+// @public @sealed
+export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
+    attach(props?: ContainerAttachProps): Promise<string>;
+    readonly attachState: AttachState;
+    connect(): void;
+    readonly connectionState: ConnectionState;
+    create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
+    disconnect(): void;
+    dispose(): void;
+    readonly disposed: boolean;
+    readonly initialObjects: InitialObjects<TContainerSchema>;
+    readonly isDirty: boolean;
+}
+
+// @public @sealed
+export interface IFluidContainerEvents extends IEvent {
+    (event: "connected", listener: () => void): void;
+    (event: "disconnected", listener: () => void): void;
+    (event: "saved", listener: () => void): void;
+    (event: "dirty", listener: () => void): void;
+    (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
+}
+
+// @public
+export interface IMember {
+    readonly connections: IConnection[];
+    readonly id: string;
+}
+
+// @public
+export type InitialObjects<T extends ContainerSchema> = {
+    [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
+};
+
+// @public
+export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
+    getMembers(): ReadonlyMap<string, M>;
+    getMyself(): Myself<M> | undefined;
+}
+
+// @public
+export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
+    // @eventProperty
+    (event: "membersChanged", listener: () => void): void;
+    // @eventProperty
+    (event: "memberAdded", listener: MemberChangedListener<M>): void;
+    // @eventProperty
+    (event: "memberRemoved", listener: MemberChangedListener<M>): void;
+}
+
+// @public
+export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
+
+// @public
+export type Myself<M extends IMember = IMember> = M & {
+    readonly currentConnection: string;
+};
+
+```

package/dist/legacy.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
+ */
+
+/**
+ * Provides a simple and powerful way to consume collaborative Fluid data.
+ *
+ * @packageDocumentation
+ */
+
+export {
+	// @public APIs
+	CompatibilityMode, 
+	ContainerAttachProps, 
+	ContainerSchema, 
+	IConnection, 
+	IFluidContainer, 
+	IFluidContainerEvents, 
+	IMember, 
+	IServiceAudience, 
+	IServiceAudienceEvents, 
+	InitialObjects, 
+	MemberChangedListener, 
+	Myself,
+ 
+	// @legacy APIs
+	TreeContainerSchema, 
+	createTreeContainerRuntimeFactory
+} from "./index.js";

package/legacy.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
+ */
+
+export * from "./lib/legacy.js";

package/lib/legacy.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
+ */
+
+/**
+ * Provides a simple and powerful way to consume collaborative Fluid data.
+ *
+ * @packageDocumentation
+ */
+
+export {
+	// @public APIs
+	CompatibilityMode, 
+	ContainerAttachProps, 
+	ContainerSchema, 
+	IConnection, 
+	IFluidContainer, 
+	IFluidContainerEvents, 
+	IMember, 
+	IServiceAudience, 
+	IServiceAudienceEvents, 
+	InitialObjects, 
+	MemberChangedListener, 
+	Myself,
+ 
+	// @legacy APIs
+	TreeContainerSchema, 
+	createTreeContainerRuntimeFactory
+} from "./index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.51.0",
+  "version": "2.52.0",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -23,6 +23,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./legacy": {
+      "import": {
+        "types": "./lib/legacy.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/legacy.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
     "./internal": {
       "import": {
         "types": "./lib/index.d.ts",
@@ -59,34 +69,34 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.51.0",
-    "@fluidframework/aqueduct": "~2.51.0",
-    "@fluidframework/container-definitions": "~2.51.0",
-    "@fluidframework/container-loader": "~2.51.0",
-    "@fluidframework/container-runtime": "~2.51.0",
-    "@fluidframework/container-runtime-definitions": "~2.51.0",
-    "@fluidframework/core-interfaces": "~2.51.0",
-    "@fluidframework/core-utils": "~2.51.0",
-    "@fluidframework/datastore-definitions": "~2.51.0",
-    "@fluidframework/driver-definitions": "~2.51.0",
-    "@fluidframework/request-handler": "~2.51.0",
-    "@fluidframework/runtime-definitions": "~2.51.0",
-    "@fluidframework/runtime-utils": "~2.51.0",
-    "@fluidframework/shared-object-base": "~2.51.0",
-    "@fluidframework/telemetry-utils": "~2.51.0",
-    "@fluidframework/tree": "~2.51.0"
+    "@fluid-internal/client-utils": "~2.52.0",
+    "@fluidframework/aqueduct": "~2.52.0",
+    "@fluidframework/container-definitions": "~2.52.0",
+    "@fluidframework/container-loader": "~2.52.0",
+    "@fluidframework/container-runtime": "~2.52.0",
+    "@fluidframework/container-runtime-definitions": "~2.52.0",
+    "@fluidframework/core-interfaces": "~2.52.0",
+    "@fluidframework/core-utils": "~2.52.0",
+    "@fluidframework/datastore-definitions": "~2.52.0",
+    "@fluidframework/driver-definitions": "~2.52.0",
+    "@fluidframework/request-handler": "~2.52.0",
+    "@fluidframework/runtime-definitions": "~2.52.0",
+    "@fluidframework/runtime-utils": "~2.52.0",
+    "@fluidframework/shared-object-base": "~2.52.0",
+    "@fluidframework/telemetry-utils": "~2.52.0",
+    "@fluidframework/tree": "~2.52.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.51.0",
-    "@fluid-tools/build-cli": "^0.56.0",
+    "@fluid-internal/mocha-test-setup": "~2.52.0",
+    "@fluid-tools/build-cli": "^0.57.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.56.0",
+    "@fluidframework/build-tools": "^0.57.0",
     "@fluidframework/eslint-config-fluid": "^5.7.4",
-    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.50.0",
-    "@fluidframework/map": "~2.51.0",
-    "@fluidframework/sequence": "~2.51.0",
+    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.51.0",
+    "@fluidframework/map": "~2.52.0",
+    "@fluidframework/sequence": "~2.52.0",
     "@microsoft/api-extractor": "7.52.8",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
@@ -109,6 +119,9 @@
     "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
     "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
+    "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "api-extractor run --local",
@@ -120,9 +133,14 @@
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
     "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
+    "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",