@fluidframework/agent-scheduler 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/.eslintrc.js

@@ -4,13 +4,11 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
-    ],
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-    "rules": {
-        "@typescript-eslint/strict-boolean-expressions": "off",
-    }
-}
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	rules: {
+		"@typescript-eslint/strict-boolean-expressions": "off",
+	},
+};

package/CHANGELOG.md

@@ -0,0 +1,124 @@
+# @fluidframework/agent-scheduler
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
+
+    -   `BaseContainerRuntimeFactory`
+    -   `RuntimeFactory`
+    -   `ContainerRuntime` (constructor and `loadRuntime`)
+    -   `FluidDataStoreRuntime`
+
+    See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
+    See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
+
+    Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
+
+    For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+### Minor Changes
+
+-   Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
+
+    The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
+    imported from the **@fluidframework/core-interfaces** package:
+
+    -   interface IDisposable
+    -   interface IErrorEvent
+    -   interface IErrorEvent
+    -   interface IEvent
+    -   interface IEventProvider
+    -   interface ILoggingError
+    -   interface ITaggedTelemetryPropertyType
+    -   interface ITelemetryBaseEvent
+    -   interface ITelemetryBaseLogger
+    -   interface ITelemetryErrorEvent
+    -   interface ITelemetryGenericEvent
+    -   interface ITelemetryLogger
+    -   interface ITelemetryPerformanceEvent
+    -   interface ITelemetryProperties
+    -   type ExtendEventProvider
+    -   type IEventThisPlaceHolder
+    -   type IEventTransformer
+    -   type ReplaceIEventThisPlaceHolder
+    -   type ReplaceIEventThisPlaceHolder
+    -   type TelemetryEventCategory
+    -   type TelemetryEventPropertyType
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/README.md

@@ -1,12 +1,33 @@
 # @fluidframework/agent-scheduler
 
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## AgentScheduler
 
 The `AgentScheduler` is a data object that can be used to assign tasks to unique clients.
 
 ### Creation
 
-To create an `AgentScheduler` as a child instance of your data object, add the factory to your registry and call the static `createChildInstance` function on the factory.  You can then retrieve and store its handle to access it later:
+To create an `AgentScheduler` as a child instance of your data object, add the factory to your registry and call the static `createChildInstance` function on the factory. You can then retrieve and store its handle to access it later:
 
 ```typescript
 // In your Data Object
@@ -22,9 +43,24 @@ export const MyDataObjectFactory = new DataObjectFactory(
     [],
     {},
     new Map([
-        AgentSchedulerFactory.registryEntry,
+      AgentSchedulerFactory.registryEntry,
     ]),
 );
 ```
 
-See [GitHub](https://github.com/microsoft/FluidFramework) for more details on the Fluid Framework and packages within.
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
+}

package/api-report/agent-scheduler.api.md

