@fluidframework/driver-definitions 2.1.0-276326 → 2.1.0-281041
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/README.md +3 -1
- package/api-extractor/api-extractor.current.json +5 -0
- package/api-extractor/api-extractor.legacy.json +1 -1
- package/api-extractor.json +1 -1
- package/api-report/driver-definitions.legacy.public.api.md +120 -0
- package/dist/legacy.d.ts +1 -1
- package/dist/public.d.ts +1 -1
- package/internal.d.ts +1 -1
- package/legacy.d.ts +1 -1
- package/lib/legacy.d.ts +1 -1
- package/lib/public.d.ts +1 -1
- package/package.json +16 -14
package/README.md
CHANGED
|
@@ -9,10 +9,12 @@ Interfaces for Fluid Drivers
|
|
|
9
9
|
|
|
10
10
|
## Using Fluid Framework libraries
|
|
11
11
|
|
|
12
|
-
When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
12
|
+
When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
13
13
|
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
|
|
14
14
|
library consumers should always prefer `^`.
|
|
15
15
|
|
|
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
|
+
|
|
16
18
|
<!-- prettier-ignore-end -->
|
|
17
19
|
|
|
18
20
|
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
@@ -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
|
+
}
|
|
@@ -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-
|
|
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-
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-model.esm.json"
|
|
4
4
|
}
|
|
@@ -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
package/dist/public.d.ts
CHANGED
package/internal.d.ts
CHANGED
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 @
|
|
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
package/lib/public.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/driver-definitions",
|
|
3
|
-
"version": "2.1.0-
|
|
3
|
+
"version": "2.1.0-281041",
|
|
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-
|
|
50
|
+
"@fluidframework/core-interfaces": "2.1.0-281041"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
54
|
-
"@biomejs/biome": "
|
|
55
|
-
"@fluid-tools/build-cli": "^0.
|
|
54
|
+
"@biomejs/biome": "~1.8.3",
|
|
55
|
+
"@fluid-tools/build-cli": "^0.40.0",
|
|
56
56
|
"@fluidframework/build-common": "^2.0.3",
|
|
57
|
-
"@fluidframework/build-tools": "^0.
|
|
58
|
-
"@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.0.0
|
|
57
|
+
"@fluidframework/build-tools": "^0.40.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": "
|
|
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 .
|
|
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:
|
|
100
|
-
"ci:build:
|
|
101
|
-
"ci:build:
|
|
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 . --
|
|
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",
|