@fluidframework/container-definitions - npm Package Compare versions

Comparing version 2.10.0-304831 to 2.10.0-305357

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

@@ -207,4 +207,2 @@ ## Alpha API Report File for "@fluidframework/container-definitions"
     readonly hasCheckpointSequenceNumber: boolean;
-    // @deprecated
-    readonly inbound: IDeltaQueue<T>;
     readonly inboundSignal: IDeltaQueue<ISignalMessage>;
@@ -217,4 +215,2 @@ readonly initialSequenceNumber: number;
     readonly minimumSequenceNumber: number;
-    // @deprecated
-    readonly outbound: IDeltaQueue<U[]>;
     // (undocumented)
@@ -221,0 +217,0 @@ readonly readOnlyInfo: ReadOnlyInfo;

dist/deltas.d.ts

@@ -125,14 +125,2 @@ /*!
     /**
-     * The queue of inbound delta messages
-     * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-     * may break if this is used directly. For example summarization and op processing.
-     */
-    readonly inbound: IDeltaQueue<T>;
-    /**
-     * The queue of outbound delta messages
-     * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-     * may break if this is used directly. For example op submission
-     */
-    readonly outbound: IDeltaQueue<U[]>;
-    /**
      * The queue of inbound delta signals
@@ -193,2 +181,21 @@ */
 /**
+ * DeltaManager which is used internally by the Fluid layers and not exposed to the end users.
+ * @internal
+ */
+export interface IDeltaManagerFull<T = ISequencedDocumentMessage, U = IDocumentMessage> extends IDeltaManager<T, U> {
+    /**
+     * The queue of inbound delta messages
+     */
+    readonly inbound: IDeltaQueue<T>;
+    /**
+     * The queue of outbound delta messages
+     */
+    readonly outbound: IDeltaQueue<U[]>;
+}
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+export declare function isIDeltaManagerFull(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>): deltaManager is IDeltaManagerFull;
+/**
  * Events emitted by {@link IDeltaQueue}.
@@ -195,0 +202,0 @@ * @sealed

dist/deltas.js

@@ -7,2 +7,11 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIDeltaManagerFull = void 0;
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+function isIDeltaManagerFull(deltaManager) {
+    return "inbound" in deltaManager && "outbound" in deltaManager;
+}
+exports.isIDeltaManagerFull = isIDeltaManagerFull;
 //# sourceMappingURL=deltas.js.map

dist/index.d.ts

@@ -13,3 +13,4 @@ /*!
 export { isFluidBrowserPackage } from "./browserPackage.js";
-export type { IConnectionDetails, IDeltaManager, IDeltaManagerEvents, IDeltaQueue, IDeltaQueueEvents, IDeltaSender, ReadOnlyInfo, } from "./deltas.js";
+export type { IConnectionDetails, IDeltaManager, IDeltaManagerEvents, IDeltaManagerFull, IDeltaQueue, IDeltaQueueEvents, IDeltaSender, ReadOnlyInfo, } from "./deltas.js";
+export { isIDeltaManagerFull } from "./deltas.js";
 export type { ContainerWarning, ICriticalContainerError } from "./error.js";
@@ -16,0 +17,0 @@ export { ContainerErrorTypes } from "./error.js";

dist/index.js

@@ -7,5 +7,7 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IRuntimeFactory = exports.AttachState = exports.isFluidCodeDetails = exports.isFluidPackage = exports.IFluidCodeDetailsComparer = exports.LoaderHeader = exports.ContainerErrorTypes = exports.isFluidBrowserPackage = void 0;
+exports.IRuntimeFactory = exports.AttachState = exports.isFluidCodeDetails = exports.isFluidPackage = exports.IFluidCodeDetailsComparer = exports.LoaderHeader = exports.ContainerErrorTypes = exports.isIDeltaManagerFull = exports.isFluidBrowserPackage = void 0;
 var browserPackage_js_1 = require("./browserPackage.js");
 Object.defineProperty(exports, "isFluidBrowserPackage", { enumerable: true, get: function () { return browserPackage_js_1.isFluidBrowserPackage; } });
+var deltas_js_1 = require("./deltas.js");
+Object.defineProperty(exports, "isIDeltaManagerFull", { enumerable: true, get: function () { return deltas_js_1.isIDeltaManagerFull; } });
 var error_js_1 = require("./error.js");
@@ -12,0 +14,0 @@ Object.defineProperty(exports, "ContainerErrorTypes", { enumerable: true, get: function () { return error_js_1.ContainerErrorTypes; } });

lib/deltas.d.ts

@@ -125,14 +125,2 @@ /*!
     /**
-     * The queue of inbound delta messages
-     * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-     * may break if this is used directly. For example summarization and op processing.
-     */
-    readonly inbound: IDeltaQueue<T>;
-    /**
-     * The queue of outbound delta messages
-     * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-     * may break if this is used directly. For example op submission
-     */
-    readonly outbound: IDeltaQueue<U[]>;
-    /**
      * The queue of inbound delta signals
@@ -193,2 +181,21 @@ */
 /**
+ * DeltaManager which is used internally by the Fluid layers and not exposed to the end users.
+ * @internal
+ */
+export interface IDeltaManagerFull<T = ISequencedDocumentMessage, U = IDocumentMessage> extends IDeltaManager<T, U> {
+    /**
+     * The queue of inbound delta messages
+     */
+    readonly inbound: IDeltaQueue<T>;
+    /**
+     * The queue of outbound delta messages
+     */
+    readonly outbound: IDeltaQueue<U[]>;
+}
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+export declare function isIDeltaManagerFull(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>): deltaManager is IDeltaManagerFull;
+/**
  * Events emitted by {@link IDeltaQueue}.
@@ -195,0 +202,0 @@ * @sealed

lib/deltas.js

@@ -5,3 +5,9 @@ /*!
  */
