@fluidframework/core-interfaces 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/core-interfaces
 
+## 2.3.0
+
+Dependency updates only.
+
 ## 2.2.0
 
 Dependency updates only.

package/dist/messages.d.ts

@@ -4,6 +4,13 @@
  */
 /**
  * @internal
+ *
+ * @privateRemarks
+ * `IRuntimeSignalEnvelope` is an interface that mirrors `ISignalEnvelope` for signals that come from an external
+ * caller (not sent by a client—so no `clientBroadcastSignalSequenceNumber`) and are always addressed
+ * to the Container (so no `address`).
+ *
+ * See at `server/routerlicious/packages/lambdas/src/utils/messageGenerator.ts`.
  */
 export interface ISignalEnvelope {
     /**
@@ -11,9 +18,9 @@ export interface ISignalEnvelope {
      */
     address?: string;
     /**
-     * Identifier for the signal being submitted.
+     * Signal tracking identifier for self submitted broadcast signals.
      */
-    clientSignalSequenceNumber: number;
+    clientBroadcastSignalSequenceNumber?: number;
     /**
      * The contents of the envelope
      */

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,GAAG,CAAC;KACb,CAAC;CACF"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,GAAG,CAAC;KACb,CAAC;CACF"}

package/dist/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.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 * @internal\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Identifier for the signal being submitted.\n\t */\n\tclientSignalSequenceNumber: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tcontent: any;\n\t};\n}\n"]}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.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 * @internal\n *\n * @privateRemarks\n * `IRuntimeSignalEnvelope` is an interface that mirrors `ISignalEnvelope` for signals that come from an external\n * caller (not sent by a client—so no `clientBroadcastSignalSequenceNumber`) and are always addressed\n * to the Container (so no `address`).\n *\n * See at `server/routerlicious/packages/lambdas/src/utils/messageGenerator.ts`.\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Signal tracking identifier for self submitted broadcast signals.\n\t */\n\tclientBroadcastSignalSequenceNumber?: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tcontent: any;\n\t};\n}\n"]}

package/lib/messages.d.ts

@@ -4,6 +4,13 @@
  */
 /**
  * @internal
+ *
+ * @privateRemarks
+ * `IRuntimeSignalEnvelope` is an interface that mirrors `ISignalEnvelope` for signals that come from an external
+ * caller (not sent by a client—so no `clientBroadcastSignalSequenceNumber`) and are always addressed
+ * to the Container (so no `address`).
+ *
+ * See at `server/routerlicious/packages/lambdas/src/utils/messageGenerator.ts`.
  */
 export interface ISignalEnvelope {
     /**
@@ -11,9 +18,9 @@ export interface ISignalEnvelope {
      */
     address?: string;
     /**
-     * Identifier for the signal being submitted.
+     * Signal tracking identifier for self submitted broadcast signals.
      */
-    clientSignalSequenceNumber: number;
+    clientBroadcastSignalSequenceNumber?: number;
     /**
      * The contents of the envelope
      */

package/lib/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,GAAG,CAAC;KACb,CAAC;CACF"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,GAAG,CAAC;KACb,CAAC;CACF"}

package/lib/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.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 * @internal\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Identifier for the signal being submitted.\n\t */\n\tclientSignalSequenceNumber: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tcontent: any;\n\t};\n}\n"]}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.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 * @internal\n *\n * @privateRemarks\n * `IRuntimeSignalEnvelope` is an interface that mirrors `ISignalEnvelope` for signals that come from an external\n * caller (not sent by a client—so no `clientBroadcastSignalSequenceNumber`) and are always addressed\n * to the Container (so no `address`).\n *\n * See at `server/routerlicious/packages/lambdas/src/utils/messageGenerator.ts`.\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Signal tracking identifier for self submitted broadcast signals.\n\t */\n\tclientBroadcastSignalSequenceNumber?: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tcontent: any;\n\t};\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.45.1"
+      "packageVersion": "7.47.8"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Fluid object interfaces",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -49,12 +49,12 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-tools/build-cli": "^0.43.0",
+    "@fluid-tools/build-cli": "^0.46.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.43.0",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.1.0",
-    "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@microsoft/api-extractor": "^7.45.1",
+    "@fluidframework/build-tools": "^0.46.0",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.2.0",
+    "@fluidframework/eslint-config-fluid": "^5.4.0",
+    "@microsoft/api-extractor": "7.47.8",
     "@types/node": "^18.19.0",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
@@ -64,7 +64,12 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "Interface_ISignalEnvelope": {
+        "backCompat": false
+      }
+    },
+    "entrypoint": "internal"
   },
   "scripts": {
     "api": "fluid-build . --task api",

package/src/messages.ts

@@ -5,6 +5,13 @@
 
 /**
  * @internal
+ *
+ * @privateRemarks
+ * `IRuntimeSignalEnvelope` is an interface that mirrors `ISignalEnvelope` for signals that come from an external
+ * caller (not sent by a client—so no `clientBroadcastSignalSequenceNumber`) and are always addressed
+ * to the Container (so no `address`).
+ *
+ * See at `server/routerlicious/packages/lambdas/src/utils/messageGenerator.ts`.
  */
 export interface ISignalEnvelope {
 	/**
@@ -13,9 +20,9 @@ export interface ISignalEnvelope {
 	address?: string;
 
 	/**
-	 * Identifier for the signal being submitted.
+	 * Signal tracking identifier for self submitted broadcast signals.
 	 */
-	clientSignalSequenceNumber: number;
+	clientBroadcastSignalSequenceNumber?: number;
 
 	/**
 	 * The contents of the envelope