@fluidframework/driver-definitions 2.1.0-276985 → 2.1.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.
Files changed (13) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +93 -2
  3. package/api-extractor/api-extractor.current.json +5 -0
  4. package/api-extractor/api-extractor.legacy.json +1 -1
  5. package/api-extractor.json +1 -1
  6. package/api-report/driver-definitions.legacy.public.api.md +120 -0
  7. package/dist/legacy.d.ts +1 -1
  8. package/dist/public.d.ts +1 -1
  9. package/internal.d.ts +1 -1
  10. package/legacy.d.ts +1 -1
  11. package/lib/legacy.d.ts +1 -1
  12. package/lib/public.d.ts +1 -1
  13. package/package.json +16 -14
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/driver-definitions
2
2
 
3
+ ## 2.1.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-rc.5.0.0
4
8
 
5
9
  ### Minor Changes
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Interfaces for Fluid Drivers
4
4
 
5
- <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
5
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
6
6
 
7
7
  <!-- prettier-ignore-start -->
8
8
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -15,15 +15,106 @@ library consumers should always prefer `^`.
15
15
 
16
16
  If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
17
17
 
18
+ ## Installation
19
+
20
+ To get started, install the package by running the following command:
21
+
22
+ ```bash
23
+ npm i @fluidframework/driver-definitions
24
+ ```
25
+
26
+ ## Importing from this package
27
+
28
+ This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
29
+ For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
30
+
31
+ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/driver-definitions` like normal.
32
+
33
+ To access the `legacy` APIs, import via `@fluidframework/driver-definitions/legacy`.
34
+
35
+ ## API Documentation
36
+
37
+ API documentation for **@fluidframework/driver-definitions** is available at <https://fluidframework.com/docs/apis/driver-definitions>.
38
+
18
39
  <!-- prettier-ignore-end -->
19
40
 
20
41
  <!-- AUTO-GENERATED-CONTENT:END -->
21
42
 
22
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
43
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
23
44
 
24
45
  <!-- prettier-ignore-start -->
25
46
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
26
47
 
48
+ ## Minimum Client Requirements
49
+
50
+ These are the platform requirements for the current version of Fluid Framework Client Packages.
51
+ These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
52
+ For Long Term Support (LTS) versions this can require supporting these platforms for several years.
53
+
54
+ It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
55
+ If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
56
+ When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.
57
+
58
+ ### Supported Runtimes
59
+
60
+ - NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
61
+ - Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).
62
+
63
+ ### Supported Tools
64
+
65
+ - TypeScript 5.4:
66
+ - All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
67
+ - [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
68
+ - [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
69
+ - `exactOptionalPropertyTypes` is currently not fully supported.
70
+ If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
71
+ - [webpack](https://webpack.js.org/) 5
72
+ - We are not intending to be prescriptive about what bundler to use.
73
+ Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
74
+
75
+ ### Module Resolution
76
+
77
+ [`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
78
+ Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.
79
+
80
+ ### Module Formats
81
+
82
+ - ES Modules:
83
+ ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
84
+ - CommonJs:
85
+ Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
86
+ This is done to accommodate some workflows without good ES Module support.
87
+ If you have a workflow you would like included in this list, file an issue.
88
+ 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.
89
+
90
+ - 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))
91
+
92
+ ## Contribution Guidelines
93
+
94
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
95
+
96
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
97
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
98
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
99
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
100
+
101
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
102
+
103
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
104
+ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
105
+
106
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
107
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
108
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
109
+
110
+ ## Help
111
+
112
+ Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
113
+
114
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
115
+
116
+ Thank you!
117
+
27
118
  ## Trademark
28
119
 
29
120
  This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
package/api-extractor/api-extractor.current.json ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
4
+ "mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
5
+ }
package/api-extractor/api-extractor.legacy.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-base.esm.legacy.json"
3
+ "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
4
4
  }
package/api-extractor.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-model.esm.json"
4
4
  }
