@fluidframework/task-manager 2.0.0-dev-rc.3.0.0.254866 → 2.0.0-dev-rc.5.0.0.263932

package/lib/taskManagerFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"taskManagerFactory.js","sourceRoot":"","sources":["../src/taskManagerFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAS9B,IAAW,IAAI;QACd,OAAO,kBAAkB,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,SAAS,GAAG,IAAI,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC3D,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACzD,MAAM,SAAS,GAAG,IAAI,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,SAAS,CAAC,eAAe,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IAClB,CAAC;;AAlCsB,uBAAI,GAAG,gDAAgD,CAAC;AAExD,6BAAU,GAAuB;IACvD,IAAI,EAAE,kBAAkB,CAAC,IAAI;IAC7B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\n\nimport { ITaskManager } from \"./interfaces.js\";\nimport { pkgVersion } from \"./packageVersion.js\";\nimport { TaskManager } from \"./taskManager.js\";\n\n/**\n * The factory that defines the task queue\n */\nexport class TaskManagerFactory implements IChannelFactory {\n\tpublic static readonly Type = \"https://graph.microsoft.com/types/task-manager\";\n\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: TaskManagerFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\tpublic get type() {\n\t\treturn TaskManagerFactory.Type;\n\t}\n\n\tpublic get attributes() {\n\t\treturn TaskManagerFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ITaskManager> {\n\t\tconst taskQueue = new TaskManager(id, runtime, attributes);\n\t\tawait taskQueue.load(services);\n\t\treturn taskQueue;\n\t}\n\n\tpublic create(document: IFluidDataStoreRuntime, id: string): ITaskManager {\n\t\tconst taskQueue = new TaskManager(id, document, this.attributes);\n\t\ttaskQueue.initializeLocal();\n\t\treturn taskQueue;\n\t}\n}\n"]}
+{"version":3,"file":"taskManagerFactory.js","sourceRoot":"","sources":["../src/taskManagerFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AAGrF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAS9B,IAAW,IAAI;QACd,OAAO,kBAAkB,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAChE,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACzD,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACtE,SAAS,CAAC,eAAe,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IAClB,CAAC;;AAlCsB,uBAAI,GAAG,gDAAgD,CAAC;AAExD,6BAAU,GAAuB;IACvD,IAAI,EAAE,kBAAkB,CAAC,IAAI;IAC7B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC1B,CAAC;AA+BH;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,sBAAsB,CAAC,kBAAkB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { createSharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { ITaskManager } from \"./interfaces.js\";\nimport { pkgVersion } from \"./packageVersion.js\";\nimport { TaskManagerClass } from \"./taskManager.js\";\n\n/**\n * The factory that defines the task queue\n */\nexport class TaskManagerFactory implements IChannelFactory<ITaskManager> {\n\tpublic static readonly Type = \"https://graph.microsoft.com/types/task-manager\";\n\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: TaskManagerFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\tpublic get type() {\n\t\treturn TaskManagerFactory.Type;\n\t}\n\n\tpublic get attributes() {\n\t\treturn TaskManagerFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ITaskManager> {\n\t\tconst taskQueue = new TaskManagerClass(id, runtime, attributes);\n\t\tawait taskQueue.load(services);\n\t\treturn taskQueue;\n\t}\n\n\tpublic create(document: IFluidDataStoreRuntime, id: string): ITaskManager {\n\t\tconst taskQueue = new TaskManagerClass(id, document, this.attributes);\n\t\ttaskQueue.initializeLocal();\n\t\treturn taskQueue;\n\t}\n}\n\n/**\n * {@inheritDoc ITaskManager}\n * @alpha\n */\nexport const TaskManager = createSharedObjectKind(TaskManagerFactory);\n\n/**\n * {@inheritDoc ITaskManager}\n * @alpha\n */\nexport type TaskManager = ITaskManager;\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.43.1"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/task-manager",
-  "version": "2.0.0-dev-rc.3.0.0.254866",
+  "version": "2.0.0-dev-rc.5.0.0.263932",
   "description": "Distributed data structure for queueing exclusive tasks",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -23,6 +23,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./legacy": {
+      "import": {
+        "types": "./lib/legacy.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/legacy.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
     "./internal": {
       "import": {
         "types": "./lib/index.d.ts",
@@ -34,8 +44,8 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "./dist/public.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -57,30 +67,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.263932",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/shared-object-base": "2.0.0-dev-rc.3.0.0.254866"
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.263932"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluid-tools/build-cli": "^0.35.0",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-tools/build-cli": "^0.38.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.35.0",
+    "@fluidframework/build-tools": "^0.38.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/task-manager-previous": "npm:@fluidframework/task-manager@2.0.0-internal.8.0.0",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@fluidframework/task-manager-previous": "npm:@fluidframework/task-manager@2.0.0-rc.3.0.0",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
@@ -100,14 +110,22 @@
   "typeValidation": {
     "broken": {
       "ClassDeclaration_TaskManager": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_ITaskManager": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedClassDeclaration_TaskManager": {
+        "forwardCompat": false,
         "backCompat": false
       }
     }
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
@@ -117,11 +135,11 @@
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:are-the-types-wrong": "attw --pack .",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "fluid-build --task format .",
@@ -135,7 +153,7 @@
     "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
-    "typetests:gen": "fluid-type-test-generator",
+    "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }

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

@@ -9,13 +9,13 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec
  * Describes the event listener format for {@link ITaskManagerEvents} events.
  *
  * @param taskId - The unique identifier of the related task.
- * @internal
+ * @alpha
  */
 export type TaskEventListener = (taskId: string) => void;
 
 /**
- * Events emitted by {@link TaskManager}.
- * @internal
+ * 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);
@@ -133,7 +133,7 @@ export interface ITaskManagerEvents extends ISharedObjectEvents {
  * when using {@link ITaskManager.subscribeToTask}.
  *
  * See {@link ITaskManagerEvents} for more details.
- * @internal
+ * @alpha
  */
 export interface ITaskManager extends ISharedObject<ITaskManagerEvents> {
 	/**

package/src/packageVersion.ts

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

package/src/taskManager.ts

@@ -4,11 +4,10 @@
  */
 
 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";
@@ -19,7 +18,6 @@ import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { 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
@@ -60,29 +58,9 @@ const placeholderClientId = "placeholder";
  * {@inheritDoc ITaskManager}
  *
  * @sealed
- * @internal
+ * @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 +105,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

@@ -9,15 +9,16 @@ import {
 	IChannelServices,
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
+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;