@fluidframework/runtime-definitions - npm Package Compare versions

Comparing version 2.5.0 to 2.10.0-304831

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

@@ -97,11 +97,4 @@ ## Alpha API Report File for "@fluidframework/runtime-definitions"
 export interface IContainerRuntimeBaseEvents extends IEvent {
-    // (undocumented)
-    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents"> & {
-        contents: unknown;
-    }) => void): any;
-    // (undocumented)
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents"> & {
-        contents: unknown;
-    }) => void): any;
-    // (undocumented)
+    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
     (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;
@@ -108,0 +101,0 @@ // (undocumented)

dist/dataStoreContext.d.ts

@@ -90,13 +90,17 @@ /*!
 export interface IContainerRuntimeBaseEvents extends IEvent {
-    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents"> & {
-        /** @deprecated Use the "op" event to get details about the message contents */
-        contents: unknown;
-    }) => void): any;
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents"> & {
-        /** @deprecated Use the "op" event to get details about the message contents */
-        contents: unknown;
-    }) => void): any;
     /**
+     * Indicates the beginning of an incoming batch of ops
+     * @param op - The first op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+     */
+    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    /**
+     * Indicates the end of an incoming batch of ops
+     * @param error - If an error occurred while processing the batch, it is provided here.
+     * @param op - The last op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+     */
+    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    /**
+     * Indicates that an incoming op has been processed.
      * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. its type and content
-     * represent internal container runtime type / content.
+     * represent internal container runtime type / content. i.e. A grouped batch of N ops will result in N "op" events
      */
@@ -103,0 +107,0 @@ (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;

lib/dataStoreContext.d.ts

@@ -90,13 +90,17 @@ /*!
 export interface IContainerRuntimeBaseEvents extends IEvent {
-    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents"> & {
-        /** @deprecated Use the "op" event to get details about the message contents */
-        contents: unknown;
-    }) => void): any;
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents"> & {
-        /** @deprecated Use the "op" event to get details about the message contents */
-        contents: unknown;
-    }) => void): any;
     /**
+     * Indicates the beginning of an incoming batch of ops
+     * @param op - The first op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+     */
+    (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    /**
+     * Indicates the end of an incoming batch of ops
+     * @param error - If an error occurred while processing the batch, it is provided here.
+     * @param op - The last op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+     */
+    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    /**
+     * Indicates that an incoming op has been processed.
      * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. its type and content
-     * represent internal container runtime type / content.
+     * represent internal container runtime type / content. i.e. A grouped batch of N ops will result in N "op" events
      */
@@ -103,0 +107,0 @@ (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;

package.json

 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.5.0",
+  "version": "2.10.0-304831",
   "description": "Fluid Runtime definitions",
@@ -50,7 +50,7 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.5.0",
-    "@fluidframework/core-interfaces": "~2.5.0",
-    "@fluidframework/driver-definitions": "~2.5.0",
-    "@fluidframework/id-compressor": "~2.5.0",
-    "@fluidframework/telemetry-utils": "~2.5.0"
+    "@fluidframework/container-definitions": "2.10.0-304831",
+    "@fluidframework/core-interfaces": "2.10.0-304831",
+    "@fluidframework/driver-definitions": "2.10.0-304831",
+    "@fluidframework/id-compressor": "2.10.0-304831",
+    "@fluidframework/telemetry-utils": "2.10.0-304831"
   },
@@ -60,7 +60,7 @@ "devDependencies": {
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.49.0",
+    "@fluid-tools/build-cli": "^0.50.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.49.0",
+    "@fluidframework/build-tools": "^0.50.0",
     "@fluidframework/eslint-config-fluid": "^5.4.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@~2.4.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.5.0",
     "@microsoft/api-extractor": "7.47.8",
@@ -67,0 +67,0 @@ "concurrently": "^8.2.1",

src/dataStoreContext.ts

@@ -125,24 +125,20 @@ /*!
 export interface IContainerRuntimeBaseEvents extends IEvent {
+	/**
+	 * Indicates the beginning of an incoming batch of ops
+	 * @param op - The first op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+	 */
+	(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void);
+	/**
+	 * Indicates the end of an incoming batch of ops
+	 * @param error - If an error occurred while processing the batch, it is provided here.
+	 * @param op - The last op in the batch. Can be inspected to learn about the sequence numbers relevant for this batch.
+	 */
 	(
-		event: "batchBegin",
-		listener: (
-			op: Omit<ISequencedDocumentMessage, "contents"> & {
-				/** @deprecated Use the "op" event to get details about the message contents */
-				contents: unknown;
-			},
-		) => void,
-	);
-	(
 		event: "batchEnd",
-		listener: (
-			error: any,
-			op: Omit<ISequencedDocumentMessage, "contents"> & {
-				/** @deprecated Use the "op" event to get details about the message contents */
-				contents: unknown;
-			},
-		) => void,
+		listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void,
 	);
 	/**
+	 * Indicates that an incoming op has been processed.
 	 * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. its type and content
-	 * represent internal container runtime type / content.
+	 * represent internal container runtime type / content. i.e. A grouped batch of N ops will result in N "op" events
 	 */
@@ -149,0 +145,0 @@ (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void);

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

372617

increased by0.35%

Lines of code

4294

increased by0.09%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Dependency changes

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• Updated@fluidframework/container-definitions@2.10.0-304831

• Updated@fluidframework/core-interfaces@2.10.0-304831

• Updated@fluidframework/driver-definitions@2.10.0-304831

• Updated@fluidframework/id-compressor@2.10.0-304831

• Updated@fluidframework/telemetry-utils@2.10.0-304831