-export {};
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+export function isIDeltaManagerFull(deltaManager) {
+    return "inbound" in deltaManager && "outbound" in deltaManager;
+}
 //# sourceMappingURL=deltas.js.map

lib/index.d.ts

@@ -13,3 +13,4 @@ /*!
 export { isFluidBrowserPackage } from "./browserPackage.js";
-export type { IConnectionDetails, IDeltaManager, IDeltaManagerEvents, IDeltaQueue, IDeltaQueueEvents, IDeltaSender, ReadOnlyInfo, } from "./deltas.js";
+export type { IConnectionDetails, IDeltaManager, IDeltaManagerEvents, IDeltaManagerFull, IDeltaQueue, IDeltaQueueEvents, IDeltaSender, ReadOnlyInfo, } from "./deltas.js";
+export { isIDeltaManagerFull } from "./deltas.js";
 export type { ContainerWarning, ICriticalContainerError } from "./error.js";
@@ -16,0 +17,0 @@ export { ContainerErrorTypes } from "./error.js";

lib/index.js

@@ -6,2 +6,3 @@ /*!
 export { isFluidBrowserPackage } from "./browserPackage.js";
+export { isIDeltaManagerFull } from "./deltas.js";
 export { ContainerErrorTypes } from "./error.js";
@@ -8,0 +9,0 @@ export { LoaderHeader } from "./loader.js";

package.json

 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.10.0-304831",
+  "version": "2.10.0-305357",
   "description": "Fluid container definitions",
@@ -50,4 +50,4 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.10.0-304831",
-    "@fluidframework/driver-definitions": "2.10.0-304831"
+    "@fluidframework/core-interfaces": "2.10.0-305357",
+    "@fluidframework/driver-definitions": "2.10.0-305357"
   },
@@ -72,3 +72,13 @@ "devDependencies": {
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Interface_IContainer": {
+        "backCompat": false
+      },
+      "Interface_IContainerContext": {
+        "backCompat": false
+      },
+      "Interface_IDeltaManager": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
@@ -75,0 +85,0 @@ },

src/deltas.ts

@@ -160,16 +160,2 @@ /*!
 	/**
-	 * The queue of inbound delta messages
-	 * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-	 * may break if this is used directly. For example summarization and op processing.
-	 */
-	readonly inbound: IDeltaQueue<T>;
-
-	/**
-	 * The queue of outbound delta messages
-	 * @deprecated Do not use, for internal use only. There are a lot of complications in core pieces of the runtime
-	 * may break if this is used directly. For example op submission
-	 */
-	readonly outbound: IDeltaQueue<U[]>;
-
-	/**
 	 * The queue of inbound delta signals
@@ -246,2 +232,29 @@ */
 /**
+ * DeltaManager which is used internally by the Fluid layers and not exposed to the end users.
+ * @internal
+ */
+export interface IDeltaManagerFull<T = ISequencedDocumentMessage, U = IDocumentMessage>
+	extends IDeltaManager<T, U> {
+	/**
+	 * The queue of inbound delta messages
+	 */
+	readonly inbound: IDeltaQueue<T>;
+
+	/**
+	 * The queue of outbound delta messages
+	 */
+	readonly outbound: IDeltaQueue<U[]>;
+}
+
+/**
+ * Type guard to check if the given deltaManager is of type {@link @fluidframework/container-definitions#IDeltaManagerFull}.
+ * @internal
+ */
+export function isIDeltaManagerFull(
+	deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,
+): deltaManager is IDeltaManagerFull {
+	return "inbound" in deltaManager && "outbound" in deltaManager;
+}
+
+/**
  * Events emitted by {@link IDeltaQueue}.
@@ -248,0 +261,0 @@ * @sealed

src/index.ts

@@ -22,2 +22,3 @@ /*!
 	IDeltaManagerEvents,
+	IDeltaManagerFull,
 	IDeltaQueue,
@@ -28,2 +29,3 @@ IDeltaQueueEvents,
 } from "./deltas.js";
+export { isIDeltaManagerFull } from "./deltas.js";
 export type { ContainerWarning, ICriticalContainerError } from "./error.js";
@@ -30,0 +32,0 @@ export { ContainerErrorTypes } from "./error.js";

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

472441

increased by0.68%

Lines of code

5780

increased by0.84%

Dependency changes

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

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

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

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

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

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