fluid-framework 2.0.2 → 2.1.0-276326

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 (8) hide show
  1. package/README.md +9 -0
  2. package/api-extractor/api-extractor.legacy.json +5 -0
  3. package/api-report/fluid-framework.beta.api.md +0 -27
  4. package/api-report/{fluid-framework.alpha.api.md → fluid-framework.legacy.alpha.api.md} +2 -27
  5. package/api-report/fluid-framework.public.api.md +0 -27
  6. package/dist/legacy.d.ts +1 -1
  7. package/lib/legacy.d.ts +1 -1
  8. package/package.json +19 -15
package/README.md CHANGED
@@ -50,6 +50,15 @@ To get started, install the package by running the following command:
50
50
  npm i fluid-framework
51
51
  ```
52
52
 
53
+ ## Importing from this package
54
+
55
+ This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
56
+ For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
57
+
58
+ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `fluid-framework` like normal.
59
+
60
+ To access the `legacy` APIs, import via `fluid-framework/legacy`.
61
+
53
62
  ## API Documentation
54
63
 
55
64
  API documentation for **fluid-framework** is available at <https://fluidframework.com/docs/apis/fluid-framework>.
package/api-extractor/api-extractor.legacy.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-base.esm.legacy.json",
4
+ "bundledPackages": ["@fluidframework/*"]
5
+ }
package/api-report/fluid-framework.beta.api.md CHANGED
@@ -4,33 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import { Client } from '@fluidframework/merge-tree/internal';
8
- import { IChannel } from '@fluidframework/datastore-definitions/internal';
9
- import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
10
- import { IJSONSegment } from '@fluidframework/merge-tree/internal';
11
- import { IMergeTreeDeltaCallbackArgs } from '@fluidframework/merge-tree/internal';
12
- import { IMergeTreeDeltaOpArgs } from '@fluidframework/merge-tree/internal';
13
- import { IMergeTreeGroupMsg } from '@fluidframework/merge-tree/internal';
14
- import { IMergeTreeMaintenanceCallbackArgs } from '@fluidframework/merge-tree/internal';
15
- import { IRelativePosition } from '@fluidframework/merge-tree/internal';
16
- import { ISegment } from '@fluidframework/merge-tree/internal';
17
- import { ISegmentAction } from '@fluidframework/merge-tree/internal';
18
- import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
19
- import { LocalReferencePosition } from '@fluidframework/merge-tree/internal';
20
- import { Marker } from '@fluidframework/merge-tree/internal';
21
- import { MergeTreeDeltaOperationType } from '@fluidframework/merge-tree/internal';
22
- import { MergeTreeDeltaOperationTypes } from '@fluidframework/merge-tree/internal';
23
- import { MergeTreeMaintenanceType } from '@fluidframework/merge-tree/internal';
24
- import { MergeTreeRevertibleDriver } from '@fluidframework/merge-tree/internal';
25
- import { PropertiesManager } from '@fluidframework/merge-tree/internal';
26
- import { PropertySet } from '@fluidframework/merge-tree/internal';
27
- import { ReferencePosition } from '@fluidframework/merge-tree/internal';
28
- import { ReferenceType } from '@fluidframework/merge-tree/internal';
29
- import { SharedObjectKind as SharedObjectKind_2 } from '@fluidframework/shared-object-base/internal';
30
- import { SlidingPreference } from '@fluidframework/merge-tree/internal';
31
- import { TextSegment } from '@fluidframework/merge-tree/internal';
32
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
33
-
34
7
  // @public
35
8
  export type AllowedTypes = readonly LazyItem<TreeNodeSchema>[];
36
9
 
package/api-report/{fluid-framework.alpha.api.md → fluid-framework.legacy.alpha.api.md} RENAMED
@@ -4,33 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import { Client } from '@fluidframework/merge-tree/internal';
8
- import { IChannel } from '@fluidframework/datastore-definitions/internal';
9
- import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
10
- import { IJSONSegment } from '@fluidframework/merge-tree/internal';
11
- import { IMergeTreeDeltaCallbackArgs } from '@fluidframework/merge-tree/internal';
12
- import { IMergeTreeDeltaOpArgs } from '@fluidframework/merge-tree/internal';
13
- import { IMergeTreeGroupMsg } from '@fluidframework/merge-tree/internal';
14
- import { IMergeTreeMaintenanceCallbackArgs } from '@fluidframework/merge-tree/internal';
15
- import { IRelativePosition } from '@fluidframework/merge-tree/internal';
16
- import { ISegment } from '@fluidframework/merge-tree/internal';
17
- import { ISegmentAction } from '@fluidframework/merge-tree/internal';
18
- import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
19
- import { LocalReferencePosition } from '@fluidframework/merge-tree/internal';
20
- import { Marker } from '@fluidframework/merge-tree/internal';
21
- import { MergeTreeDeltaOperationType } from '@fluidframework/merge-tree/internal';
22
- import { MergeTreeDeltaOperationTypes } from '@fluidframework/merge-tree/internal';
23
- import { MergeTreeMaintenanceType } from '@fluidframework/merge-tree/internal';
24
- import { MergeTreeRevertibleDriver } from '@fluidframework/merge-tree/internal';
25
- import { PropertiesManager } from '@fluidframework/merge-tree/internal';
26
- import { PropertySet } from '@fluidframework/merge-tree/internal';
27
- import { ReferencePosition } from '@fluidframework/merge-tree/internal';
28
- import { ReferenceType } from '@fluidframework/merge-tree/internal';
29
- import { SharedObjectKind as SharedObjectKind_2 } from '@fluidframework/shared-object-base/internal';
30
- import { SlidingPreference } from '@fluidframework/merge-tree/internal';
31
- import { TextSegment } from '@fluidframework/merge-tree/internal';
32
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
33
-
34
7
  // @public
35
8
  export type AllowedTypes = readonly LazyItem<TreeNodeSchema>[];
36
9
 
@@ -1328,4 +1301,6 @@ export interface WithType<TName extends string = string> {
1328
1301
  get [typeNameSymbol](): TName;
1329
1302
  }
1330
1303
 
1304
+ // (No @packageDocumentation comment for this package)
1305
+
1331
1306
  ```
