@fluidframework/azure-client 2.118.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +128 -4
- package/README.md +57 -54
- package/{api-extractor.json → api-extractor/api-extractor-model.json} +1 -1
- package/api-report/azure-client.beta.api.md +5 -19
- package/api-report/azure-client.legacy.beta.api.md +5 -19
- package/api-report/azure-client.legacy.public.api.md +5 -19
- package/api-report/azure-client.public.api.md +5 -19
- package/dist/AzureAudience.js +1 -2
- package/dist/AzureAudience.js.map +1 -1
- package/dist/AzureClient.d.ts +1 -45
- package/dist/AzureClient.d.ts.map +1 -1
- package/dist/AzureClient.js +15 -18
- package/dist/AzureClient.js.map +1 -1
- package/dist/AzureUrlResolver.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +2 -2
- package/dist/public.d.ts +2 -2
- package/dist/utils.js +2 -3
- package/dist/utils.js.map +1 -1
- package/lib/AzureClient.d.ts +1 -45
- package/lib/AzureClient.d.ts.map +1 -1
- package/lib/AzureClient.js +16 -19
- package/lib/AzureClient.js.map +1 -1
- package/lib/AzureUrlResolver.d.ts.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/legacy.d.ts +3 -3
- package/lib/public.d.ts +3 -3
- package/package.json +43 -52
- package/src/AzureClient.ts +10 -81
- package/src/index.ts +3 -3
- package/tsconfig.json +1 -1
- package/internal.d.ts +0 -11
- package/legacy.d.ts +0 -11
- /package/api-extractor/{api-extractor.current.json → api-extractor-report.current.json} +0 -0
- /package/api-extractor/{api-extractor.legacy.json → api-extractor-report.legacy.json} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,136 @@
|
|
|
1
1
|
# @fluidframework/azure-client
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 3.0.0
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
### Minor Changes
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- Require oldest supported clients to use Fluid Framework 2.0 or later ([#28127](https://github.com/microsoft/FluidFramework/pull/28127)) [98956144ada](https://github.com/microsoft/FluidFramework/commit/98956144ada9cfc3a278e73adb2d5812b5ce2a67)
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Client 3.0 narrows
|
|
10
|
+
[`OldestSupportedClientVersion`](https://fluidframework.com/docs/api/runtime-definitions/oldestsupportedclientversion-typealias)
|
|
11
|
+
to stable 2.x versions and 3.x minor checkpoints whose patch is zero. The deprecated
|
|
12
|
+
[`MinimumVersionForCollab`](https://fluidframework.com/docs/api/runtime-definitions/minimumversionforcollab-typealias)
|
|
13
|
+
alias inherits the same restriction and remains available until Client 4.0.
|
|
14
|
+
|
|
15
|
+
Container runtimes now reject values below `"2.0.0"` and prerelease values. APIs that still
|
|
16
|
+
permit the setting to be omitted use `"2.0.0"`, with the same runtime defaults and validation
|
|
17
|
+
as explicitly passing `"2.0.0"`.
|
|
18
|
+
|
|
19
|
+
Before upgrading an application to Client 3.0, upgrade every active deployment that must
|
|
20
|
+
collaborate to Fluid Framework 2.0.0 or later. Explicit compatibility settings must use the
|
|
21
|
+
canonical property or Azure, ODSP, or Tinylicious service-client argument with a stable 2.x
|
|
22
|
+
version or a 3.x minor checkpoint such as `"3.1.0"`:
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
const { container } = await azureClient.getContainer(
|
|
26
|
+
id,
|
|
27
|
+
schema,
|
|
28
|
+
"2.0.0", // oldestSupportedClient
|
|
29
|
+
);
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
See [microsoft/FluidFramework#27460](https://github.com/microsoft/FluidFramework/issues/27460)
|
|
33
|
+
for migration context.
|
|
34
|
+
|
|
35
|
+
- Removal of direct CommonJS support ([#28124](https://github.com/microsoft/FluidFramework/pull/28124)) [0f84e3b8878](https://github.com/microsoft/FluidFramework/commit/0f84e3b8878a5e75b2253976d98fd963bbd9db88)
|
|
36
|
+
|
|
37
|
+
Direct `require()` import is no longer directly supported.
|
|
38
|
+
Package is transpiled as ECMAScript Module.
|
|
39
|
+
|
|
40
|
+
See [Removal of direct CommonJS support in v3.0](https://github.com/microsoft/FluidFramework/issues/27444) for more information.
|
|
41
|
+
|
|
42
|
+
- Remove deprecated compatibility mode APIs ([#27909](https://github.com/microsoft/FluidFramework/pull/27909)) [103cc0b7cbf](https://github.com/microsoft/FluidFramework/commit/103cc0b7cbf778d7d52ae1abc6e768107448836a)
|
|
43
|
+
|
|
44
|
+
Deprecated `CompatibilityMode` exports and overloads have been removed from `@fluidframework/fluid-static`, `@fluidframework/azure-client`, and `@fluidframework/tinylicious-client`.
|
|
45
|
+
|
|
46
|
+
Use `OldestSupportedClientVersion` SemVer strings instead:
|
|
47
|
+
- Pass `oldestSupportedClient` to `createTreeContainerRuntimeFactory`.
|
|
48
|
+
- Pass an `OldestSupportedClientVersion` as the `oldestSupportedClient` argument to `AzureClient.createContainer`, `AzureClient.getContainer`, `AzureClient.viewContainerVersion`, `TinyliciousClient.createContainer`, and `TinyliciousClient.getContainer`.
|
|
49
|
+
- Legacy mode `"1"` has no Client 3.0 equivalent. Upgrade every collaborating 1.x deployment before adopting Client 3.0.
|
|
50
|
+
- Replace legacy mode `"2"` with `oldestSupportedClient: "2.0.0"` or a later supported version.
|
|
51
|
+
|
|
52
|
+
Client 3.0 requires `oldestSupportedClient` values of `"2.0.0"` or later.
|
|
53
|
+
|
|
54
|
+
See [Remove `CompatibilityMode`](https://github.com/microsoft/FluidFramework/issues/23289) and [advance the minimum collaboration version to 2.0.0](https://github.com/microsoft/FluidFramework/issues/27460) for more information.
|
|
55
|
+
|
|
56
|
+
- Require modern TypeScript module resolution ([#27970](https://github.com/microsoft/FluidFramework/pull/27970)) [325e2016ca9](https://github.com/microsoft/FluidFramework/commit/325e2016ca9978d4a1f7552c97ba34feac9df41f)
|
|
57
|
+
|
|
58
|
+
Fluid Framework Client packages no longer include type declaration compatibility entrypoints for TypeScript's legacy Node10 resolution mode (`"moduleResolution": "node"` or `"node10"`).
|
|
59
|
+
Applications upgrading to Fluid Framework 3.0 must use one of the following supported configurations:
|
|
60
|
+
- `"module": "Node16"` with `"moduleResolution": "Node16"`
|
|
61
|
+
- `"module": "NodeNext"` with `"moduleResolution": "NodeNext"`
|
|
62
|
+
- `"module": "ESNext"` with `"moduleResolution": "Bundler"`
|
|
63
|
+
|
|
64
|
+
Existing public package entrypoints exposed through `package.json` exports, including `/alpha`, `/beta`, and `/legacy`, remain available under supported module resolution modes.
|
|
65
|
+
|
|
66
|
+
See [Removal of Node10 resolutions in v3.0](https://github.com/microsoft/FluidFramework/issues/27457) for more information.
|
|
67
|
+
|
|
68
|
+
- Require a log level for every telemetry event ([#27982](https://github.com/microsoft/FluidFramework/pull/27982)) [f2410e1380d](https://github.com/microsoft/FluidFramework/commit/f2410e1380db9e22717cbb4d87055d94480e3f1b)
|
|
69
|
+
|
|
70
|
+
The `logLevel` parameter of `ITelemetryBaseLogger.send` and the inherited `ITelemetryLoggerExt.send` is now required.
|
|
71
|
+
Callers must select a `LogLevel` for every event they log.
|
|
72
|
+
|
|
73
|
+
Explicitly specifying a level makes logging intent part of every call site, which enables consistent filtering and sampling of telemetry.
|
|
74
|
+
|
|
75
|
+
#### Migration for callers
|
|
76
|
+
|
|
77
|
+
Pass a `LogLevel` for every event.
|
|
78
|
+
To preserve the behavior of a call that previously omitted the level, use `LogLevel.essential`:
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import { LogLevel } from "@fluidframework/core-interfaces";
|
|
82
|
+
|
|
83
|
+
// Before
|
|
84
|
+
logger.send({ category: "generic", eventName: "ExampleEvent" });
|
|
85
|
+
|
|
86
|
+
// After
|
|
87
|
+
logger.send(
|
|
88
|
+
{ category: "generic", eventName: "ExampleEvent" },
|
|
89
|
+
LogLevel.essential,
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
#### Migration for logger implementations
|
|
94
|
+
|
|
95
|
+
This is a compile-time requirement on callers only; nothing about how events are dispatched at runtime has changed.
|
|
96
|
+
|
|
97
|
+
Logger implementations should keep declaring `logLevel` as optional and treat an omitted level as `LogLevel.essential`:
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
import {
|
|
101
|
+
LogLevel,
|
|
102
|
+
type ITelemetryBaseEvent,
|
|
103
|
+
type ITelemetryBaseLogger,
|
|
104
|
+
} from "@fluidframework/core-interfaces";
|
|
105
|
+
|
|
106
|
+
class MyLogger implements ITelemetryBaseLogger {
|
|
107
|
+
public send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void {
|
|
108
|
+
const level = logLevel ?? LogLevel.essential;
|
|
109
|
+
// ...
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Fluid supports running with a mix of package versions, so code compiled before `logLevel` became required still calls `send(event)` with a single argument, and will for as long as those versions are supported.
|
|
115
|
+
An implementation that assumes `logLevel` is always defined can therefore silently drop those events or handle them at the wrong level.
|
|
116
|
+
|
|
117
|
+
This layer-compatibility guidance can be retired only after the compatibility window for callers that may omit `logLevel` has closed in a future coordinated breaking change.
|
|
118
|
+
See the `ITelemetryBaseLogger` API documentation and [microsoft/FluidFramework#27595](https://github.com/microsoft/FluidFramework/issues/27595) for more information.
|
|
119
|
+
|
|
120
|
+
- Client packages now target ES2022 ([#27846](https://github.com/microsoft/FluidFramework/pull/27846)) [91c78541bdd](https://github.com/microsoft/FluidFramework/commit/91c78541bddcbca5d6c5f357b023eeaee617d885)
|
|
121
|
+
|
|
122
|
+
The TypeScript compilation `target` and `lib` for the Fluid Framework client packages have been raised from ES2021/ES2020 to **ES2022**.
|
|
123
|
+
The published JavaScript now uses ES2022 language features (with correspondingly less down-leveling), so consuming these packages requires a runtime that supports ES2022.
|
|
124
|
+
All actively supported Node.js versions and evergreen browsers already meet this requirement.
|
|
125
|
+
|
|
126
|
+
Note that Fluid Framework has not officially supported targets older than ES2022 since before 2.0: this is documented in [ClientRequirements.md](https://github.com/microsoft/FluidFramework/blob/main/ClientRequirements.md) as well as the README for every client package.
|
|
127
|
+
|
|
128
|
+
It is possible this change could impact users of less up to date JavaScript runtimes.
|
|
129
|
+
Impacted users can use a tool like [babel](https://babeljs.io/) to transpile out unsupported language features.
|
|
130
|
+
|
|
131
|
+
- Build with TypeScript 6 ([#28052](https://github.com/microsoft/FluidFramework/pull/28052)) [7ab015c49de](https://github.com/microsoft/FluidFramework/commit/7ab015c49deec84833cdfe1fb5e1606b901f6e81)
|
|
132
|
+
|
|
133
|
+
FluidFramework Client SDK is now built using TypeScript 6. Consumers should build with TypeScript v6 or v7 or compatible tooling.
|
|
10
134
|
|
|
11
135
|
## 2.116.0
|
|
12
136
|
|
package/README.md
CHANGED
|
@@ -9,15 +9,15 @@ The azure-client package provides a simple and powerful way to consume collabora
|
|
|
9
9
|
|
|
10
10
|
## Using Fluid Framework libraries
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
library consumers should always prefer `^`.
|
|
12
|
+
For a dependency on a Fluid Framework library's public APIs, we recommend a `^` (caret) version range.
|
|
13
|
+
For example, use `^1.3.4`.
|
|
15
14
|
|
|
16
|
-
|
|
15
|
+
For a dependency on an unstable API, such as a `beta` API, we recommend a more restrictive version range.
|
|
16
|
+
For example, use a `~` version range.
|
|
17
17
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Run this command to install the package:
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
npm i @fluidframework/azure-client
|
|
@@ -25,16 +25,16 @@ npm i @fluidframework/azure-client
|
|
|
25
25
|
|
|
26
26
|
## Importing from this package
|
|
27
27
|
|
|
28
|
-
This package
|
|
29
|
-
For
|
|
28
|
+
This package uses [package.json exports](https://nodejs.org/api/packages.html#exports) to separate APIs by support level.
|
|
29
|
+
For information about the support guarantees, read [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Import the `public` APIs from `@fluidframework/azure-client`.
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Import the `legacy` APIs from `@fluidframework/azure-client/legacy`.
|
|
34
34
|
|
|
35
35
|
## API Documentation
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
Read the **@fluidframework/azure-client** API documentation at <https://fluidframework.com/docs/apis/azure-client>.
|
|
38
38
|
|
|
39
39
|
<!-- prettier-ignore-end -->
|
|
40
40
|
|
|
@@ -129,7 +129,7 @@ const schema = {
|
|
|
129
129
|
],
|
|
130
130
|
};
|
|
131
131
|
const azureClient = new AzureClient(props);
|
|
132
|
-
const { container, services } = await azureClient.createContainer(schema, "2.100.0" /*
|
|
132
|
+
const { container, services } = await azureClient.createContainer(schema, "2.100.0" /* oldestSupportedClient */);
|
|
133
133
|
|
|
134
134
|
// Set any default data on the container's `initialObjects` before attaching
|
|
135
135
|
// Returned ID can be used to fetch the container via `getContainer` below
|
|
@@ -144,7 +144,7 @@ Using the `AzureClient` object the developer can create and get Fluid containers
|
|
|
144
144
|
import { AzureClient } from "@fluidframework/azure-client";
|
|
145
145
|
|
|
146
146
|
const azureClient = new AzureClient(props);
|
|
147
|
-
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /*
|
|
147
|
+
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
|
|
148
148
|
```
|
|
149
149
|
|
|
150
150
|
**Note:** When using the `AzureClient` with `tenantId` set to `"local"`, all containers that have been created will be deleted when the instance of the local Azure Fluid Relay service (not client) that was run from the terminal window is closed. However, any containers created when running against a remote Azure Fluid Relay service will be persisted. Container IDs **cannot** be reused between local and remote Azure Fluid Relay services to fetch back the same container.
|
|
@@ -166,7 +166,7 @@ const schema = {
|
|
|
166
166
|
};
|
|
167
167
|
|
|
168
168
|
// Fetch back the container that had been created earlier with the same ID and schema
|
|
169
|
-
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /*
|
|
169
|
+
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
|
|
170
170
|
|
|
171
171
|
// Get our list of initial objects that we had defined in the schema. initialObjects here will have the same signature
|
|
172
172
|
const initialObjects = container.initialObjects;
|
|
@@ -191,7 +191,7 @@ const schema = {
|
|
|
191
191
|
dynamicObjectTypes: [SharedString],
|
|
192
192
|
};
|
|
193
193
|
|
|
194
|
-
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /*
|
|
194
|
+
const { container, services } = await azureClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
|
|
195
195
|
const map1 = container.initialObjects.map1;
|
|
196
196
|
|
|
197
197
|
const text1 = await container.create(SharedString);
|
|
@@ -214,62 +214,69 @@ const text1 = await map1.get("text1-unique-id").get();
|
|
|
214
214
|
|
|
215
215
|
## Minimum Client Requirements
|
|
216
216
|
|
|
217
|
-
|
|
218
|
-
These requirements
|
|
219
|
-
|
|
217
|
+
Fluid Framework client libraries support the platforms in this document.
|
|
218
|
+
These requirements are intentionally restrictive.
|
|
219
|
+
Within a major version series, we can relax these requirements, but we cannot make them stricter.
|
|
220
|
+
For a Long Term Support (LTS) version, we might need to support these platforms for several years.
|
|
220
221
|
|
|
221
|
-
|
|
222
|
-
If
|
|
223
|
-
|
|
222
|
+
Other configurations can work, but Fluid Framework does not support them.
|
|
223
|
+
If an unsupported configuration stops working, we do not classify this as a bug.
|
|
224
|
+
To request support for a configuration that is not listed, file an issue.
|
|
225
|
+
The product team will evaluate your request.
|
|
226
|
+
In the issue, specify the current status of the configuration:
|
|
227
|
+
|
|
228
|
+
- The configuration works but needs official support.
|
|
229
|
+
- The configuration does not work and requires changes.
|
|
224
230
|
|
|
225
231
|
### Supported Runtimes
|
|
226
232
|
|
|
227
|
-
-
|
|
228
|
-
-
|
|
229
|
-
-
|
|
233
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
234
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
235
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
236
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
230
237
|
|
|
231
238
|
### Supported Tools
|
|
232
239
|
|
|
233
|
-
- TypeScript
|
|
234
|
-
-
|
|
235
|
-
-
|
|
236
|
-
- [
|
|
237
|
-
-
|
|
238
|
-
|
|
240
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
241
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
242
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
243
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
244
|
+
- Fluid Framework does not support [configuration options deprecated in TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0#breaking-changes-and-deprecations-in-typescript-6-0).
|
|
245
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
246
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
247
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
239
248
|
- [webpack](https://webpack.js.org/) 5
|
|
240
|
-
- We
|
|
241
|
-
Other bundlers
|
|
249
|
+
- We do not require a specific bundler.
|
|
250
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
242
251
|
|
|
243
252
|
### Module Resolution
|
|
244
253
|
|
|
245
|
-
[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution)
|
|
246
|
-
|
|
254
|
+
In TypeScript `compilerOptions`, use [`Node16`, `Node20`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) module resolution.
|
|
255
|
+
These settings follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
|
|
256
|
+
|
|
257
|
+
Do not use `Node10` module resolution.
|
|
247
258
|
|
|
248
259
|
### Module Formats
|
|
249
260
|
|
|
250
261
|
- ES Modules:
|
|
251
|
-
ES Modules
|
|
252
|
-
-
|
|
253
|
-
|
|
254
|
-
This is done to accommodate some workflows without good ES Module support.
|
|
255
|
-
If you have a workflow you would like included in this list, file an issue.
|
|
256
|
-
Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
|
|
257
|
-
|
|
258
|
-
- Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
|
|
262
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
263
|
+
- CommonJS:
|
|
264
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
259
265
|
|
|
260
266
|
## Contribution Guidelines
|
|
261
267
|
|
|
262
|
-
|
|
268
|
+
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
263
269
|
|
|
264
|
-
-
|
|
265
|
-
- [Submit
|
|
266
|
-
- Review
|
|
270
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
271
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
272
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
267
273
|
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
268
274
|
|
|
269
|
-
|
|
275
|
+
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
270
276
|
|
|
271
|
-
This project
|
|
272
|
-
For more information
|
|
277
|
+
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
278
|
+
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
279
|
+
For questions or comments, contact [opencode@microsoft.com](mailto:opencode@microsoft.com).
|
|
273
280
|
|
|
274
281
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
275
282
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -277,13 +284,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
|
|
|
277
284
|
|
|
278
285
|
## Help
|
|
279
286
|
|
|
280
|
-
|
|
281
|
-
Check out [fluidframework.com](https://fluidframework.com/docs/).
|
|
282
|
-
|
|
283
|
-
Still not finding what you're looking for?
|
|
284
|
-
Please [file an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md).
|
|
287
|
+
Read the [Fluid Framework documentation](https://fluidframework.com/docs/) for information about Fluid Framework concepts and APIs.
|
|
285
288
|
|
|
286
|
-
|
|
289
|
+
To request information that the documentation does not contain, [create an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md).
|
|
287
290
|
|
|
288
291
|
## Trademark
|
|
289
292
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-model.esm.json"
|
|
4
4
|
}
|
|
@@ -11,28 +11,14 @@ export class AzureClient {
|
|
|
11
11
|
container: IFluidContainer<TContainerSchema>;
|
|
12
12
|
services: AzureContainerServices;
|
|
13
13
|
}>;
|
|
14
|
-
// @deprecated
|
|
15
|
-
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
16
|
-
container: IFluidContainer<TContainerSchema>;
|
|
17
|
-
services: AzureContainerServices;
|
|
18
|
-
}>;
|
|
19
14
|
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
20
15
|
container: IFluidContainer<TContainerSchema>;
|
|
21
16
|
services: AzureContainerServices;
|
|
22
17
|
}>;
|
|
23
|
-
// @deprecated
|
|
24
|
-
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
25
|
-
container: IFluidContainer<TContainerSchema>;
|
|
26
|
-
services: AzureContainerServices;
|
|
27
|
-
}>;
|
|
28
18
|
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
29
19
|
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
30
20
|
container: IFluidContainer<TContainerSchema>;
|
|
31
21
|
}>;
|
|
32
|
-
// @deprecated
|
|
33
|
-
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
34
|
-
container: IFluidContainer<TContainerSchema>;
|
|
35
|
-
}>;
|
|
36
22
|
}
|
|
37
23
|
|
|
38
24
|
// @public
|
|
@@ -87,9 +73,6 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
|
87
73
|
type: "remote";
|
|
88
74
|
}
|
|
89
75
|
|
|
90
|
-
// @public @deprecated
|
|
91
|
-
export type CompatibilityMode = "1" | "2";
|
|
92
|
-
|
|
93
76
|
// @public
|
|
94
77
|
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
95
78
|
|
|
@@ -101,10 +84,10 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
|
|
|
101
84
|
eventName: string;
|
|
102
85
|
}
|
|
103
86
|
|
|
104
|
-
// @public
|
|
87
|
+
// @public @input
|
|
105
88
|
export interface ITelemetryBaseLogger {
|
|
106
89
|
minLogLevel?: LogLevel | undefined;
|
|
107
|
-
send(event: ITelemetryBaseEvent, logLevel
|
|
90
|
+
send(event: ITelemetryBaseEvent, logLevel: LogLevel): void;
|
|
108
91
|
}
|
|
109
92
|
|
|
110
93
|
// @public
|
|
@@ -125,4 +108,7 @@ export interface IUser {
|
|
|
125
108
|
id: string;
|
|
126
109
|
}
|
|
127
110
|
|
|
111
|
+
// @public @input
|
|
112
|
+
export type OldestSupportedClientVersion = `3.${bigint}.0` | `2.${bigint}.${bigint}`;
|
|
113
|
+
|
|
128
114
|
```
|
|
@@ -11,28 +11,14 @@ export class AzureClient {
|
|
|
11
11
|
container: IFluidContainer<TContainerSchema>;
|
|
12
12
|
services: AzureContainerServices;
|
|
13
13
|
}>;
|
|
14
|
-
// @deprecated
|
|
15
|
-
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
16
|
-
container: IFluidContainer<TContainerSchema>;
|
|
17
|
-
services: AzureContainerServices;
|
|
18
|
-
}>;
|
|
19
14
|
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
20
15
|
container: IFluidContainer<TContainerSchema>;
|
|
21
16
|
services: AzureContainerServices;
|
|
22
17
|
}>;
|
|
23
|
-
// @deprecated
|
|
24
|
-
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
25
|
-
container: IFluidContainer<TContainerSchema>;
|
|
26
|
-
services: AzureContainerServices;
|
|
27
|
-
}>;
|
|
28
18
|
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
29
19
|
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
30
20
|
container: IFluidContainer<TContainerSchema>;
|
|
31
21
|
}>;
|
|
32
|
-
// @deprecated
|
|
33
|
-
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
34
|
-
container: IFluidContainer<TContainerSchema>;
|
|
35
|
-
}>;
|
|
36
22
|
}
|
|
37
23
|
|
|
38
24
|
// @public
|
|
@@ -87,9 +73,6 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
|
87
73
|
type: "remote";
|
|
88
74
|
}
|
|
89
75
|
|
|
90
|
-
// @public @deprecated
|
|
91
|
-
export type CompatibilityMode = "1" | "2";
|
|
92
|
-
|
|
93
76
|
// @public
|
|
94
77
|
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
95
78
|
|
|
@@ -101,10 +84,10 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
|
|
|
101
84
|
eventName: string;
|
|
102
85
|
}
|
|
103
86
|
|
|
104
|
-
// @public
|
|
87
|
+
// @public @input
|
|
105
88
|
export interface ITelemetryBaseLogger {
|
|
106
89
|
minLogLevel?: LogLevel | undefined;
|
|
107
|
-
send(event: ITelemetryBaseEvent, logLevel
|
|
90
|
+
send(event: ITelemetryBaseEvent, logLevel: LogLevel): void;
|
|
108
91
|
}
|
|
109
92
|
|
|
110
93
|
// @public
|
|
@@ -125,4 +108,7 @@ export interface IUser {
|
|
|
125
108
|
id: string;
|
|
126
109
|
}
|
|
127
110
|
|
|
111
|
+
// @public @input
|
|
112
|
+
export type OldestSupportedClientVersion = `3.${bigint}.0` | `2.${bigint}.${bigint}`;
|
|
113
|
+
|
|
128
114
|
```
|
|
@@ -11,28 +11,14 @@ export class AzureClient {
|
|
|
11
11
|
container: IFluidContainer<TContainerSchema>;
|
|
12
12
|
services: AzureContainerServices;
|
|
13
13
|
}>;
|
|
14
|
-
// @deprecated
|
|
15
|
-
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
16
|
-
container: IFluidContainer<TContainerSchema>;
|
|
17
|
-
services: AzureContainerServices;
|
|
18
|
-
}>;
|
|
19
14
|
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
20
15
|
container: IFluidContainer<TContainerSchema>;
|
|
21
16
|
services: AzureContainerServices;
|
|
22
17
|
}>;
|
|
23
|
-
// @deprecated
|
|
24
|
-
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
25
|
-
container: IFluidContainer<TContainerSchema>;
|
|
26
|
-
services: AzureContainerServices;
|
|
27
|
-
}>;
|
|
28
18
|
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
29
19
|
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
30
20
|
container: IFluidContainer<TContainerSchema>;
|
|
31
21
|
}>;
|
|
32
|
-
// @deprecated
|
|
33
|
-
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
34
|
-
container: IFluidContainer<TContainerSchema>;
|
|
35
|
-
}>;
|
|
36
22
|
}
|
|
37
23
|
|
|
38
24
|
// @public
|
|
@@ -87,9 +73,6 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
|
87
73
|
type: "remote";
|
|
88
74
|
}
|
|
89
75
|
|
|
90
|
-
// @public @deprecated
|
|
91
|
-
export type CompatibilityMode = "1" | "2";
|
|
92
|
-
|
|
93
76
|
// @public
|
|
94
77
|
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
95
78
|
|
|
@@ -101,10 +84,10 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
|
|
|
101
84
|
eventName: string;
|
|
102
85
|
}
|
|
103
86
|
|
|
104
|
-
// @public
|
|
87
|
+
// @public @input
|
|
105
88
|
export interface ITelemetryBaseLogger {
|
|
106
89
|
minLogLevel?: LogLevel | undefined;
|
|
107
|
-
send(event: ITelemetryBaseEvent, logLevel
|
|
90
|
+
send(event: ITelemetryBaseEvent, logLevel: LogLevel): void;
|
|
108
91
|
}
|
|
109
92
|
|
|
110
93
|
// @public
|
|
@@ -125,4 +108,7 @@ export interface IUser {
|
|
|
125
108
|
id: string;
|
|
126
109
|
}
|
|
127
110
|
|
|
111
|
+
// @public @input
|
|
112
|
+
export type OldestSupportedClientVersion = `3.${bigint}.0` | `2.${bigint}.${bigint}`;
|
|
113
|
+
|
|
128
114
|
```
|
|
@@ -11,28 +11,14 @@ export class AzureClient {
|
|
|
11
11
|
container: IFluidContainer<TContainerSchema>;
|
|
12
12
|
services: AzureContainerServices;
|
|
13
13
|
}>;
|
|
14
|
-
// @deprecated
|
|
15
|
-
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
16
|
-
container: IFluidContainer<TContainerSchema>;
|
|
17
|
-
services: AzureContainerServices;
|
|
18
|
-
}>;
|
|
19
14
|
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
20
15
|
container: IFluidContainer<TContainerSchema>;
|
|
21
16
|
services: AzureContainerServices;
|
|
22
17
|
}>;
|
|
23
|
-
// @deprecated
|
|
24
|
-
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
25
|
-
container: IFluidContainer<TContainerSchema>;
|
|
26
|
-
services: AzureContainerServices;
|
|
27
|
-
}>;
|
|
28
18
|
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
29
19
|
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, oldestSupportedClient: OldestSupportedClientVersion): Promise<{
|
|
30
20
|
container: IFluidContainer<TContainerSchema>;
|
|
31
21
|
}>;
|
|
32
|
-
// @deprecated
|
|
33
|
-
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
34
|
-
container: IFluidContainer<TContainerSchema>;
|
|
35
|
-
}>;
|
|
36
22
|
}
|
|
37
23
|
|
|
38
24
|
// @public
|
|
@@ -87,9 +73,6 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
|
87
73
|
type: "remote";
|
|
88
74
|
}
|
|
89
75
|
|
|
90
|
-
// @public @deprecated
|
|
91
|
-
export type CompatibilityMode = "1" | "2";
|
|
92
|
-
|
|
93
76
|
// @public
|
|
94
77
|
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
95
78
|
|
|
@@ -101,10 +84,10 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
|
|
|
101
84
|
eventName: string;
|
|
102
85
|
}
|
|
103
86
|
|
|
104
|
-
// @public
|
|
87
|
+
// @public @input
|
|
105
88
|
export interface ITelemetryBaseLogger {
|
|
106
89
|
minLogLevel?: LogLevel | undefined;
|
|
107
|
-
send(event: ITelemetryBaseEvent, logLevel
|
|
90
|
+
send(event: ITelemetryBaseEvent, logLevel: LogLevel): void;
|
|
108
91
|
}
|
|
109
92
|
|
|
110
93
|
// @public
|
|
@@ -125,4 +108,7 @@ export interface IUser {
|
|
|
125
108
|
id: string;
|
|
126
109
|
}
|
|
127
110
|
|
|
111
|
+
// @public @input
|
|
112
|
+
export type OldestSupportedClientVersion = `3.${bigint}.0` | `2.${bigint}.${bigint}`;
|
|
113
|
+
|
|
128
114
|
```
|
package/dist/AzureAudience.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.createAzureAudienceMember =
|
|
7
|
+
exports.createAzureAudienceMember = createAzureAudienceMember;
|
|
8
8
|
/**
|
|
9
9
|
* Creates Azure-specific audience member.
|
|
10
10
|
*
|
|
@@ -21,7 +21,6 @@ function createAzureAudienceMember(audienceMember) {
|
|
|
21
21
|
additionalDetails: user.additionalDetails,
|
|
22
22
|
};
|
|
23
23
|
}
|
|
24
|
-
exports.createAzureAudienceMember = createAzureAudienceMember;
|
|
25
24
|
/**
|
|
26
25
|
* Asserts that the provided {@link @fluidframework/protocol-definitions#IUser} is an {@link AzureUser}.
|
|
27
26
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureAudience.js","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG
|
|
1
|
+
{"version":3,"file":"AzureAudience.js","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAYH,8DAUC;AAhBD;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,cAAuB;IAChE,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;IACjC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO;QACN,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,WAAW,EAAE,EAAE;QACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;KACzC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,IAAW;IACrC,MAAM,cAAc,GAAG,IAA0B,CAAC;IAClD,MAAM,WAAW,GAAG,4CAA4C,CAAC;IACjE,IAAI,cAAc,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,oCAAoC,CAAC,CAAC;IACzE,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IClient, IUser } from \"@fluidframework/driver-definitions\";\n\nimport type { AzureMember, AzureUser } from \"./interfaces.js\";\n\n/**\n * Creates Azure-specific audience member.\n *\n * @remarks\n * The provided `audienceMember`'s {@link @fluidframework/protocol-definitions#IClient.user} must be an {@link AzureUser}.\n */\nexport function createAzureAudienceMember(audienceMember: IClient): AzureMember {\n\tconst user = audienceMember.user;\n\tassertIsAzureUser(user);\n\n\treturn {\n\t\tid: user.id,\n\t\tname: user.name,\n\t\tconnections: [],\n\t\tadditionalDetails: user.additionalDetails,\n\t};\n}\n\n/**\n * Asserts that the provided {@link @fluidframework/protocol-definitions#IUser} is an {@link AzureUser}.\n */\nfunction assertIsAzureUser(user: IUser): asserts user is AzureUser<unknown> {\n\tconst maybeAzureUser = user as Partial<AzureUser>;\n\tconst baseMessage = 'Provided user data was not an \"AzureUser\".';\n\tif (maybeAzureUser.id === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"id\" property.`);\n\t}\n\tif (maybeAzureUser.name === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"name\" property.`);\n\t}\n}\n"]}
|