@@ -0,0 +1,71 @@
+## API Report File for "@fluidframework/agent-scheduler"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+// @alpha (undocumented)
+export class AgentSchedulerFactory implements IFluidDataStoreFactory {
+    // (undocumented)
+    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
+    // (undocumented)
+    get IFluidDataStoreFactory(): this;
+    // (undocumented)
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+    // (undocumented)
+    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
+    // (undocumented)
+    static readonly type = "_scheduler";
+    // (undocumented)
+    readonly type = "_scheduler";
+}
+
+// @alpha (undocumented)
+export const IAgentScheduler: keyof IProvideAgentScheduler;
+
+// @alpha
+export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
+    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
+    pickedTasks(): string[];
+    register(...taskUrls: string[]): Promise<void>;
+    release(...taskUrls: string[]): Promise<void>;
+}
+
+// @alpha
+export interface IAgentSchedulerEvents extends IEvent {
+    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
+}
+
+// @alpha (undocumented)
+export interface IProvideAgentScheduler {
+    // (undocumented)
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+// @alpha
+export interface ITaskSubscriptionEvents extends IEvent {
+    // (undocumented)
+    (event: "gotTask" | "lostTask", listener: () => void): any;
+}
+
+// @alpha
+export class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
+    constructor(agentScheduler: IAgentScheduler, taskId: string);
+    haveTask(): boolean;
+    // (undocumented)
+    readonly taskId: string;
+    volunteer(): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/agent-scheduler-alpha.d.ts

@@ -0,0 +1,127 @@
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/**
+ * @alpha
+ */
+export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
+    static readonly type = "_scheduler";
+    readonly type = "_scheduler";
+    get IFluidDataStoreFactory(): this;
+    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
+    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+}
+
+/**
+ * @alpha
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ * @alpha
+ */
+export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
+    /**
+     * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants
+     * a new agent to run but does not have the capability to run the agent inside the host.
+     * Client can call pick() later if the capability changes.
+     *
+     * This method should only be called once per task. Duplicate calls will be rejected.
+     */
+    register(...taskUrls: string[]): Promise<void>;
+    /**
+     * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.
+     * Resolves when the tasks are assigned to one of the connected clients.
+     *
+     * This method should only be called once per task. Duplicate calls will be rejected.
+     *
+     * @param worker - callback to run when task is picked up.
+     */
+    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
+    /**
+     * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.
+     *
+     * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.
+     * App can call pickedTasks() to get the picked list first.
+     */
+    release(...taskUrls: string[]): Promise<void>;
+    /**
+     * Returns a list of all tasks running on this client
+     */
+    pickedTasks(): string[];
+}
+
+/**
+ * Events emitted by {@link (IAgentScheduler:interface)}.
+ * @alpha
+ */
+export declare interface IAgentSchedulerEvents extends IEvent {
+    /**
+     * Event when ownership of task changes
+     * @param event - name of the event:
+     *
+     * - "picked" - the task has been assigned to this client, in response to pick() being called
+     * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)
+     * automatically, unless release() is called
+     *
+     * - "released" - the task was successfully released back to the pool. Client will not attempt to
+     * re-acquire the task, unless pick() is called.
+     *
+     * - "lost" - task is lost due to disconnect or data store / container being attached.
+     * Task will be picked up again by some connected client (this client will try as well,
+     * unless release() is called)
+     *
+     * @param listener - callback notified when change happened for particular key
+     */
+    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ * @alpha
+ */
+export declare interface ITaskSubscriptionEvents extends IEvent {
+    (event: "gotTask" | "lostTask", listener: () => void): any;
+}
+
+/**
+ * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
+ * @alpha
+ */
+export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
+    private readonly agentScheduler;
+    readonly taskId: string;
+    private subscribed;
+    /**
+     * @param agentScheduler - The AgentScheduler that will be subscribed against
+     * @param taskId - The string ID of the task to subscribe against
+     */
+    constructor(agentScheduler: IAgentScheduler, taskId: string);
+    /**
+     * Check if currently holding ownership of the task.
+     * @returns true if currently the task owner, false otherwise.
+     */
+    haveTask(): boolean;
+    /**
+     * Volunteer for the task.  By default, the TaskSubscription will only watch the task and not volunteer.
+     * This is safe to call multiple times across multiple TaskSubscriptions.
+     */
+    volunteer(): void;
+}
+
+export { }

package/dist/agent-scheduler-beta.d.ts

@@ -0,0 +1,30 @@
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/* Excluded from this release type: AgentSchedulerFactory */
+
+/* Excluded from this release type: FluidDataStoreRuntime */
+
+/* Excluded from this release type: IAgentScheduler */
+
+/* Excluded from this release type: IAgentSchedulerEvents */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IProvideAgentScheduler */
+
+/* Excluded from this release type: ITaskSubscriptionEvents */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: TaskSubscription */
+
+export { }

package/dist/agent-scheduler-public.d.ts

@@ -0,0 +1,30 @@
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/* Excluded from this release type: AgentSchedulerFactory */
+
+/* Excluded from this release type: FluidDataStoreRuntime */
+
+/* Excluded from this release type: IAgentScheduler */
+
+/* Excluded from this release type: IAgentSchedulerEvents */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IProvideAgentScheduler */
+
+/* Excluded from this release type: ITaskSubscriptionEvents */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: TaskSubscription */
+
+export { }

package/dist/agent-scheduler-untrimmed.d.ts