package/api-report/fluid-framework.public.api.md CHANGED
@@ -4,33 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import { Client } from '@fluidframework/merge-tree/internal';
8
- import { IChannel } from '@fluidframework/datastore-definitions/internal';
9
- import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
10
- import { IJSONSegment } from '@fluidframework/merge-tree/internal';
11
- import { IMergeTreeDeltaCallbackArgs } from '@fluidframework/merge-tree/internal';
12
- import { IMergeTreeDeltaOpArgs } from '@fluidframework/merge-tree/internal';
13
- import { IMergeTreeGroupMsg } from '@fluidframework/merge-tree/internal';
14
- import { IMergeTreeMaintenanceCallbackArgs } from '@fluidframework/merge-tree/internal';
15
- import { IRelativePosition } from '@fluidframework/merge-tree/internal';
16
- import { ISegment } from '@fluidframework/merge-tree/internal';
17
- import { ISegmentAction } from '@fluidframework/merge-tree/internal';
18
- import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
19
- import { LocalReferencePosition } from '@fluidframework/merge-tree/internal';
20
- import { Marker } from '@fluidframework/merge-tree/internal';
21
- import { MergeTreeDeltaOperationType } from '@fluidframework/merge-tree/internal';
22
- import { MergeTreeDeltaOperationTypes } from '@fluidframework/merge-tree/internal';
23
- import { MergeTreeMaintenanceType } from '@fluidframework/merge-tree/internal';
24
- import { MergeTreeRevertibleDriver } from '@fluidframework/merge-tree/internal';
25
- import { PropertiesManager } from '@fluidframework/merge-tree/internal';
26
- import { PropertySet } from '@fluidframework/merge-tree/internal';
27
- import { ReferencePosition } from '@fluidframework/merge-tree/internal';
28
- import { ReferenceType } from '@fluidframework/merge-tree/internal';
29
- import { SharedObjectKind as SharedObjectKind_2 } from '@fluidframework/shared-object-base/internal';
30
- import { SlidingPreference } from '@fluidframework/merge-tree/internal';
31
- import { TextSegment } from '@fluidframework/merge-tree/internal';
32
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
33
-
34
7
  // @public
