@fluidframework/protocol-definitions - npm Package Compare versions

Comparing version 3.2.0-231454 to 3.2.0-236943

api-report/protocol-definitions.api.md

@@ -276,5 +276,3 @@ ## API Report File for "@fluidframework/protocol-definitions"
 // @internal
-export interface ISentSignalMessage extends ISignalMessageBase {
-    targetClientId?: string;
-}
+export type ISentSignalMessage = ISignalMessageBase;
 
@@ -354,2 +352,3 @@ // @public
     referenceSequenceNumber?: number;
+    targetClientId?: string;
     type?: string;
@@ -356,0 +355,0 @@ }

dist/protocol.d.ts

@@ -290,3 +290,3 @@ /*!
     /**
-     * Counts the number of signals sent by the client
+     * Counts the number of signals sent by the sending client.
      */
@@ -298,2 +298,7 @@ clientConnectionNumber?: number;
     referenceSequenceNumber?: number;
+    /**
+     * Client ID of the singular client the signal is being (or has been) sent to.
+     * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.
+     */
+    targetClientId?: string;
 }
@@ -312,11 +317,6 @@ /**
 /**
- * Interface for signals sent by clients to the server when submit_signals_v2 is enabled.
+ * Interface for signals sent by clients to the server.
  * @internal
  */
-export interface ISentSignalMessage extends ISignalMessageBase {
-    /**
-     * When specified, the signal is only sent to the provided client id
-     */
-    targetClientId?: string;
-}
+export type ISentSignalMessage = ISignalMessageBase;
 /**
@@ -323,0 +323,0 @@ * @alpha

dist/storage.d.ts

@@ -102,5 +102,6 @@ /*!
     /**
-     * Represents the group to which the tree belongs to. When the server returns the snapshot to
-     * the client, and this tree is missing in that snapshot, then this could be used to request the contents
-     * from the service.
+     * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.
+     * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+     * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+     * intentional to minimize snapshot/summary size.
      */
@@ -125,5 +126,6 @@ groupId?: string;
     /**
-     * Represents the group to which the snapshot tree belongs to. When the server returns the snapshot to
-     * the client, and this tree is missing in that snapshot, then this could be used to request the contents
-     * from the service.
+     * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.
+     * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+     * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+     * intentional to minimize snapshot/summary size.
      */
@@ -130,0 +132,0 @@ groupId?: string;

dist/summary.d.ts

@@ -148,5 +148,6 @@ /*!
     /**
-     * Represents the group to which the summary tree belongs to. The server stores this info and when it returns the
-     * snapshot to the client, and this tree is missing in that snapshot, then this could be used to request the contents
-     * from the service.
+     * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.
+     * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+     * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+     * intentional to minimize snapshot/summary size.
      */
@@ -153,0 +154,0 @@ groupId?: string;

package.json

 {
   "name": "@fluidframework/protocol-definitions",
-  "version": "3.2.0-231454",
+  "version": "3.2.0-236943",
   "description": "Fluid protocol definitions",
@@ -43,3 +43,2 @@ "homepage": "https://fluidframework.com",
     "prettier": "~3.0.3",
-    "renamer": "^4.0.0",
     "rimraf": "^2.6.2",
@@ -46,0 +45,0 @@ "tsc-multi": "^1.1.0",

src/protocol.ts

@@ -349,3 +349,3 @@ /*!
 	/**
-	 * Counts the number of signals sent by the client
+	 * Counts the number of signals sent by the sending client.
 	 */
@@ -358,2 +358,8 @@ clientConnectionNumber?: number;
 	referenceSequenceNumber?: number;
+
+	/**
+	 * Client ID of the singular client the signal is being (or has been) sent to.
+	 * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.
+	 */
+	targetClientId?: string;
 }
@@ -375,11 +381,6 @@
 /**
- * Interface for signals sent by clients to the server when submit_signals_v2 is enabled.
+ * Interface for signals sent by clients to the server.
  * @internal
  */
-export interface ISentSignalMessage extends ISignalMessageBase {
-	/**
-	 * When specified, the signal is only sent to the provided client id
-	 */
-	targetClientId?: string;
-}
+export type ISentSignalMessage = ISignalMessageBase;
 
@@ -386,0 +387,0 @@ /**

src/storage.ts

@@ -122,5 +122,6 @@ /*!
 	/**
-	 * Represents the group to which the tree belongs to. When the server returns the snapshot to
-	 * the client, and this tree is missing in that snapshot, then this could be used to request the contents
-	 * from the service.
+	 * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.
+	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+	 * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+	 * intentional to minimize snapshot/summary size.
 	 */
@@ -144,5 +145,6 @@ groupId?: string;
 	/**
-	 * Represents the group to which the snapshot tree belongs to. When the server returns the snapshot to
-	 * the client, and this tree is missing in that snapshot, then this could be used to request the contents
-	 * from the service.
+	 * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.
+	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+	 * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+	 * intentional to minimize snapshot/summary size.
 	 */
@@ -149,0 +151,0 @@ groupId?: string;

src/summary.ts

@@ -170,7 +170,8 @@ /*!
 	/**
-	 * Represents the group to which the summary tree belongs to. The server stores this info and when it returns the
-	 * snapshot to the client, and this tree is missing in that snapshot, then this could be used to request the contents
-	 * from the service.
+	 * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.
+	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
+	 * Also note that "groupId" is the same as "loadingGroupId" used elsewhere in the repo. The naming discrepancy is
+	 * intentional to minimize snapshot/summary size.
 	 */
 	groupId?: string;
 }

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

384490

increased by0.76%

Dev dependency count

15

decreased by-6.25%

Lines of code

3513

increased by0.17%

No dependency changes