@fluidframework/runtime-utils - npm Package Compare versions

Comparing version 2.11.0 to 2.12.0

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

@@ -55,7 +55,4 @@ ## Alpha API Report File for "@fluidframework/runtime-utils"
 export abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
-    // (undocumented)
     hasInitialized(_runtime: T): Promise<void>;
-    // (undocumented)
     instantiateFirstTime(_runtime: T): Promise<void>;
-    // (undocumented)
     instantiateFromExisting(_runtime: T): Promise<void>;
@@ -66,3 +63,2 @@ // (undocumented)
     get IRuntimeFactory(): this;
-    // (undocumented)
     abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
@@ -69,0 +65,0 @@ }

CHANGELOG.md

 # @fluidframework/runtime-utils
 
+## 2.12.0
+
+Dependency updates only.
+
 ## 2.11.0
@@ -4,0 +8,0 @@

dist/runtimeFactoryHelper.d.ts

@@ -14,7 +14,26 @@ /*!
     instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+    /**
+     * Called at the start of initializing a container, to create the container runtime instance.
+     * @param context - The context for the container being initialized
+     * @param existing - Whether the container already exists and is being loaded (else it's being created new just now)
+     */
     abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
+    /**
+     * Called the one time the container is created, and not on any subsequent load.
+     * i.e. only when it's initialized on the client that first created it
+     * @param runtime - The runtime for the container being initialized
+     */
     instantiateFirstTime(_runtime: T): Promise<void>;
+    /**
+     * Called every time the container runtime is loaded for an existing container.
+     * i.e. every time it's initialized _except_ for when it is first created
+     * @param runtime - The runtime for the container being initialized
+     */
     instantiateFromExisting(_runtime: T): Promise<void>;
+    /**
+     * Called at the end of initializing a container, after the runtime has been created or loaded.
+     * @param runtime - The runtime for the container being initialized
+     */
     hasInitialized(_runtime: T): Promise<void>;
 }
 //# sourceMappingURL=runtimeFactoryHelper.d.ts.map

dist/runtimeFactoryHelper.js

@@ -24,4 +24,18 @@ "use strict";
     }
+    /**
+     * Called the one time the container is created, and not on any subsequent load.
+     * i.e. only when it's initialized on the client that first created it
+     * @param runtime - The runtime for the container being initialized
+     */
     async instantiateFirstTime(_runtime) { }
+    /**
+     * Called every time the container runtime is loaded for an existing container.
+     * i.e. every time it's initialized _except_ for when it is first created
+     * @param runtime - The runtime for the container being initialized
+     */
     async instantiateFromExisting(_runtime) { }
+    /**
+     * Called at the end of initializing a container, after the runtime has been created or loaded.
+     * @param runtime - The runtime for the container being initialized
+     */
     async hasInitialized(_runtime) { }
@@ -28,0 +42,0 @@ }

lib/runtimeFactoryHelper.d.ts

@@ -14,7 +14,26 @@ /*!
     instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+    /**
+     * Called at the start of initializing a container, to create the container runtime instance.
+     * @param context - The context for the container being initialized
+     * @param existing - Whether the container already exists and is being loaded (else it's being created new just now)
+     */
     abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
+    /**
+     * Called the one time the container is created, and not on any subsequent load.
+     * i.e. only when it's initialized on the client that first created it
+     * @param runtime - The runtime for the container being initialized
+     */
     instantiateFirstTime(_runtime: T): Promise<void>;
+    /**
+     * Called every time the container runtime is loaded for an existing container.
+     * i.e. every time it's initialized _except_ for when it is first created
+     * @param runtime - The runtime for the container being initialized
+     */
     instantiateFromExisting(_runtime: T): Promise<void>;
+    /**
+     * Called at the end of initializing a container, after the runtime has been created or loaded.
+     * @param runtime - The runtime for the container being initialized
+     */
     hasInitialized(_runtime: T): Promise<void>;
 }
 //# sourceMappingURL=runtimeFactoryHelper.d.ts.map

lib/runtimeFactoryHelper.js

@@ -21,6 +21,20 @@ /*!
     }
+    /**
+     * Called the one time the container is created, and not on any subsequent load.
+     * i.e. only when it's initialized on the client that first created it
+     * @param runtime - The runtime for the container being initialized
+     */
     async instantiateFirstTime(_runtime) { }
+    /**
+     * Called every time the container runtime is loaded for an existing container.
+     * i.e. every time it's initialized _except_ for when it is first created
+     * @param runtime - The runtime for the container being initialized
+     */
     async instantiateFromExisting(_runtime) { }
