@fluidframework/task-manager 2.0.0-dev-rc.4.0.0.261659 → 2.0.0-dev-rc.5.0.0.265721

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/task-manager",
-  "version": "2.0.0-dev-rc.4.0.0.261659",
+  "version": "2.0.0-dev-rc.5.0.0.265721",
   "description": "Distributed data structure for queueing exclusive tasks",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -67,30 +67,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.265721",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/shared-object-base": "2.0.0-dev-rc.4.0.0.261659"
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.265721"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-tools/build-cli": "0.38.0-259537",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluid-tools/build-cli": "^0.39.0-264124",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.38.0-259537",
+    "@fluidframework/build-tools": "^0.39.0-264124",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/task-manager-previous": "npm:@fluidframework/task-manager@2.0.0-rc.3.0.0",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@fluidframework/task-manager-previous": "npm:@fluidframework/task-manager@2.0.0-rc.4.0.0",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
@@ -105,10 +105,14 @@
     "prettier": "~3.0.3",
     "replace-in-file": "^6.3.5",
     "rimraf": "^4.4.0",
-    "typescript": "~5.1.6"
+    "typescript": "~5.3.3"
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "RemovedClassDeclaration_TaskManager": {
+        "backCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",

package/src/index.ts

@@ -11,4 +11,4 @@
  */
 
 export { ITaskManager, ITaskManagerEvents, TaskEventListener } from "./interfaces.js";
-export { TaskManager } from "./taskManager.js";
+export { TaskManager } from "./taskManagerFactory.js";

package/src/interfaces.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
+import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base/internal";
 
 /**
  * Describes the event listener format for {@link ITaskManagerEvents} events.
@@ -14,7 +14,7 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec
 export type TaskEventListener = (taskId: string) => void;
 
 /**
- * Events emitted by {@link TaskManager}.
+ * Events emitted by {@link ITaskManager}.
  * @alpha
  */
 export interface ITaskManagerEvents extends ISharedObjectEvents {
@@ -49,7 +49,7 @@ export interface ITaskManagerEvents extends ISharedObjectEvents {
  *
  * @example Creation
  *
- * To create a {@link TaskManager}, call the static create method:
+ * To create a {@link ITaskManager}, call the static create method:
  *
  * ```typescript
  * const taskManager = TaskManager.create(this.runtime, id);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/task-manager";
-export const pkgVersion = "2.0.0-dev-rc.4.0.0.261659";
+export const pkgVersion = "2.0.0-dev-rc.5.0.0.265721";

package/src/taskManager.ts

@@ -4,22 +4,23 @@
  */
 
 import { EventEmitter } from "@fluid-internal/client-utils";
-import { ReadOnlyInfo } from "@fluidframework/container-definitions";
+import { ReadOnlyInfo } from "@fluidframework/container-definitions/internal";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import {
 	IChannelAttributes,
-	IChannelFactory,
-	IChannelStorageService,
 	IFluidDataStoreRuntime,
-} from "@fluidframework/datastore-definitions";
+	IChannelStorageService,
+} from "@fluidframework/datastore-definitions/internal";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
 import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
-import { IFluidSerializer } from "@fluidframework/shared-object-base";
-import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import {
+	IFluidSerializer,
+	SharedObject,
+	createSingleBlobSummary,
+} from "@fluidframework/shared-object-base/internal";
 
 import { ITaskManager, ITaskManagerEvents } from "./interfaces.js";
-import { TaskManagerFactory } from "./taskManagerFactory.js";
 
 /**
  * Description of a task manager operation
@@ -62,27 +63,7 @@ const placeholderClientId = "placeholder";
  * @sealed
  * @alpha
  */
-export class TaskManager extends SharedObject<ITaskManagerEvents> implements ITaskManager {
-	/**
-	 * Create a new TaskManager
-	 *
-	 * @param runtime - data store runtime the new task queue belongs to
-	 * @param id - optional name of the task queue
-	 * @returns newly create task queue (but not attached yet)
-	 */
-	public static create(runtime: IFluidDataStoreRuntime, id?: string) {
-		return runtime.createChannel(id, TaskManagerFactory.Type) as TaskManager;
-	}
-
-	/**
-	 * Get a factory for TaskManager to register with the data store.
-	 *
-	 * @returns a factory that creates and load TaskManager
-	 */
-	public static getFactory(): IChannelFactory {
-		return new TaskManagerFactory();
-	}
-
+export class TaskManagerClass extends SharedObject<ITaskManagerEvents> implements ITaskManager {
 	/**
 	 * Mapping of taskId to a queue of clientIds that are waiting on the task.  Maintains the consensus state of the
 	 * queue, even if we know we've submitted an op that should eventually modify the queue.
@@ -127,7 +108,7 @@ export class TaskManager extends SharedObject<ITaskManagerEvents> implements ITa
 	 * Returns a ReadOnlyInfo object to determine current read/write permissions.
 	 */
 	private get readOnlyInfo(): ReadOnlyInfo {
-		return this.runtime.deltaManager.readOnlyInfo;
+		return this.deltaManager.readOnlyInfo;
 	}
 
 	/**

package/src/taskManagerFactory.ts

@@ -6,18 +6,19 @@
 import {
 	IChannelAttributes,
 	IChannelFactory,
-	IChannelServices,
 	IFluidDataStoreRuntime,
-} from "@fluidframework/datastore-definitions";
+	IChannelServices,
+} from "@fluidframework/datastore-definitions/internal";
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { ITaskManager } from "./interfaces.js";
 import { pkgVersion } from "./packageVersion.js";
-import { TaskManager } from "./taskManager.js";
+import { TaskManagerClass } from "./taskManager.js";
 
 /**
  * The factory that defines the task queue
  */
-export class TaskManagerFactory implements IChannelFactory {
+export class TaskManagerFactory implements IChannelFactory<ITaskManager> {
 	public static readonly Type = "https://graph.microsoft.com/types/task-manager";
 
 	public static readonly Attributes: IChannelAttributes = {
@@ -43,14 +44,26 @@ export class TaskManagerFactory implements IChannelFactory {
 		services: IChannelServices,
 		attributes: IChannelAttributes,
 	): Promise<ITaskManager> {
-		const taskQueue = new TaskManager(id, runtime, attributes);
+		const taskQueue = new TaskManagerClass(id, runtime, attributes);
 		await taskQueue.load(services);
 		return taskQueue;
 	}
 
 	public create(document: IFluidDataStoreRuntime, id: string): ITaskManager {
-		const taskQueue = new TaskManager(id, document, this.attributes);
+		const taskQueue = new TaskManagerClass(id, document, this.attributes);
 		taskQueue.initializeLocal();
 		return taskQueue;
 	}
 }
+
+/**
+ * {@inheritDoc ITaskManager}
+ * @alpha
+ */
+export const TaskManager = createSharedObjectKind(TaskManagerFactory);
+
+/**
+ * {@inheritDoc ITaskManager}
+ * @alpha
+ */
+export type TaskManager = ITaskManager;