@fluidframework/runtime-definitions 2.72.0 → 2.73.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 (11) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/runtime-definitions.legacy.alpha.api.md +1 -1
  3. package/api-report/runtime-definitions.legacy.beta.api.md +1 -1
  4. package/dist/compatibilityDefinitions.d.ts +21 -1
  5. package/dist/compatibilityDefinitions.d.ts.map +1 -1
  6. package/dist/compatibilityDefinitions.js.map +1 -1
  7. package/lib/compatibilityDefinitions.d.ts +21 -1
  8. package/lib/compatibilityDefinitions.d.ts.map +1 -1
  9. package/lib/compatibilityDefinitions.js.map +1 -1
  10. package/package.json +8 -8
  11. package/src/compatibilityDefinitions.ts +21 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/runtime-definitions
2
2
 
3
+ ## 2.73.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.72.0
4
8
 
5
9
  Dependency updates only.
package/api-report/runtime-definitions.legacy.alpha.api.md CHANGED
@@ -397,7 +397,7 @@ export interface LocalAttributionKey {
397
397
  type: "local";
398
398
  }
399
399
 
400
- // @beta @legacy
400
+ // @beta @legacy @input
401
401
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
402
402
 
403
403
  // @beta @legacy
package/api-report/runtime-definitions.legacy.beta.api.md CHANGED
@@ -388,7 +388,7 @@ export interface LocalAttributionKey {
388
388
  type: "local";
389
389
  }
390
390
 
391
- // @beta @legacy
391
+ // @beta @legacy @input
392
392
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
393
393
 
394
394
  // @beta @legacy
package/dist/compatibilityDefinitions.d.ts CHANGED
@@ -3,8 +3,28 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  /**
6
- * String in a valid semver format of a specific version at least specifying minor.
6
+ * Oldest version of Fluid Framework client packages to support collaborating with.
7
+ * @remarks
8
+ * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.
7
9
  *
10
+ * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.
11
+ *
12
+ * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.
13
+ *
14
+ * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.
15
+ * Since TypeScript cannot enforce them all for literals in code,
16
+ * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.
17
+ *
18
+ * @privateRemarks
19
+ * Since this uses the semver notion of "greater" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.
20
+ * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.
21
+ *
22
+ * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.
23
+ *
24
+ * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).
25
+ * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
26
+ *
27
+ * @input
8
28
  * @legacy @beta
9
29
  */
10
30
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
package/dist/compatibilityDefinitions.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
1
+ {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
package/dist/compatibilityDefinitions.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n *\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
1
+ {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
package/lib/compatibilityDefinitions.d.ts CHANGED
@@ -3,8 +3,28 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  /**
6
- * String in a valid semver format of a specific version at least specifying minor.
6
+ * Oldest version of Fluid Framework client packages to support collaborating with.
7
+ * @remarks
8
+ * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.
7
9
  *
10
+ * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.
11
+ *
12
+ * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.
13
+ *
14
+ * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.
15
+ * Since TypeScript cannot enforce them all for literals in code,
16
+ * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.
17
+ *
18
+ * @privateRemarks
19
+ * Since this uses the semver notion of "greater" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.
20
+ * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.
21
+ *
22
+ * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.
23
+ *
24
+ * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).
25
+ * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
26
+ *
27
+ * @input
8
28
  * @legacy @beta
9
29
  */
10
30
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
package/lib/compatibilityDefinitions.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
1
+ {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
package/lib/compatibilityDefinitions.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n *\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
1
+ {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/runtime-definitions",
3
- "version": "2.72.0",
3
+ "version": "2.73.0",
4
4
  "description": "Fluid Runtime definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -57,12 +57,12 @@
57
57
  "main": "lib/index.js",
58
58
  "types": "lib/public.d.ts",
59
59
  "dependencies": {
60
- "@fluid-internal/client-utils": "~2.72.0",
61
- "@fluidframework/container-definitions": "~2.72.0",
62
- "@fluidframework/core-interfaces": "~2.72.0",
63
- "@fluidframework/driver-definitions": "~2.72.0",
64
- "@fluidframework/id-compressor": "~2.72.0",
65
- "@fluidframework/telemetry-utils": "~2.72.0"
60
+ "@fluid-internal/client-utils": "~2.73.0",
61
+ "@fluidframework/container-definitions": "~2.73.0",
62
+ "@fluidframework/core-interfaces": "~2.73.0",
63
+ "@fluidframework/driver-definitions": "~2.73.0",
64
+ "@fluidframework/id-compressor": "~2.73.0",
65
+ "@fluidframework/telemetry-utils": "~2.73.0"
66
66
  },
67
67
  "devDependencies": {
68
68
  "@arethetypeswrong/cli": "^0.17.1",
@@ -70,7 +70,7 @@
70
70
  "@fluid-tools/build-cli": "^0.60.0",
71
71
  "@fluidframework/build-common": "^2.0.3",
72
72
  "@fluidframework/build-tools": "^0.60.0",
73
- "@fluidframework/eslint-config-fluid": "~2.72.0",
73
+ "@fluidframework/eslint-config-fluid": "~2.73.0",
74
74
  "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.71.0",
75
75
  "@microsoft/api-extractor": "7.52.11",
76
76
  "concurrently": "^8.2.1",
package/src/compatibilityDefinitions.ts CHANGED
@@ -4,8 +4,28 @@
4
4
  */
5
5
 
6
6
  /**
7
- * String in a valid semver format of a specific version at least specifying minor.
7
+ * Oldest version of Fluid Framework client packages to support collaborating with.
8
+ * @remarks
9
+ * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.
8
10
  *
11
+ * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.
12
+ *
13
+ * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.
14
+ *
15
+ * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.
16
+ * Since TypeScript cannot enforce them all for literals in code,
17
+ * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.
18
+ *
19
+ * @privateRemarks
20
+ * Since this uses the semver notion of "greater" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.
21
+ * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.
22
+ *
23
+ * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.
24
+ *
25
+ * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).
26
+ * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
27
+ *
28
+ * @input
9
29
  * @legacy @beta
10
30
  */
11
31
  export type MinimumVersionForCollab =