package/api-report/driver-definitions.legacy.public.api.md ADDED
@@ -0,0 +1,120 @@
1
+ ## Public API Report File for "@fluidframework/driver-definitions"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ // @public
8
+ export type ConnectionMode = "write" | "read";
9
+
10
+ // @public
11
+ export interface ICapabilities {
12
+ interactive: boolean;
13
+ }
14
+
15
+ // @public
16
+ export interface IClient {
17
+ details: IClientDetails;
18
+ mode: ConnectionMode;
19
+ // (undocumented)
20
+ permission: string[];
21
+ scopes: string[];
22
+ timestamp?: number;
23
+ user: IUser;
24
+ }
25
+
26
+ // @public
27
+ export interface IClientDetails {
28
+ capabilities: ICapabilities;
29
+ // (undocumented)
30
+ device?: string;
31
+ // (undocumented)
32
+ environment?: string;
33
+ type?: string;
34
+ }
35
+
36
+ // @public
37
+ export interface IQuorumClients {
38
+ // (undocumented)
39
+ getMember(clientId: string): ISequencedClient | undefined;
40
+ // (undocumented)
41
+ getMembers(): Map<string, ISequencedClient>;
42
+ // (undocumented)
43
+ off: IQuorumClients["on"];
44
+ // (undocumented)
45
+ on(event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;
46
+ // (undocumented)
47
+ on(event: "removeMember", listener: (clientId: string) => void): any;
48
+ // (undocumented)
49
+ on(event: "error", listener: (message: any) => void): any;
50
+ // (undocumented)
51
+ once: IQuorumClients["on"];
52
+ }
53
+
54
+ // @public
55
+ export interface ISequencedClient {
56
+ client: IClient;
57
+ sequenceNumber: number;
58
+ }
59
+
60
+ // @public
61
+ export interface ISummaryAttachment {
62
+ // (undocumented)
63
+ id: string;
64
+ // (undocumented)
65
+ type: SummaryType.Attachment;
66
+ }
67
+
68
+ // @public
69
+ export interface ISummaryBlob {
70
+ // (undocumented)
71
+ content: string | Uint8Array;
72
+ // (undocumented)
73
+ type: SummaryType.Blob;
74
+ }
75
+
76
+ // @public
77
+ export interface ISummaryHandle {
78
+ handle: string;
79
+ handleType: SummaryTypeNoHandle;
80
+ // (undocumented)
81
+ type: SummaryType.Handle;
82
+ }
83
+
84
+ // @public
85
+ export interface ISummaryTree {
86
+ groupId?: string;
87
+ // (undocumented)
88
+ tree: {
89
+ [path: string]: SummaryObject;
90
+ };
91
+ // (undocumented)
92
+ type: SummaryType.Tree;
93
+ unreferenced?: true;
94
+ }
95
+
96
+ // @public
97
+ export interface IUser {
98
+ id: string;
99
+ }
100
+
101
+ // @public
102
+ export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
103
+
104
+ // @public
105
+ export namespace SummaryType {
106
+ const Tree: Tree;
107
+ const Blob: Blob;
108
+ const Handle: Handle;
109
+ const Attachment: Attachment;
110
+ }
111
+
112
+ // @public
113
+ export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
114
+
115
+ // @public
116
+ export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
117
+
118
+ // (No @packageDocumentation comment for this package)
119
+
120
+ ```
package/dist/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/dist/public.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/internal.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export * from "./lib/index.js";
package/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export * from "./lib/legacy.js";
package/lib/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/lib/public.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/driver-definitions",
3
- "version": "2.1.0-276985",
3
+ "version": "2.1.0",
4
4
  "description": "Fluid driver definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,15 +47,15 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/core-interfaces": "2.1.0-276985"
50
+ "@fluidframework/core-interfaces": "~2.1.0"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@arethetypeswrong/cli": "^0.15.2",
54
- "@biomejs/biome": "^1.7.3",
55
- "@fluid-tools/build-cli": "^0.39.0",
54
+ "@biomejs/biome": "~1.8.3",
55
+ "@fluid-tools/build-cli": "^0.41.0",
56
56
  "@fluidframework/build-common": "^2.0.3",
57
- "@fluidframework/build-tools": "^0.39.0",
58
- "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.0.0-rc.5.0.0",
57
+ "@fluidframework/build-tools": "^0.41.0",
58
+ "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.0.0",
59
59
  "@fluidframework/eslint-config-fluid": "^5.3.0",
60
60
  "@microsoft/api-extractor": "^7.45.1",
61
61
  "concurrently": "^8.2.1",
@@ -80,13 +80,14 @@
80
80
  "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
81
81
  "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
82
82
  "build": "fluid-build . --task build",
83
+ "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
84
+ "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
85
+ "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
83
86
  "build:compile": "fluid-build . --task compile",
84
- "build:docs": "concurrently \"npm:build:docs:*\"",
85
- "build:docs:current": "api-extractor run --local",
86
- "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
87
+ "build:docs": "api-extractor run --local",
87
88
  "build:esnext": "tsc --project ./tsconfig.json",
88
89
  "check:are-the-types-wrong": "attw --pack .",
89
- "check:biome": "biome check . --formatter-enabled=true",
90
+ "check:biome": "biome check .",
90
91
  "check:exports": "concurrently \"npm:check:exports:*\"",
91
92
  "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
92
93
  "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
@@ -96,16 +97,17 @@
96
97
  "check:format": "npm run check:biome",
97
98
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
98
99
  "ci:build": "npm run build:compile",
99
- "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
100
- "ci:build:docs:current": "api-extractor run",
101
- "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
100
+ "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
101
+ "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
102
+ "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
103
+ "ci:build:docs": "api-extractor run",
102
104
  "ci:test": "echo No test for this package",
103
105
  "ci:test:coverage": "echo No test for this package",
104
106
  "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
105
107
  "eslint": "eslint --format stylish src",
106
108
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
107
109
  "format": "npm run format:biome",
108
- "format:biome": "biome check . --formatter-enabled=true --apply",
110
+ "format:biome": "biome check . --write",
109
111
  "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
110
112
  "lint": "fluid-build . --task lint",
111
113
  "lint:fix": "fluid-build . --task eslint:fix --task format",