@fluidframework/agent-scheduler 2.0.0-internal.7.0.0 → 2.0.0-internal.7.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/agent-scheduler",
-  "version": "2.0.0-internal.7.0.0",
+  "version": "2.0.0-internal.7.1.0",
   "description": "Built in runtime object for distributing agents across instances of a container",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,30 +15,30 @@
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/datastore": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/map": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/register-collection": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.0.0 <2.0.0-internal.7.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/datastore": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/map": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/register-collection": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.24.0",
-    "@fluidframework/agent-scheduler-previous": "npm:@fluidframework/agent-scheduler@2.0.0-internal.6.3.0",
-    "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.24.0",
-    "@fluidframework/eslint-config-fluid": "^2.1.0",
+    "@fluid-tools/build-cli": "^0.25.0",
+    "@fluidframework/agent-scheduler-previous": "npm:@fluidframework/agent-scheduler@2.0.0-internal.7.0.0",
+    "@fluidframework/build-common": "^2.0.1",
+    "@fluidframework/build-tools": "^0.25.0",
+    "@fluidframework/eslint-config-fluid": "^3.0.0",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/node": "^16.18.38",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
+    "eslint": "~8.50.0",
+    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
@@ -58,10 +58,10 @@
   "scripts": {
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
     "dev": "npm run build:dev -- --watch",
     "eslint": "eslint --format stylish src",

package/src/agent.ts

@@ -5,12 +5,23 @@
 
 import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
 
+/**
+ * @public
+ */
 export const IAgentScheduler: keyof IProvideAgentScheduler = "IAgentScheduler";
 
+/**
+ * @public
+ */
 export interface IProvideAgentScheduler {
 	readonly IAgentScheduler: IAgentScheduler;
 }
 
+/**
+ * Events emitted by {@link (IAgentScheduler:interface)}.
+ *
+ * @public
+ */
 export interface IAgentSchedulerEvents extends IEvent {
 	/**
 	 * Event when ownership of task changes
@@ -34,6 +45,8 @@ export interface IAgentSchedulerEvents extends IEvent {
 
 /**
  * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
  */
 export interface IAgentScheduler
 	extends IProvideAgentScheduler,

package/src/scheduler.ts

@@ -454,6 +454,9 @@ class AgentSchedulerRuntime extends FluidDataStoreRuntime {
 	}
 }
 
+/**
+ * @public
+ */
 export class AgentSchedulerFactory implements IFluidDataStoreFactory {
 	public static readonly type = "_scheduler";
 	public readonly type = AgentSchedulerFactory.type;

package/src/taskSubscription.ts

@@ -7,12 +7,19 @@ import { IEvent } from "@fluidframework/core-interfaces";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IAgentScheduler } from "./agent";
 
+/**
+ * Events emitted by {@link TaskSubscription}.
+ *
+ * @public
+ */
 export interface ITaskSubscriptionEvents extends IEvent {
 	(event: "gotTask" | "lostTask", listener: () => void);
 }
 
 /**
  * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
+ *
+ * @public
  */
 export class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
 	private subscribed: boolean = false;
@@ -21,7 +28,10 @@ export class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents>
 	 * @param agentScheduler - The AgentScheduler that will be subscribed against
 	 * @param taskId - The string ID of the task to subscribe against
 	 */
-	constructor(private readonly agentScheduler: IAgentScheduler, public readonly taskId: string) {
+	constructor(
+		private readonly agentScheduler: IAgentScheduler,
+		public readonly taskId: string,
+	) {
 		super();
 		agentScheduler.on("picked", (_taskId: string) => {
 			if (_taskId === this.taskId) {