35
8
  export type AllowedTypes = readonly LazyItem<TreeNodeSchema>[];
36
9
 
package/dist/legacy.d.ts CHANGED
@@ -112,7 +112,7 @@ export {
112
112
  WithType,
113
113
  rollback,
114
114
 
115
- // @alpha APIs
115
+ // @legacy APIs
116
116
  DeserializeCallback,
117
117
  IBranchOrigin,
118
118
  IDirectory,
package/lib/legacy.d.ts CHANGED
@@ -112,7 +112,7 @@ export {
112
112
  WithType,
113
113
  rollback,
114
114
 
115
- // @alpha APIs
115
+ // @legacy APIs
116
116
  DeserializeCallback,
117
117
  IBranchOrigin,
118
118
  IDirectory,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fluid-framework",
3
- "version": "2.0.2",
3
+ "version": "2.1.0-276326",
4
4
  "description": "The main entry point into Fluid Framework public packages",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -37,15 +37,15 @@
37
37
  "main": "lib/index.js",
38
38
  "types": "lib/public.d.ts",
39
39
  "dependencies": {
40
- "@fluidframework/container-definitions": "~2.0.2",
41
- "@fluidframework/container-loader": "~2.0.2",
42
- "@fluidframework/core-interfaces": "~2.0.2",
43
- "@fluidframework/driver-definitions": "~2.0.2",
44
- "@fluidframework/fluid-static": "~2.0.2",
45
- "@fluidframework/map": "~2.0.2",
46
- "@fluidframework/sequence": "~2.0.2",
47
- "@fluidframework/shared-object-base": "~2.0.2",
48
- "@fluidframework/tree": "~2.0.2"
40
+ "@fluidframework/container-definitions": "2.1.0-276326",
41
+ "@fluidframework/container-loader": "2.1.0-276326",
42
+ "@fluidframework/core-interfaces": "2.1.0-276326",
43
+ "@fluidframework/driver-definitions": "2.1.0-276326",
44
+ "@fluidframework/fluid-static": "2.1.0-276326",
45
+ "@fluidframework/map": "2.1.0-276326",
46
+ "@fluidframework/sequence": "2.1.0-276326",
47
+ "@fluidframework/shared-object-base": "2.1.0-276326",
48
+ "@fluidframework/tree": "2.1.0-276326"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@arethetypeswrong/cli": "^0.15.2",
@@ -76,12 +76,14 @@
76
76
  },
77
77
  "scripts": {
78
78
  "api": "fluid-build . --task api",
79
- "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
80
- "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
79
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
80
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
81
81
  "build": "fluid-build . --task build",
82
82
  "build:commonjs": "fluid-build . --task commonjs",
83
83
  "build:compile": "fluid-build . --task compile",
84
- "build:docs": "api-extractor run --local",
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",
85
87
  "build:esnext": "tsc --project ./tsconfig.json",
86
88
  "check:are-the-types-wrong": "attw --pack .",
87
89
  "check:biome": "biome check . --formatter-enabled=true",
@@ -93,7 +95,9 @@
93
95
  "check:exports:esm:public": "echo AB#8288 skip api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
94
96
  "check:format": "npm run check:biome",
95
97
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
96
- "ci:build:docs": "api-extractor run",
98
+ "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
99
+ "ci:build:docs:current": "api-extractor run",
100
+ "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
97
101
  "clean": "rimraf --glob _api-extractor-temp dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\"",
98
102
  "eslint": "eslint --format stylish src",
99
103
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -103,7 +107,7 @@
103
107
  "lint": "fluid-build . --task lint",
104
108
  "lint:fix": "fluid-build . --task eslint:fix --task format",
105
109
  "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
106
- "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
110
+ "typetests:gen": "flub generate typetests --dir . -v",
107
111
  "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
108
112
  }
109
113
  }