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

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @fluidframework/agent-scheduler
 
+## 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.

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"extends": "@fluidframework/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';
+
+// @public (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";
+}
+
+// @public (undocumented)
+export const IAgentScheduler: keyof IProvideAgentScheduler;
+
+// @public
+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>;
+}
+
+// @public
+export interface IAgentSchedulerEvents extends IEvent {
+    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
+}
+
+// @public (undocumented)
+export interface IProvideAgentScheduler {
+    // (undocumented)
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+// @public
+export interface ITaskSubscriptionEvents extends IEvent {
+    // (undocumented)
+    (event: "gotTask" | "lostTask", listener: () => void): any;
+}
+
+// @public
+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,132 @@
+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';
+
+/**
+ * @public
+ */
+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>;
+}
+
+/**
+ * @public
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
+ */
+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)}.
+ *
+ * @public
+ */
+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;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+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;
+}
+
+/* Excluded from this release type: TypedEventEmitter */
+
+export { }

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

@@ -0,0 +1,132 @@
+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';
+
+/**
+ * @public
+ */
+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>;
+}
+
+/**
+ * @public
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
+ */
+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)}.
+ *
+ * @public
+ */
+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;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+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;
+}
+
+/* Excluded from this release type: TypedEventEmitter */
+
+export { }

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

@@ -0,0 +1,132 @@
+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';
+
+/**
+ * @public
+ */
+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>;
+}
+
+/**
+ * @public
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
+ */
+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)}.
+ *
+ * @public
+ */
+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;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+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;
+}
+
+/* Excluded from this release type: TypedEventEmitter */
+
+export { }

package/dist/agent-scheduler.d.ts

@@ -0,0 +1,131 @@
+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';
+
+/**
+ * @public
+ */
+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>;
+}
+
+/**
+ * @public
+ */
+export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+
+/**
+ * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
+ */
+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)}.
+ *
+ * @public
+ */
+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;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideAgentScheduler {
+    readonly IAgentScheduler: IAgentScheduler;
+}
+
+/**
+ * Events emitted by {@link TaskSubscription}.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+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.d.ts

@@ -3,10 +3,21 @@
  * Licensed under the MIT License.
  */
 import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
+/**
+ * @public
+ */
 export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+/**
+ * @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
@@ -29,6 +40,8 @@ export interface IAgentSchedulerEvents extends IEvent {
 }
 /**
  * Agent scheduler distributes a set of tasks/variables across connected clients.
+ *
+ * @public
  */
 export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
     /**

package/dist/agent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEzF,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,eAChB,SAAQ,sBAAsB,EAC7B,cAAc,CAAC,qBAAqB,CAAC,EACrC,cAAc;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;CACxB"}
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5E;AAED;;;;GAIG;AACH,MAAM,WAAW,eAChB,SAAQ,sBAAsB,EAC7B,cAAc,CAAC,qBAAqB,CAAC,EACrC,cAAc;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;CACxB"}