@@ -0,0 +1,127 @@
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/**
+ * @alpha
+ */
+export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
+    static readonly type = "_scheduler";
+    readonly type = "_scheduler";
+    get IFluidDataStoreFactory(): this;
+    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
+    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+}
+
+/**
+ * @alpha
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ * @alpha
+ */
+export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
+    /**
+     * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants
+     * a new agent to run but does not have the capability to run the agent inside the host.
+     * Client can call pick() later if the capability changes.
+     *
+     * This method should only be called once per task. Duplicate calls will be rejected.
+     */
+    register(...taskUrls: string[]): Promise<void>;
+    /**
+     * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.
+     * Resolves when the tasks are assigned to one of the connected clients.
+     *
+     * This method should only be called once per task. Duplicate calls will be rejected.
+     *
+     * @param worker - callback to run when task is picked up.
+     */
+    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
+    /**
+     * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.
+     *
+     * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.
+     * App can call pickedTasks() to get the picked list first.
+     */
+    release(...taskUrls: string[]): Promise<void>;
+    /**
+     * Returns a list of all tasks running on this client
+     */
+    pickedTasks(): string[];
+}
+
+/**
+ * Events emitted by {@link (IAgentScheduler:interface)}.
+ * @alpha
+ */
+export declare interface IAgentSchedulerEvents extends IEvent {
+    /**
+     * Event when ownership of task changes
+     * @param event - name of the event:
+     *
+     * - "picked" - the task has been assigned to this client, in response to pick() being called
+     * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)
+     * automatically, unless release() is called
+     *
+     * - "released" - the task was successfully released back to the pool. Client will not attempt to
+     * re-acquire the task, unless pick() is called.
+     *
+     * - "lost" - task is lost due to disconnect or data store / container being attached.
+     * Task will be picked up again by some connected client (this client will try as well,
+     * unless release() is called)
+     *
+     * @param listener - callback notified when change happened for particular key
+     */
+    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ * @alpha
+ */
+export declare interface ITaskSubscriptionEvents extends IEvent {
+    (event: "gotTask" | "lostTask", listener: () => void): any;
+}
+
+/**
+ * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
+ * @alpha
+ */
+export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
+    private readonly agentScheduler;
+    readonly taskId: string;
+    private subscribed;
+    /**
+     * @param agentScheduler - The AgentScheduler that will be subscribed against
+     * @param taskId - The string ID of the task to subscribe against
+     */
+    constructor(agentScheduler: IAgentScheduler, taskId: string);
+    /**
+     * Check if currently holding ownership of the task.
+     * @returns true if currently the task owner, false otherwise.
+     */
+    haveTask(): boolean;
+    /**
+     * Volunteer for the task.  By default, the TaskSubscription will only watch the task and not volunteer.
+     * This is safe to call multiple times across multiple TaskSubscriptions.
+     */
+    volunteer(): void;
+}
+
+export { }

package/dist/{agent.js → agent.cjs}

@@ -5,5 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IAgentScheduler = void 0;
+/**
+ * @alpha
+ */
 exports.IAgentScheduler = "IAgentScheduler";
-//# sourceMappingURL=agent.js.map
+//# sourceMappingURL=agent.cjs.map

package/dist/agent.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.cjs","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider, IFluidLoadable } from \"@fluidframework/core-interfaces\";\n\n/**\n * @alpha\n */\nexport const IAgentScheduler: keyof IProvideAgentScheduler = \"IAgentScheduler\";\n\n/**\n * @alpha\n */\nexport interface IProvideAgentScheduler {\n\treadonly IAgentScheduler: IAgentScheduler;\n}\n\n/**\n * Events emitted by {@link (IAgentScheduler:interface)}.\n * @alpha\n */\nexport interface IAgentSchedulerEvents extends IEvent {\n\t/**\n\t * Event when ownership of task changes\n\t * @param event - name of the event:\n\t *\n\t * - \"picked\" - the task has been assigned to this client, in response to pick() being called\n\t * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)\n\t * automatically, unless release() is called\n\t *\n\t * - \"released\" - the task was successfully released back to the pool. Client will not attempt to\n\t * re-acquire the task, unless pick() is called.\n\t *\n\t * - \"lost\" - task is lost due to disconnect or data store / container being attached.\n\t * Task will be picked up again by some connected client (this client will try as well,\n\t * unless release() is called)\n\t *\n\t * @param listener - callback notified when change happened for particular key\n\t */\n\t(event: \"picked\" | \"released\" | \"lost\", listener: (taskId: string) => void);\n}\n\n/**\n * Agent scheduler distributes a set of tasks/variables across connected clients.\n * @alpha\n */\nexport interface IAgentScheduler\n\textends IProvideAgentScheduler,\n\t\tIEventProvider<IAgentSchedulerEvents>,\n\t\tIFluidLoadable {\n\t/**\n\t * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants\n\t * a new agent to run but does not have the capability to run the agent inside the host.\n\t * Client can call pick() later if the capability changes.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t */\n\tregister(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.\n\t * Resolves when the tasks are assigned to one of the connected clients.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t *\n\t * @param worker - callback to run when task is picked up.\n\t */\n\tpick(taskId: string, worker: () => Promise<void>): Promise<void>;\n\n\t/**\n\t * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.\n\t *\n\t * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.\n\t * App can call pickedTasks() to get the picked list first.\n\t */\n\trelease(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Returns a list of all tasks running on this client\n\t */\n\tpickedTasks(): string[];\n}\n"]}