@fluidframework/sequence 2.11.0 → 2.12.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 (9) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/dist/packageVersion.d.ts +1 -1
  3. package/dist/packageVersion.js +1 -1
  4. package/dist/packageVersion.js.map +1 -1
  5. package/lib/packageVersion.d.ts +1 -1
  6. package/lib/packageVersion.js +1 -1
  7. package/lib/packageVersion.js.map +1 -1
  8. package/package.json +18 -18
  9. package/src/packageVersion.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,46 @@
1
1
  # @fluidframework/sequence
2
2
 
3
+ ## 2.12.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Merge-Tree and SharedString ISegment Deprecations ([#23323](https://github.com/microsoft/FluidFramework/pull/23323)) [e8762e37cd](https://github.com/microsoft/FluidFramework/commit/e8762e37cd5edbad36b78b5a40d62a730522e18f)
8
+
9
+ The current ISegment interface over-exposes a number of properties which do not have an external use case, and any external usage could result in damage to the underlying merge-tree including data corruption.
10
+
11
+ The only use case that will continue to be supported is determining if a segment is removed. For this purpose we've added the free function `segmentIsRemoved(segment: ISegment): boolean`.
12
+
13
+ For example, checking if a segment is not removed would change as follows:
14
+
15
+ ```diff
16
+ - if(segment.removedSeq === undefined){
17
+ + if(!segmentIsRemoved(segment)){
18
+ ```
19
+
20
+ The following properties are deprecated on ISegment and its implementations:
21
+
22
+ - clientId
23
+ - index
24
+ - localMovedSeq
25
+ - localRefs
26
+ - localRemovedSeq
27
+ - localSeq
28
+ - movedClientsIds
29
+ - movedSeq
30
+ - movedSeqs
31
+ - ordinal
32
+ - removedClientIds
33
+ - removedSeq
34
+ - seq
35
+ - wasMovedOnInsert
36
+
37
+ Additionally, the following types are also deprecated, and will become internal (i.e. users of the Fluid Framework will not have access to them):
38
+
39
+ - IMergeNodeCommon
40
+ - IMoveInfo
41
+ - IRemovalInfo
42
+ - LocalReferenceCollection
43
+
3
44
  ## 2.11.0
4
45
 
5
46
  Dependency updates only.
package/dist/packageVersion.d.ts CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/sequence";
8
- export declare const pkgVersion = "2.11.0";
8
+ export declare const pkgVersion = "2.12.0";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
package/dist/packageVersion.js CHANGED
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/sequence";
11
- exports.pkgVersion = "2.11.0";
11
+ exports.pkgVersion = "2.12.0";
12
12
  //# sourceMappingURL=packageVersion.js.map
package/dist/packageVersion.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.11.0\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.12.0\";\n"]}
package/lib/packageVersion.d.ts CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/sequence";
8
- export declare const pkgVersion = "2.11.0";
8
+ export declare const pkgVersion = "2.12.0";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
package/lib/packageVersion.js CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/sequence";
8
- export const pkgVersion = "2.11.0";
8
+ export const pkgVersion = "2.12.0";
9
9
  //# sourceMappingURL=packageVersion.js.map
package/lib/packageVersion.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.11.0\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.12.0\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/sequence",
3
- "version": "2.11.0",
3
+ "version": "2.12.0",
4
4
  "description": "Distributed sequence",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -79,33 +79,33 @@
79
79
  "temp-directory": "nyc/.nyc_output"
80
80
  },
81
81
  "dependencies": {
82
- "@fluid-internal/client-utils": "~2.11.0",
83
- "@fluidframework/core-interfaces": "~2.11.0",
84
- "@fluidframework/core-utils": "~2.11.0",
85
- "@fluidframework/datastore-definitions": "~2.11.0",
86
- "@fluidframework/driver-definitions": "~2.11.0",
87
- "@fluidframework/merge-tree": "~2.11.0",
88
- "@fluidframework/runtime-definitions": "~2.11.0",
89
- "@fluidframework/runtime-utils": "~2.11.0",
90
- "@fluidframework/shared-object-base": "~2.11.0",
91
- "@fluidframework/telemetry-utils": "~2.11.0",
82
+ "@fluid-internal/client-utils": "~2.12.0",
83
+ "@fluidframework/core-interfaces": "~2.12.0",
84
+ "@fluidframework/core-utils": "~2.12.0",
85
+ "@fluidframework/datastore-definitions": "~2.12.0",
86
+ "@fluidframework/driver-definitions": "~2.12.0",
87
+ "@fluidframework/merge-tree": "~2.12.0",
88
+ "@fluidframework/runtime-definitions": "~2.12.0",
89
+ "@fluidframework/runtime-utils": "~2.12.0",
90
+ "@fluidframework/shared-object-base": "~2.12.0",
91
+ "@fluidframework/telemetry-utils": "~2.12.0",
92
92
  "double-ended-queue": "^2.1.0-0",
93
93
  "uuid": "^9.0.0"
94
94
  },
95
95
  "devDependencies": {
96
- "@arethetypeswrong/cli": "^0.16.4",
96
+ "@arethetypeswrong/cli": "^0.17.1",
97
97
  "@biomejs/biome": "~1.9.3",
98
- "@fluid-internal/mocha-test-setup": "~2.11.0",
99
- "@fluid-private/stochastic-test-utils": "~2.11.0",
100
- "@fluid-private/test-dds-utils": "~2.11.0",
98
+ "@fluid-internal/mocha-test-setup": "~2.12.0",
99
+ "@fluid-private/stochastic-test-utils": "~2.12.0",
100
+ "@fluid-private/test-dds-utils": "~2.12.0",
101
101
  "@fluid-tools/benchmark": "^0.50.0",
102
102
  "@fluid-tools/build-cli": "^0.51.0",
103
103
  "@fluidframework/build-common": "^2.0.3",
104
104
  "@fluidframework/build-tools": "^0.51.0",
105
- "@fluidframework/container-definitions": "~2.11.0",
105
+ "@fluidframework/container-definitions": "~2.12.0",
106
106
  "@fluidframework/eslint-config-fluid": "^5.6.0",
107
- "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.10.0",
108
- "@fluidframework/test-runtime-utils": "~2.11.0",
107
+ "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.11.0",
108
+ "@fluidframework/test-runtime-utils": "~2.12.0",
109
109
  "@microsoft/api-extractor": "7.47.8",
110
110
  "@types/diff": "^3.5.1",
111
111
  "@types/double-ended-queue": "^2.1.0",
package/src/packageVersion.ts CHANGED
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/sequence";
9
- export const pkgVersion = "2.11.0";
9
+ export const pkgVersion = "2.12.0";