@fluidframework/runtime-utils - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

api-report/runtime-utils.beta.api.md

@@ -7,4 +7,7 @@ ## Beta API Report File for "@fluidframework/runtime-utils"
 
+// @public
+export function isFluidHandle(value: unknown): value is IFluidHandle;
+
 // (No @packageDocumentation comment for this package)
 
 ```

api-report/runtime-utils.legacy.alpha.api.md

@@ -30,2 +30,5 @@ ## Alpha API Report File for "@fluidframework/runtime-utils"
 
+// @public
+export function isFluidHandle(value: unknown): value is IFluidHandle;
+
 // @alpha
@@ -32,0 +35,0 @@ export class RequestParser implements IRequest {

api-report/runtime-utils.legacy.public.api.md

@@ -7,4 +7,7 @@ ## Public API Report File for "@fluidframework/runtime-utils"
 
+// @public
+export function isFluidHandle(value: unknown): value is IFluidHandle;
+
 // (No @packageDocumentation comment for this package)
 
 ```

api-report/runtime-utils.public.api.md

@@ -7,4 +7,7 @@ ## Public API Report File for "@fluidframework/runtime-utils"
 
+// @public
+export function isFluidHandle(value: unknown): value is IFluidHandle;
+
 // (No @packageDocumentation comment for this package)
 
 ```

CHANGELOG.md

 # @fluidframework/runtime-utils
 
+## 2.2.0
+
+### Minor Changes
+
+-   New `isFluidHandle` type guard to check if an object is an `IFluidHandle` ([#22029](https://github.com/microsoft/FluidFramework/pull/22029)) [7827d1040a](https://github.com/microsoft/FluidFramework/commit/7827d1040a9ebc0bd11388dc31f15370ea9f68d3)
+
+    The `isFluidHandle` type guard function is now exported and can be used to detect which objects are `IFluidHandle`s.
+    Since `IFluidHandle` often needs special handling (for example when serializing since it's not JSON compatible),
+    having a dedicated detection function for it is useful.
+    Doing this detection was possible previously using the `tree` package's schema system via `Tree.is(value, new SchemaFactory("").handle)`,
+    but can now be done with just `isFluidHandle(value)`.
+
 ## 2.1.0
@@ -4,0 +16,0 @@

dist/handles.d.ts

@@ -22,6 +22,6 @@ /*!
 /**
- * Check if a value is an IFluidHandle.
+ * Check if a value is an {@link @fluidframework/core-interfaces#IFluidHandle}.
  * @remarks
  * Objects which have a field named `IFluidHandle` can in some cases produce a false positive.
- * @internal
+ * @public
  */
@@ -28,0 +28,0 @@ export declare function isFluidHandle(value: unknown): value is IFluidHandle;

dist/handles.js

@@ -27,6 +27,6 @@ "use strict";
 /**
- * Check if a value is an IFluidHandle.
+ * Check if a value is an {@link @fluidframework/core-interfaces#IFluidHandle}.
  * @remarks
  * Objects which have a field named `IFluidHandle` can in some cases produce a false positive.
- * @internal
+ * @public
  */
@@ -33,0 +33,0 @@ function isFluidHandle(value) {

dist/legacy.d.ts

@@ -12,2 +12,5 @@ /*!
 export {
+	// @public APIs
+	isFluidHandle,
+ 
 	// @legacy APIs
@@ -14,0 +17,0 @@ FluidHandleBase,

dist/public.d.ts

@@ -11,3 +11,5 @@ /*!
 
-export {}
-
+export {
+	// @public APIs
+	isFluidHandle
+} from "./index.js";

lib/handles.d.ts

@@ -22,6 +22,6 @@ /*!
 /**
- * Check if a value is an IFluidHandle.
+ * Check if a value is an {@link @fluidframework/core-interfaces#IFluidHandle}.
  * @remarks
  * Objects which have a field named `IFluidHandle` can in some cases produce a false positive.
- * @internal
+ * @public
  */
@@ -28,0 +28,0 @@ export declare function isFluidHandle(value: unknown): value is IFluidHandle;

lib/handles.js

@@ -23,6 +23,6 @@ /*!
 /**
- * Check if a value is an IFluidHandle.
+ * Check if a value is an {@link @fluidframework/core-interfaces#IFluidHandle}.
  * @remarks
  * Objects which have a field named `IFluidHandle` can in some cases produce a false positive.
- * @internal
+ * @public
  */
@@ -29,0 +29,0 @@ export function isFluidHandle(value) {

lib/legacy.d.ts

@@ -12,2 +12,5 @@ /*!
 export {
+	// @public APIs
+	isFluidHandle,
+ 
 	// @legacy APIs
@@ -14,0 +17,0 @@ FluidHandleBase,

lib/public.d.ts

@@ -11,3 +11,5 @@ /*!
 
-export {}
-
+export {
+	// @public APIs
+	isFluidHandle
+} from "./index.js";

package.json

 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Collection of utility functions for Fluid Runtime",
@@ -70,12 +70,12 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.1.0",
-    "@fluidframework/container-definitions": "~2.1.0",
-    "@fluidframework/container-runtime-definitions": "~2.1.0",
-    "@fluidframework/core-interfaces": "~2.1.0",
-    "@fluidframework/core-utils": "~2.1.0",
-    "@fluidframework/datastore-definitions": "~2.1.0",
-    "@fluidframework/driver-definitions": "~2.1.0",
-    "@fluidframework/driver-utils": "~2.1.0",
-    "@fluidframework/runtime-definitions": "~2.1.0",
-    "@fluidframework/telemetry-utils": "~2.1.0"
+    "@fluid-internal/client-utils": "~2.2.0",
+    "@fluidframework/container-definitions": "~2.2.0",
+    "@fluidframework/container-runtime-definitions": "~2.2.0",
+    "@fluidframework/core-interfaces": "~2.2.0",
+    "@fluidframework/core-utils": "~2.2.0",
+    "@fluidframework/datastore-definitions": "~2.2.0",
+    "@fluidframework/driver-definitions": "~2.2.0",
+    "@fluidframework/driver-utils": "~2.2.0",
+    "@fluidframework/runtime-definitions": "~2.2.0",
+    "@fluidframework/telemetry-utils": "~2.2.0"
   },
@@ -85,8 +85,8 @@ "devDependencies": {
     "@biomejs/biome": "~1.8.3",
-    "@fluid-internal/mocha-test-setup": "~2.1.0",
-    "@fluid-tools/build-cli": "^0.41.0",
+    "@fluid-internal/mocha-test-setup": "~2.2.0",
+    "@fluid-tools/build-cli": "^0.43.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.41.0",
+    "@fluidframework/build-tools": "^0.43.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.1.0",
     "@microsoft/api-extractor": "^7.45.1",
@@ -93,0 +93,0 @@ "@types/mocha": "^9.1.1",

README.md

@@ -5,3 +5,3 @@ # @fluidframework/runtime-utils
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) -->
 
@@ -44,3 +44,3 @@ <!-- prettier-ignore-start -->
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
+<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
 
@@ -47,0 +47,0 @@ <!-- prettier-ignore-start -->

src/handles.ts

@@ -42,6 +42,6 @@ /*!
 /**
- * Check if a value is an IFluidHandle.
+ * Check if a value is an {@link @fluidframework/core-interfaces#IFluidHandle}.
  * @remarks
  * Objects which have a field named `IFluidHandle` can in some cases produce a false positive.
- * @internal
+ * @public
  */
@@ -48,0 +48,0 @@ export function isFluidHandle(value: unknown): value is IFluidHandle {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

365196

increased by0.42%

Lines of code

4333

increased by0.23%

Dependency changes

• + Added@fluid-internal/client-utils@2.2.2(transitive)

• + Added@fluidframework/container-definitions@2.2.2(transitive)

• + Added@fluidframework/container-runtime-definitions@2.2.2(transitive)

• + Added@fluidframework/core-interfaces@2.2.2(transitive)

• + Added@fluidframework/core-utils@2.2.2(transitive)

• + Added@fluidframework/datastore-definitions@2.2.2(transitive)

• + Added@fluidframework/driver-definitions@2.2.2(transitive)

• + Added@fluidframework/driver-utils@2.2.2(transitive)

• + Added@fluidframework/id-compressor@2.2.2(transitive)

• + Added@fluidframework/runtime-definitions@2.2.2(transitive)

• + Added@fluidframework/telemetry-utils@2.2.2(transitive)

• - Removed@fluid-internal/client-utils@2.1.2(transitive)

• - Removed@fluidframework/container-definitions@2.1.2(transitive)

• - Removed@fluidframework/container-runtime-definitions@2.1.2(transitive)

• - Removed@fluidframework/core-interfaces@2.1.2(transitive)

• - Removed@fluidframework/core-utils@2.1.2(transitive)

• - Removed@fluidframework/datastore-definitions@2.1.2(transitive)

• - Removed@fluidframework/driver-definitions@2.1.2(transitive)

• - Removed@fluidframework/driver-utils@2.1.2(transitive)

• - Removed@fluidframework/id-compressor@2.1.2(transitive)

• - Removed@fluidframework/runtime-definitions@2.1.2(transitive)

• - Removed@fluidframework/telemetry-utils@2.1.2(transitive)

• Updated@fluid-internal/client-utils@~2.2.0

• Updated@fluidframework/container-definitions@~2.2.0

• Updated@fluidframework/container-runtime-definitions@~2.2.0

• Updated@fluidframework/core-interfaces@~2.2.0

• Updated@fluidframework/core-utils@~2.2.0

• Updated@fluidframework/datastore-definitions@~2.2.0

• Updated@fluidframework/driver-definitions@~2.2.0

• Updated@fluidframework/driver-utils@~2.2.0

• Updated@fluidframework/runtime-definitions@~2.2.0

• Updated@fluidframework/telemetry-utils@~2.2.0