+    /**
+     * Called at the end of initializing a container, after the runtime has been created or loaded.
+     * @param runtime - The runtime for the container being initialized
+     */
     async hasInitialized(_runtime) { }
 }
 //# sourceMappingURL=runtimeFactoryHelper.js.map

package.json

 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Collection of utility functions for Fluid Runtime",
@@ -72,17 +72,17 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.11.0",
-    "@fluidframework/container-definitions": "~2.11.0",
-    "@fluidframework/container-runtime-definitions": "~2.11.0",
-    "@fluidframework/core-interfaces": "~2.11.0",
-    "@fluidframework/core-utils": "~2.11.0",
-    "@fluidframework/datastore-definitions": "~2.11.0",
-    "@fluidframework/driver-definitions": "~2.11.0",
-    "@fluidframework/driver-utils": "~2.11.0",
-    "@fluidframework/runtime-definitions": "~2.11.0",
-    "@fluidframework/telemetry-utils": "~2.11.0"
+    "@fluid-internal/client-utils": "~2.12.0",
+    "@fluidframework/container-definitions": "~2.12.0",
+    "@fluidframework/container-runtime-definitions": "~2.12.0",
+    "@fluidframework/core-interfaces": "~2.12.0",
+    "@fluidframework/core-utils": "~2.12.0",
+    "@fluidframework/datastore-definitions": "~2.12.0",
+    "@fluidframework/driver-definitions": "~2.12.0",
+    "@fluidframework/driver-utils": "~2.12.0",
+    "@fluidframework/runtime-definitions": "~2.12.0",
+    "@fluidframework/telemetry-utils": "~2.12.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.16.4",
+    "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.11.0",
+    "@fluid-internal/mocha-test-setup": "~2.12.0",
     "@fluid-tools/build-cli": "^0.51.0",
@@ -92,3 +92,3 @@ "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/eslint-config-fluid": "^5.6.0",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.10.0",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.11.0",
     "@microsoft/api-extractor": "7.47.8",
@@ -95,0 +95,0 @@ "@types/mocha": "^9.1.1",

src/runtimeFactoryHelper.ts

@@ -34,2 +34,7 @@ /*!
 
+	/**
+	 * Called at the start of initializing a container, to create the container runtime instance.
+	 * @param context - The context for the container being initialized
+	 * @param existing - Whether the container already exists and is being loaded (else it's being created new just now)
+	 */
 	public abstract preInitialize(
@@ -39,5 +44,19 @@ context: IContainerContext,
 	): Promise<IRuntime & T>;
+	/**
+	 * Called the one time the container is created, and not on any subsequent load.
+	 * i.e. only when it's initialized on the client that first created it
+	 * @param runtime - The runtime for the container being initialized
+	 */
 	public async instantiateFirstTime(_runtime: T): Promise<void> {}
+	/**
+	 * Called every time the container runtime is loaded for an existing container.
+	 * i.e. every time it's initialized _except_ for when it is first created
+	 * @param runtime - The runtime for the container being initialized
+	 */
 	public async instantiateFromExisting(_runtime: T): Promise<void> {}
+	/**
+	 * Called at the end of initializing a container, after the runtime has been created or loaded.
+	 * @param runtime - The runtime for the container being initialized
+	 */
 	public async hasInitialized(_runtime: T): Promise<void> {}
 }

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

402097

increased by1.61%

Lines of code

4717

increased by1.84%

Dependency changes

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

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

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

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

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

• + Added@fluidframework/datastore-definitions@2.12.0(transitive)

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

• + Added@fluidframework/driver-utils@2.12.0(transitive)

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

• + Added@fluidframework/runtime-definitions@2.12.0(transitive)

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

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

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

• - Removed@fluidframework/container-runtime-definitions@2.11.0(transitive)

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

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

• - Removed@fluidframework/datastore-definitions@2.11.0(transitive)

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

• - Removed@fluidframework/driver-utils@2.11.0(transitive)

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

• - Removed@fluidframework/runtime-definitions@2.11.0(transitive)

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

• Updated@fluid-internal/client-utils@~2.12.0

• Updated@fluidframework/container-definitions@~2.12.0

• Updated@fluidframework/container-runtime-definitions@~2.12.0

• Updated@fluidframework/core-interfaces@~2.12.0

• Updated@fluidframework/core-utils@~2.12.0

• Updated@fluidframework/datastore-definitions@~2.12.0

• Updated@fluidframework/driver-definitions@~2.12.0

• Updated@fluidframework/driver-utils@~2.12.0

• Updated@fluidframework/runtime-definitions@~2.12.0

• Updated@fluidframework/telemetry-utils@~2.12.0