@fluidframework/runtime-definitions - npm Package Compare versions

Comparing version 2.13.0 to 2.20.0

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

@@ -75,4 +75,2 @@ ## Alpha API Report File for "@fluidframework/runtime-definitions"
     createDataStore(pkg: Readonly<string | string[]>, loadingGroupId?: string): Promise<IDataStore>;
-    // @deprecated (undocumented)
-    _createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any, id?: string): Promise<IDataStore>;
     createDetachedDataStore(pkg: Readonly<string[]>, loadingGroupId?: string): IFluidDataStoreContextDetached;
@@ -99,3 +97,3 @@ // (undocumented)
     (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    (event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
     (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;
@@ -102,0 +100,0 @@ // (undocumented)

CHANGELOG.md

 # @fluidframework/runtime-definitions
 
+## 2.20.0
+
+### Minor Changes
+
+-   The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed ([#22996](https://github.com/microsoft/FluidFramework/pull/22996)) [bd243fb292](https://github.com/microsoft/FluidFramework/commit/bd243fb2927915d87c42486e21ee0c990962a9a7)
+
+    `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps`
+    were [deprecated in version 0.25.0](https://github.com/microsoft/FluidFramework/blob/main/BREAKING.md#icontainerruntimebase_createdatastorewithprops-is-removed) and have been removed.
+
+    Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState`
+    parameter.
+
+    These changes were originally announced in version 0.25.0. See the following issues for more details:
+
+    -   [#1537](https://github.com/microsoft/FluidFramework/issues/1537)
+    -   [#2931](https://github.com/microsoft/FluidFramework/pull/2931)
+
 ## 2.13.0
@@ -4,0 +21,0 @@

dist/dataStoreContext.d.ts

@@ -100,3 +100,3 @@ /*!
      */
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    (event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
     /**
@@ -173,6 +173,2 @@ * Indicates that an incoming op has been processed.
     /**
-     * @deprecated 0.16 Issue #1537, #3631
-     */
-    _createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any, id?: string): Promise<IDataStore>;
-    /**
      * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
@@ -222,3 +218,3 @@ * as the data store's router. The data store is not bound to a container, and in such state is not persisted to
      * Generates a new ID that is guaranteed to be unique across all sessions for this container.
-     * It could be in compact form (non-negative integer, oppotunistic), but it could also be UUID string.
+     * It could be in compact form (non-negative integer, opportunistic), but it could also be UUID string.
      * UUIDs generated will have low entropy in groups and will compress well.
@@ -230,3 +226,3 @@ * It can be leveraged anywhere in container where container unique IDs are required, i.e. any place
      *
-     * For more details, please see IIdCompressor.generateDocumentUniqueId()
+     * @see {@link @fluidframework/id-compressor#IIdCompressor.generateDocumentUniqueId}
      */
@@ -238,3 +234,3 @@ generateDocumentUniqueId(): number | string;
      * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-     * @returns - snapshotTree and the sequence number of the snapshot.
+     * @returns snapshotTree and the sequence number of the snapshot.
      */
@@ -241,0 +237,0 @@ getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{

dist/package.json

 {
-	"type": "commonjs"
+	"type": "commonjs",
+	"sideEffects": false
 }

dist/protocol.d.ts

@@ -76,7 +76,13 @@ /*!
 export interface IRuntimeMessagesContent {
-    /** The contents of the message, i.e., the payload */
+    /**
+     * The contents of the message, i.e., the payload
+     */
     readonly contents: unknown;
-    /** The local metadata associated with the original message that was submitted */
+    /**
+     * The local metadata associated with the original message that was submitted
+     */
     readonly localOpMetadata: unknown;
-    /** The client sequence number of the message */
+    /**
+     * The client sequence number of the message
+     */
     readonly clientSequenceNumber: number;
@@ -91,9 +97,15 @@ }
 export interface IRuntimeMessageCollection {
-    /** The envelope for all the messages in the collection */
+    /**
+     * The envelope for all the messages in the collection
+     */
     readonly envelope: ISequencedMessageEnvelope;
-    /** Whether these messages were originally generated by the client processing it */
+    /**
+     * Whether these messages were originally generated by the client processing them
+     */
     readonly local: boolean;
-    /** The contents of the messages in the collection */
+    /**
+     * The contents of the messages in the collection
+     */
     readonly messagesContent: readonly IRuntimeMessagesContent[];
 }
 //# sourceMappingURL=protocol.d.ts.map

lib/dataStoreContext.d.ts

@@ -100,3 +100,3 @@ /*!
      */
-    (event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
+    (event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
     /**
@@ -173,6 +173,2 @@ * Indicates that an incoming op has been processed.
     /**
-     * @deprecated 0.16 Issue #1537, #3631
-     */
-    _createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any, id?: string): Promise<IDataStore>;
-    /**
      * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
@@ -222,3 +218,3 @@ * as the data store's router. The data store is not bound to a container, and in such state is not persisted to
      * Generates a new ID that is guaranteed to be unique across all sessions for this container.
-     * It could be in compact form (non-negative integer, oppotunistic), but it could also be UUID string.
+     * It could be in compact form (non-negative integer, opportunistic), but it could also be UUID string.
      * UUIDs generated will have low entropy in groups and will compress well.
@@ -230,3 +226,3 @@ * It can be leveraged anywhere in container where container unique IDs are required, i.e. any place
      *
-     * For more details, please see IIdCompressor.generateDocumentUniqueId()
+     * @see {@link @fluidframework/id-compressor#IIdCompressor.generateDocumentUniqueId}
      */
@@ -238,3 +234,3 @@ generateDocumentUniqueId(): number | string;
      * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-     * @returns - snapshotTree and the sequence number of the snapshot.
+     * @returns snapshotTree and the sequence number of the snapshot.
      */
@@ -241,0 +237,0 @@ getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{

lib/protocol.d.ts

@@ -76,7 +76,13 @@ /*!
 export interface IRuntimeMessagesContent {
-    /** The contents of the message, i.e., the payload */
+    /**
+     * The contents of the message, i.e., the payload
+     */
     readonly contents: unknown;
-    /** The local metadata associated with the original message that was submitted */
+    /**
+     * The local metadata associated with the original message that was submitted
+     */
     readonly localOpMetadata: unknown;
-    /** The client sequence number of the message */
+    /**
+     * The client sequence number of the message
+     */
     readonly clientSequenceNumber: number;
@@ -91,9 +97,15 @@ }
 export interface IRuntimeMessageCollection {
-    /** The envelope for all the messages in the collection */
+    /**
+     * The envelope for all the messages in the collection
+     */
     readonly envelope: ISequencedMessageEnvelope;
-    /** Whether these messages were originally generated by the client processing it */
+    /**
+     * Whether these messages were originally generated by the client processing them
+     */
     readonly local: boolean;
-    /** The contents of the messages in the collection */
+    /**
+     * The contents of the messages in the collection
+     */
     readonly messagesContent: readonly IRuntimeMessagesContent[];
 }
 //# sourceMappingURL=protocol.d.ts.map

package.json

 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.13.0",
+  "version": "2.20.0",
   "description": "Fluid Runtime definitions",
@@ -50,7 +50,7 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.13.0",
-    "@fluidframework/core-interfaces": "~2.13.0",
-    "@fluidframework/driver-definitions": "~2.13.0",
-    "@fluidframework/id-compressor": "~2.13.0",
-    "@fluidframework/telemetry-utils": "~2.13.0"
+    "@fluidframework/container-definitions": "~2.20.0",
+    "@fluidframework/core-interfaces": "~2.20.0",
+    "@fluidframework/driver-definitions": "~2.20.0",
+    "@fluidframework/id-compressor": "~2.20.0",
+    "@fluidframework/telemetry-utils": "~2.20.0"
   },
@@ -64,3 +64,3 @@ "devDependencies": {
     "@fluidframework/eslint-config-fluid": "^5.6.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.12.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.13.0",
     "@microsoft/api-extractor": "7.47.8",
@@ -76,3 +76,16 @@ "concurrently": "^8.2.1",
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Interface_IContainerRuntimeBase": {
+        "backCompat": false
+      },
+      "Interface_IFluidDataStoreContext": {
+        "backCompat": false
+      },
+      "Interface_IFluidDataStoreContextDetached": {
+        "backCompat": false
+      },
+      "Interface_IFluidParentContext": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
@@ -79,0 +92,0 @@ },

src/dataStoreContext.ts

@@ -140,3 +140,3 @@ /*!
 		event: "batchEnd",
-		listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents">) => void,
+		listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void,
 	);
@@ -221,11 +221,2 @@ /**
 	/**
-	 * @deprecated 0.16 Issue #1537, #3631
-	 */
-	_createDataStoreWithProps(
-		pkg: Readonly<string | string[]>,
-		props?: any,
-		id?: string,
-	): Promise<IDataStore>;
-
-	/**
 	 * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
@@ -291,3 +282,3 @@ * as the data store's router. The data store is not bound to a container, and in such state is not persisted to
 	 * Generates a new ID that is guaranteed to be unique across all sessions for this container.
-	 * It could be in compact form (non-negative integer, oppotunistic), but it could also be UUID string.
+	 * It could be in compact form (non-negative integer, opportunistic), but it could also be UUID string.
 	 * UUIDs generated will have low entropy in groups and will compress well.
@@ -299,3 +290,3 @@ * It can be leveraged anywhere in container where container unique IDs are required, i.e. any place
 	 *
-	 * For more details, please see IIdCompressor.generateDocumentUniqueId()
+	 * @see {@link @fluidframework/id-compressor#IIdCompressor.generateDocumentUniqueId}
 	 */
@@ -308,3 +299,3 @@ generateDocumentUniqueId(): number | string;
 	 * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-	 * @returns - snapshotTree and the sequence number of the snapshot.
+	 * @returns snapshotTree and the sequence number of the snapshot.
 	 */
@@ -399,4 +390,6 @@ getSnapshotForLoadingGroupId(
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	reSubmit(type: string, content: any, localOpMetadata: unknown);
 
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	applyStashedOp(content: any): Promise<unknown>;
@@ -410,2 +403,3 @@
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	rollback?(type: string, content: any, localOpMetadata: unknown): void;
@@ -458,2 +452,3 @@
 		Partial<IProvideFluidDataStoreRegistry> {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	readonly options: Record<string | number, any>;
@@ -511,2 +506,3 @@ readonly clientId: string | undefined;
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	submitMessage(type: string, content: any, localOpMetadata: unknown): void;
@@ -599,2 +595,5 @@
 	 */
+	// Seems like this can be removed now; the issues mentioned in the @deprecated tag are about _createDataStoreWithProps
+	// which we finally removed in FF 2.20 (https://github.com/microsoft/FluidFramework/pull/22996).
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	readonly createProps?: any;
@@ -601,0 +600,0 @@

src/protocol.ts

@@ -26,2 +26,3 @@ /*!
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change
 	contents: any;
@@ -71,2 +72,3 @@ }
 export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
+	// eslint-disable-next-line @rushstack/no-new-null -- TODO: breaking change; protocol might even explicitly use null
 	snapshot: IAttachMessage["snapshot"] | null;
@@ -95,7 +97,13 @@ };
 export interface IRuntimeMessagesContent {
-	/** The contents of the message, i.e., the payload */
+	/**
+	 * The contents of the message, i.e., the payload
+	 */
 	readonly contents: unknown;
-	/** The local metadata associated with the original message that was submitted */
+	/**
+	 * The local metadata associated with the original message that was submitted
+	 */
 	readonly localOpMetadata: unknown;
-	/** The client sequence number of the message */
+	/**
+	 * The client sequence number of the message
+	 */
 	readonly clientSequenceNumber: number;
@@ -111,8 +119,14 @@ }
 export interface IRuntimeMessageCollection {
-	/** The envelope for all the messages in the collection */
+	/**
+	 * The envelope for all the messages in the collection
+	 */
 	readonly envelope: ISequencedMessageEnvelope;
-	/** Whether these messages were originally generated by the client processing it */
+	/**
+	 * Whether these messages were originally generated by the client processing them
+	 */
 	readonly local: boolean;
-	/** The contents of the messages in the collection */
+	/**
+	 * The contents of the messages in the collection
+	 */
 	readonly messagesContent: readonly IRuntimeMessagesContent[];
 }

No alert changes

Improved metrics

Total package byte prevSize

407338

increased by0.85%

Lines of code

4566

increased by0.66%

Dependency changes

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• Updated@fluidframework/container-definitions@~2.20.0

• Updated@fluidframework/core-interfaces@~2.20.0

• Updated@fluidframework/driver-definitions@~2.20.0

• Updated@fluidframework/id-compressor@~2.20.0

• Updated@fluidframework/telemetry-utils@~2.20.0